Skip to content

mubarak-j/aws-cudos-framework-deployment

 
 

Repository files navigation

Cloud Intelligence Dashboards (CUDOS Framework)

PyPI version

Welcome to Cloud Intelligence Dashboards (CUDOS Framework) automation repository

This repository contains CloudFormation templates and Command Line tool (cid-cmd) for managing various dashboards provided in AWS Well Architected LAB Cloud Intelligence Dashboards.

There are several ways we can manage dashboards:

  1. Manual (2 hours)
  2. CloudFormation Template (30 mins)
  3. (recommended) Using cid-cmd tool. (5 mins)

We recommend cid-cmd tool via AWS CloudShell.

Supported dashboards


Dashboard documentation Demo URL Prerequisites URL
CUDOS Dashboard demo link
Cost Intelligence Dashboard demo link
Trusted Advisor Organisation (TAO) Dashboard demo link
Trends Dashboard demo link
KPI Dashboard demo link
Compute Optimizer Dashboard demo link

Before you start

  1. ❗ Complete the prerequisites for respective dashboard (see above).
  2. Specifying a Query Result Location Using a Workgroup
  3. ❗ Make sure QuickSight Enterprise edition is activated.

How to use

  1. Launch AWS CloudShell or your local shell

    Automation requires Python 3

  2. Make sure you have latest pip package installed

    python3 -m ensurepip --upgrade
  3. Install CID Python automation PyPI package

    pip3 install --upgrade cid-cmd
  4. Deploy the Dashboards

    cid-cmd deploy

Optional Commands

  1. Update existing Dashboards

    cid-cmd update
  2. See available commands and command line options

    cid-cmd --help
    

Usage Demo

asciicast

Troubleshooting

If you experience unexpected behaviour of the cid-cmd script please run cid-cmd in debug mode

cid-cmd -vv [command]

This will produce a log file in the same directory that were at the tile of launch of cid-cmd.

❗Inspect the produced debug log for any sensitive information and anonymise it.

We encourage you to open new issue with description of the problem and attached debug log file.

About

Command Line Interface tool for Cloud Intelligence Dashboards deployment

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 89.8%
  • Shell 10.2%