Skip to main content

Convert CloudFormation templates to draw.io compatible diagrams, with dependency arrows

Project description

cloudgaze-cli

Documentation Status

Documentation can be found at https://cloudgaze.readthedocs.io/en/latest/


CLI (command line interface) to call the Cloudgaze API to transform your AWS cloudformation template specifications to draw.io compatible xml files.

This command line application makes a network call in the background to convert the template file. No data is stored on the remote endpoint, and you need to be connected to the internet to use this tool. The communication is encrypted using TLS.

Install

pip install cloudgaze-cli

Usage

$ cloudgaze --help
Usage: cloudgaze [OPTIONS] TEMPLATE_FILE OUTPUT_FILE

Options:
  --help  Show this message and exit.
$ cloudgaze ./path/to/template.yml ./path/to/output.xml
results written to '/abs/path/to/output.xml'

Examples

For example, the analytics template file for the AWS realworld serverless application example will render the following diagram in draw.io:

Example of analytics template output

To see the diagram in the above form, the output from cloudgaze have to be opened in draw.io or a compatible application. The diagram can then be modified in the application.

The resources will be connected with arrows to indicate a dependency.

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

cloudgaze-cli-1.0.1.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

cloudgaze_cli-1.0.1-py3-none-any.whl (3.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