Skip to main content

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 -r us-east-2
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 -r us-east-2
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:

Organizations Diagram

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 -r us-east-2

Identity and Access Manager Center (SSO)

reverse_diagrams -c aws -p my-profile -i -r us-east-2

Additional Commands

Combine the options

reverse_diagrams -c aws -p my-profile -o -i -r us-east-2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reverse_diagrams-0.2.3.tar.gz (201.7 kB view hashes)

Uploaded Source

Built Distribution

reverse_diagrams-0.2.3-py3-none-any.whl (16.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page