Cloud Intelligence Dashboards deployment helper tool
Project description
Cloud Intelligence Dashboards (CUDOS Framework)
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:
- CloudFormation Template (using cid-cmd tool in lambda)
- Using cid-cmd tool from command line
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
- :heavy_exclamation_mark: Complete the prerequisites for respective dashboard (see above).
- :heavy_exclamation_mark: Specifying a Query Result Location Using a Workgroup
- :heavy_exclamation_mark: Make sure QuickSight Enterprise edition is activated.
How to use for Dasbhoard Deployment
-
Launch AWS CloudShell or your local shell
Automation requires Python 3
-
Make sure you have latest pip package installed
python3 -m ensurepip --upgrade
-
Install CID Python automation PyPI package
pip3 install --upgrade cid-cmd
-
Deploy the Dashboards
cid-cmd deploy
Demo
Other Commands
Update existing Dashboards
Update only Dashboard
cid-cmd update
Update dashboard and all dependenies (Datasets and Athena View). WARNING: this will overide any customization of SQL files and Datasets.
cid-cmd update --force --recursive
Show Dashboard status
Show dashboards status
cid-cmd status
Share QuickSight resources
cid-cmd share
Delete Dashboard and all dependencies unused by other
Delete Dashboards and all dependencies unused by other CID-managed dashboards.(including QuickSight datasets, Athena views and tables)
cid-cmd delete
Delete Command Options:
--dashboard-id TEXT QuickSight dashboard id
--athena-database TEXT Athena database
Export
The command export
lets you download or share a customized dashboard with another AWS Account. It takes the QuickSight Analysis as an input and generates all the assets needed to deploy your Analysis into another AWS Account. This command will generate a yaml file with a description of the Dashboard and all required Datasets. Also this command generates a QuickSight Template in the current AWS Account that can be used for Dashboard deployment in other accounts. The resource file can be used with all other cid commands. Both accounts must have relevant Athena Views and Tables.
Export from account A:
cid-cmd export
Deployment to account B:
cid-cmd deploy --resources ./mydashboard.yaml
See available commands and command line options
cid-cmd --help
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.
:heavy_exclamation_mark: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.
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 cid_cmd-0.2.12-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8441bbab8c7a653b91208f9437a8d685c89eadd4e5d1695fe2a2977a9ab7696a |
|
MD5 | cefefc7a306a3a45db1040c045769706 |
|
BLAKE2b-256 | 8b24ec76ef9879a89eb605c233266f6d546751c9f2a7e78d680259e56adc78c9 |