Package: cid-cmd
Cloud Intelligence Dashboards (CUDOS Framework)Welcome to Cloud Intelligence Dashboards (CUDOS Framework) automation repositoryThis repository contains CloudFormation templates, Terraform modules, and a Command Line tool (cid-cmd) for managing various dashboards provided in AWS Well Architected LABCloud Intelligence Dashboards.There are several ways we can manage dashboards:CloudFormation Template(using cid-cmd tool in lambda)Terraform module(wrapper around CloudFormation Template)Using cid-cmd tool from command lineWe recommend cid-cmd tool viaAWS CloudShell.Supported dashboardsDashboard documentationDemo URLPrerequisites URLCUDOS DashboarddemolinkCost Intelligence DashboarddemolinkTrusted Advisor Organisation (TAO) DashboarddemolinkTrends DashboarddemolinkKPI DashboarddemolinkCompute Optimizer DashboarddemolinkCost Anomaly DashboarddemolinkData Transfer Cost DashboarddemolinkSee more dashboards on theworkshop page.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 QuickSightEnterprise editionis activated.Command line tool cid-cmdDemo: Deployment of Dashboards with cid-cmd toolInstallLaunchAWS CloudShellor your local shellAutomation requires Python 3Make sure you have latest pip package installedpython3-mensurepip--upgradeInstall CID Python automation PyPI packagepip3install--upgradecid-cmdDasbhoard Deploymentcid-cmddeployUpdate existing DashboardsUpdate only Dashboardcid-cmdupdateUpdate dashboard and all dependenies (Datasets and Athena View). WARNING: this will overide any customization of SQL files and Datasets.cid-cmdupdate--force--recursiveShow Dashboard statusShow dashboards statuscid-cmdstatusShare QuickSight resourcescid-cmdshareInitialize Amazon QuickSightOne time action to intialize Amazon QuickSight Enerprise Edition.cid-cmdinitqsDelete Dashboard and all dependencies unused by otherDelete Dashboards and all dependencies unused by other CID-managed dashboards.(including QuickSight datasets, Athena views and tables)cid-cmddeleteDelete Command Options:--dashboard-id TEXT QuickSight dashboard id 
 --athena-database TEXT Athena databaseExportThe commandexportlets 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 exportDeployment to account B:cid-cmd deploy --resources ./mydashboard.yamlSee available commands and command line optionscid-cmd --helpCSV to Athena ViewGenerate and SQL file for Athena View for CSV filecid-cmd csv2view --input my_mapping.csv --name my_mappingThis command generates a SQL file that you can execute. Please mindAthena Service Limit for Query Size.Cloud FormationCID is also provided in a form of CloudFormation telmplates. See detailed instuctions in theWell Architected Labssite.TerraformCID offers a set of Terraform modules to deploy CUR replicaion and CID dashboards. These modules act as a wrapper around CloudFormation.Create a bucket for consolidating CURterraform-modules/cur-setup-destination/Create a CUR in Payer Account(s)terraform-modules/cur-setup-source/Create Dashboardsterraform-modules/cid-dashboards/Rights ManagementThe ownership of CID is usually with the FinOps team, who do not have administrative access. However, they require specific privileges to install and operate CID dashboards. To assist the Admin team in granting the necessary privileges to the CID owners, a CFN template is provided. This template, located atCFN template, takes an IAM role name as a parameter and adds the required policies to the role.Troubleshooting and SupportIf you experience unexpected behaviour of thecid-cmdscript please runcid-cmdin 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 anonymize it.We encourage you to opennew issuewith description of the problem and attached debug log file.