Continuous Documentation Tool - Documentation as Code Tool - This package create reverse diagrams based on your current state in your cloud environment
Project description
Table of Contents
Reverse Diagrams
Continuous Documentation Tool - Documentation as Code Tool
This package create reverse diagrams based on your current state in your cloud environment.
Install
pip install reverse-diagrams
Use
The following are the available options
$ reverse_diagrams -h
usage: reverse_diagrams [-h] [-c CLOUD] [-p PROFILE] [-o] [-i] [-v]
options:
-h, --help show this help message and exit
-c CLOUD, --cloud CLOUD
Cloud Provider, aws, gcp, azure
-p PROFILE, --profile PROFILE
AWS cli profile for Access Analyzer Api
-o, --graph_organization
Set if you want to create graph for your organization
-i, --graph_identity Set if you want to create graph for your IAM Center
-v, --version Show version
For example:
reverse_diagrams -c aws -p my-profile -o
Date: 2022-12-17 22:33:21.791819
🔄 Getting Organization Info
🔄 The Organizational Units list
🔄 Getting the Account list info
Run -> python3 graph_org.py
Then run python3 graph_org.py
to create a png screenshot (organizations-state.png
) for your current state.
Both files are saved into the current directory.
$ reverse_diagrams -c aws -p labvel-master -o
Date: 2022-12-17 22:44:07.623260
🔄 Getting Organization Info
🔄 The Organizational Units list
🔄 Getting the Account list info
Run -> python3 graph_org.py
$ python3 graph_org.py
$ ls
graph_org.py
organizations-state.png
For example:
Now you can edit graph_org.py
file or add to your repositories for keeping the documentation update.
Cloud Providers
AWS
Requirement
AWS programmatic access using AWS CLI. :arrow_right: Configuring the AWS CLI
Service supported
AWS Organizations
reverse_diagrams -c aws -p my-profile -o
Identity and Access Manager Center (SSO)
reverse_diagrams -c aws -p my-profile -i
Additional Commands
Combine the options
reverse_diagrams -c aws -p my-profile -o -i
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for reverse_diagrams-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a41d6c41708d3a457fcdcb8ef8c061d491fe5a5d8c38318e3fc6bb8ccbd3653 |
|
MD5 | 4e75e9fc4baa1a6919f0437220ed8cf1 |
|
BLAKE2b-256 | 4d6ecc03530532f3291f113a1e7cd0fc39759e12a3e6987a099250d3b3b66259 |