AWS guidance documentation change
Summary
Updated documentation for FOCUS Dashboard including enhanced multi-cloud support, installation instructions, security controls for data encryption, and consolidation view management
Security assessment
The changes mention encryption of sensitive billing data using KMS keys to prevent unauthorized access. While this demonstrates security best practices, there is no evidence of addressing a specific vulnerability or security incident. The documentation addition about encryption qualifies as security feature documentation.
Diff
diff --git a/guidance/latest/cloud-intelligence-dashboards/focus-dashboard.md b/guidance/latest/cloud-intelligence-dashboards/focus-dashboard.md index e530e6bf7..863407bb6 100644 --- a//guidance/latest/cloud-intelligence-dashboards/focus-dashboard.md +++ b//guidance/latest/cloud-intelligence-dashboards/focus-dashboard.md @@ -3 +3 @@ -IntroductionHigh Level ArchitectureDemo DashboardPrerequisitesDeploymentAdd FOCUS data from other cloud providers to FOCUS DashboardUpdateAuthorsContributorsFeedback & SupportFAQ +High Level ArchitectureDemo DashboardPrerequisitesDeploymentAdd FOCUS Data from Other Cloud ProvidersUpdateAuthorsContributorsFeedback & SupportFAQ @@ -7,2 +6,0 @@ IntroductionHigh Level ArchitectureDemo DashboardPrerequisitesDeploymentAdd FOCU -## Introduction - @@ -13 +11,5 @@ Supported by the FinOps Foundation, FOCUS aims to reduce complexity for FinOps P -CID FOCUS Dashboard is an open source and customizable dashboard which provides pre-defined visuals to get actionable insights from FOCUS data in Amazon Quick Sight. It allows you to quickly get started with using FOCUS in your organization. FOCUS Dashboard provides the following features: +The CID FOCUS Dashboard is an open-source and customizable dashboard that provides pre-defined visuals to get actionable insights from FOCUS data in Amazon QuickSight. It allows you to quickly get started with using FOCUS in your organization. The FOCUS Dashboard provides the following features: + + * **Consolidated view** of FOCUS data from multiple dimensions across your entire organization + + * Support for consolidation of **multiple FOCUS specification versions** from different cloud providers @@ -15 +17 @@ CID FOCUS Dashboard is an open source and customizable dashboard which provides - * Consolidated view for FOCUS data from multiple dimensions across entire organization + * Month-over-month trends with the ability to drill down from high-level visibility into resource-level details in a few clicks @@ -17 +19 @@ CID FOCUS Dashboard is an open source and customizable dashboard which provides - * Effective discounts rate calculations + * Support of organizational taxonomy from tags @@ -19 +21 @@ CID FOCUS Dashboard is an open source and customizable dashboard which provides - * MoM trends with ability to drill down from high level visibility into resource level details in a matter of few clicks + * Effective discount rate calculations @@ -28 +30 @@ CID FOCUS Dashboard is an open source and customizable dashboard which provides - 1. AWS Data Exports service provides FOCUS data. Use CID [Data Exports](./data-exports.html) stack to activate that in your Management (Payer) Account and automatically configure the replication to a Data Collection account. + 1. AWS Data Exports service provides FOCUS data (currently supporting FOCUS 1.2 for AWS). Use the CID [Data Exports](./data-exports.html) stack to activate it in your Management (Payer) Account and automatically configure the replication to a Data Collection Account. @@ -30 +32 @@ CID FOCUS Dashboard is an open source and customizable dashboard which provides - 2. Install CID FOCUS Dashboards that leverages FOCUS data and provides a placeholder consolidated view in Amazon Athena that can be extended once added new FOCUS data from other providers. + 2. Install CID FOCUS Dashboard that leverages FOCUS data and provides a dynamically generated consolidated view in Amazon Athena. This view can be extended once you add FOCUS data from other providers. @@ -32 +34 @@ CID FOCUS Dashboard is an open source and customizable dashboard which provides - 3. Install the FOCUS data collection stack(s) that collects the data from other data providers. Currently we provide integrations to collect FOCUS data from [Microsoft Azure](https://catalog.workshops.aws/cidforazure/en-US/03-setup), [Google Cloud Platform](https://catalog.workshops.aws/cid-gcp-cost-dashboard/en-US/02-solution-design) and [Oracle Cloud Infrastructure](https://github.com/awslabs/cid-oci-cost-dashboard/) see more. Typically these stack are leveraging scheduled AWS Lambda or AWS Glue Jobs and retrieve data from API using credentials stored in AWS Secret Manager. Also The data in this case encrypted with custom KMS keys to protect sensitive billing information from any unauthorized access (including AWS). + 3. Install the FOCUS data collection stack(s) that collect data from other providers. Currently we provide integrations to collect FOCUS data from [Microsoft Azure](https://catalog.workshops.aws/cidforazure/en-US/03-setup), [Google Cloud Platform](https://catalog.workshops.aws/cid-gcp-cost-dashboard/en-US/02-solution-design), and [Oracle Cloud Infrastructure](https://github.com/awslabs/cid-oci-cost-dashboard/). Learn more about integration of FOCUS data. Typically these stacks leverage scheduled AWS Lambda or AWS Glue Jobs and retrieve data via APIs using credentials stored in AWS Secrets Manager. The data is encrypted with custom KMS keys to protect sensitive billing information from unauthorized access. @@ -34 +36 @@ CID FOCUS Dashboard is an open source and customizable dashboard which provides - 4. Update [FOCUS Consolidation View](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/blob/main/dashboards/focus/focus_consolidation_view/focus_consolidation_view.sql) to include tables with FOCUS data from other cloud providers + 4. Update the focus_consolidation_view in Athena to include tables with FOCUS data from other cloud providers. @@ -36 +38 @@ CID FOCUS Dashboard is an open source and customizable dashboard which provides - 5. You can also export cost data from OnPremises datacenters or SaaS providers in the same format and integrate them in similar way. + 5. You can also export cost data from on-premises datacenters or SaaS providers in the same format and integrate them in a similar way. @@ -43 +45,3 @@ CID FOCUS Dashboard is an open source and customizable dashboard which provides -Get more familiar with Dashboard using the live, interactive demo dashboard following this [link](https://cid.workshops.aws.dev/demo?dashboard=focus-dashboard&sheet=default) +Get more familiar with the dashboard using the live, interactive demo dashboard following this [link](https://cid.workshops.aws.dev/demo?dashboard=focus-dashboard&sheet=default). + +Explore key FOCUS Dashboard capabilities in the [interactive presentation](https://app.storylane.io/share/zutqlizt5v45). @@ -49 +53 @@ Get more familiar with Dashboard using the live, interactive demo dashboard foll -Before installing FOCUS Dashboard you need to enable FOCUS Data Export and consolidate it from your Management (Payer) Accounts in Data Collection Account. +Before installing the FOCUS Dashboard, you need to enable FOCUS Data Export and consolidate it from your Management (Payer) Accounts in the Data Collection Account. @@ -53 +57,2 @@ Before installing FOCUS Dashboard you need to enable FOCUS Data Export and conso - 1. Create FOCUS Data Export following the steps in [Data Export](./data-exports.html) page and return to this page once completed. + 1. Create a FOCUS Data Export following the steps in the [Data Export](./data-exports.html) page and return to this page once completed. + @@ -56,0 +62 @@ Before installing FOCUS Dashboard you need to enable FOCUS Data Export and conso +The Data Export prerequisites support FOCUS 1.2 for AWS. If you are migrating from FOCUS 1.0, see [Migration to AWS FOCUS 1.2](./migration-to-focus-1-2.html). @@ -67 +73 @@ CloudFormation -**Prerequisite** : To install this dashboard using CloudFormation, you need to install Foundational Dashboards CFN with version v4.0.0 or above as described [here](./deployment-in-global-regions.html#deployment-in-global-region-deploy-dashboard) +**Prerequisite** : To install this dashboard using CloudFormation, you need to install Foundational Dashboards CFN with version v4.0.0 or above as described [here](./deployment-in-global-regions.html#deployment-in-global-region-deploy-dashboard). @@ -69 +75 @@ CloudFormation - 1. Log in to to your **Data Collection** Account. + 1. Log in to your **Data Collection** Account. @@ -71 +77 @@ CloudFormation - 2. Click the Launch Stack button below to open the **pre-populated stack template** in your CloudFormation. + 2. Click the Launch Stack button below to open the **pre-populated stack template** in your CloudFormation console. @@ -75 +81 @@ CloudFormation - 3. You can change **Stack name** for your template if you wish. + 3. You can change the **Stack name** if you wish. @@ -77 +83 @@ CloudFormation - 4. Leave **Parameters** values as it is. + 4. Leave **Parameters** values as they are. @@ -81 +87 @@ CloudFormation - 6. You will see the stack will start in **CREATE_IN_PROGRESS**. Once complete, the stack will show **CREATE_COMPLETE** + 6. The stack will start in **CREATE_IN_PROGRESS**. Once complete, the stack will show **CREATE_COMPLETE**. @@ -87 +93 @@ CloudFormation -**Troubleshooting:** If you see error "No export named cid-CidExecArn found" during stack deployment, make sure you have completed prerequisite steps. +**Troubleshooting:** If you see the error "No export named cid-CidExecArn found" during stack deployment, make sure you have completed the prerequisite steps. @@ -95 +101 @@ Command Line -Alternative method to install dashboards is the [cid-cmd](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/blob/main/CID-CMD.md#command-line-tool-cid-cmd) tool. +An alternative method to install dashboards is the [cid-cmd](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/blob/main/CID-CMD.md#command-line-tool-cid-cmd) tool. @@ -97 +103 @@ Alternative method to install dashboards is the [cid-cmd](https://github.com/aws - 1. Log in to to your **Data Collection** Account. + 1. Log in to your **Data Collection** Account. @@ -99 +105 @@ Alternative method to install dashboards is the [cid-cmd](https://github.com/aws - 2. Open up a command-line interface with permissions to run API requests in your AWS account. We recommend to use [CloudShell](https://console.aws.amazon.com/cloudshell). + 2. Open a command-line interface with permissions to run API requests in your AWS account. We recommend using [CloudShell](https://console.aws.amazon.com/cloudshell). @@ -101 +107 @@ Alternative method to install dashboards is the [cid-cmd](https://github.com/aws - 3. In your command-line interface run the following command to download and install the CID CLI tool: + 3. In your command-line interface, run the following command to download and install the CID CLI tool: @@ -105 +111,6 @@ Alternative method to install dashboards is the [cid-cmd](https://github.com/aws - 4. In your command-line interface run the following command to deploy the dashboard: +If using [CloudShell](https://console.aws.amazon.com/cloudshell), install Python 3.11 first: + + sudo yum install python3.11-pip -y + python3.11 -m pip install -U cid-cmd + + 4. Run the following command to deploy the dashboard: @@ -109 +120 @@ Alternative method to install dashboards is the [cid-cmd](https://github.com/aws -Please follow the instructions from the deployment wizard. More info about command line options are in the [Readme](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/blob/main/CID-CMD.md#command-line-tool-cid-cmd) or `cid-cmd --help`. +Follow the instructions from the deployment wizard. More info about command-line options is available in the [Readme](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/blob/main/CID-CMD.md#command-line-tool-cid-cmd) or via `cid-cmd --help`. @@ -114 +125,3 @@ Please follow the instructions from the deployment wizard. More info about comma -###### Note +Data Exports can take up to 24-48 hours to deliver the first reports. If you just installed Data Exports, the dashboard will most likely be empty. Please allow up to 24 hours for data to arrive. + +## Add FOCUS Data from Other Cloud Providers @@ -116 +129 @@ Please follow the instructions from the deployment wizard. More info about comma -Please note that DataExport can take up to 24-48 hours to deliver the first reports. If you just installed Data Exports, the dashboard will be most likely empty. Please come back after 24 hours. +The FOCUS Dashboard supports consolidation of FOCUS data from multiple FOCUS specification versions, allowing you to combine data from different cloud providers regardless of the FOCUS version they export. @@ -118 +131 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo -## Add FOCUS data from other cloud providers to FOCUS Dashboard +After deploying each cloud provider integration, run the `cid-cmd update` command as described in common update steps to detect available FOCUS tables and select which ones to include in the consolidated view to be presented on FOCUS Dashboard. @@ -124 +137 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo - 1. Deploy FOCUS Dashboard + 1. Deploy the FOCUS Dashboard. @@ -126 +139 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo - 2. Deploy [Cloud Intelligence Dashboard for Azure workshop](https://catalog.workshops.aws/cidforazure/en-US/03-setup) choosing FOCUS in [Export Type](https://catalog.workshops.aws/cidforazure/en-US/03_Setup/05_Parameters/#export-type) + 2. Deploy the [Cloud Intelligence Dashboard for Azure workshop](https://catalog.workshops.aws/cidforazure/en-US/03-setup), choosing FOCUS in [Export Type](https://catalog.workshops.aws/cidforazure/en-US/03_Setup/05_Parameters/#export-type). @@ -128 +141 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo - 3. Integrate Azure data into [focus_consolidation_view](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/tree/main/dashboards/focus/focus_consolidation_view) in Amazon Athena by following [these steps](https://catalog.workshops.aws/cidforazure/en-US/03-setup/04-dashboard-deployment/02-focus-export-dashboard#instructions) + 3. Follow the common update steps below. @@ -133 +146 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo -### GCP +### Google Cloud Platform (GCP) @@ -137 +150 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo - 1. Deploy FOCUS Dashboard + 1. Deploy the FOCUS Dashboard. @@ -139 +152 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo - 2. Deploy [GCP](https://catalog.workshops.aws/cid-gcp-cost-dashboard/en-US/02-solution-design) workshop + 2. Deploy the [GCP](https://catalog.workshops.aws/cid-gcp-cost-dashboard/en-US/02-solution-design) workshop. @@ -141 +154 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo - 3. Integrate data into [focus_consolidation_view](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/tree/main/dashboards/focus/focus_consolidation_view) in Amazon Athena + 3. Follow the common update steps below. @@ -146 +159 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo -### OCI +### Oracle Cloud Infrastructure (OCI) @@ -150 +163 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo - 1. Deploy FOCUS Dashboard + 1. Deploy the FOCUS Dashboard. @@ -152 +165 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo - 2. Deploy [OCI](https://github.com/awslabs/cid-oci-cost-dashboard/) workshop + 2. Deploy the [OCI](https://catalog.workshops.aws/cidforoci/en-US/) workshop. @@ -154 +167 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo - 3. Integrate data into [focus_consolidation_view](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/tree/main/dashboards/focus/focus_consolidation_view) in Amazon Athena + 3. Follow the common update steps below. @@ -158,0 +172,25 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo +### Common Update Steps + +After deploying any cloud provider integration above, update the FOCUS Dashboard and consolidation view: + + 1. Log in to your **Data Collection** Account. + + 2. Open a command-line interface with permissions to run API requests in your AWS account. We recommend using [CloudShell](https://console.aws.amazon.com/cloudshell). + + 3. Run the following commands: + + pip3 install --upgrade cid-cmd + cid-cmd update --recursive --force --dashboard-id focus-dashboard + +If using [CloudShell](https://console.aws.amazon.com/cloudshell), replace the first line with: + + sudo yum install python3.11-pip -y + python3.11 -m pip install -U cid-cmd + + 4. Select the FOCUS tables you would like to include in the consolidated view when prompted. + + + + + + @@ -161 +199,5 @@ Please note that DataExport can take up to 24-48 hours to deliver the first repo -Please note that dashboards are not updated with update of CloudFormation Stack. When new version of the dashboard template is released, you can update your dashboard by running the following command in your command-line interface: +Dashboards are not updated with an update of the CloudFormation stack. There are two update options depending on your needs: + +### Dashboard Update + +When a new version of the dashboard template is released, update your dashboard by running: @@ -165,0 +208,11 @@ Please note that dashboards are not updated with update of CloudFormation Stack. +This updates the dashboard visuals to the latest template version. + +### Dashboard and Data Schema Update + +To add new FOCUS tables from other cloud providers, include new tags, or update the consolidation view schema, run: + + + cid-cmd update --recursive --force --dashboard-id focus-dashboard + +This updates the dashboard, datasets and all dependent Athena views. You will be prompted to select which FOCUS tables to include in the consolidated view. + @@ -170 +223 @@ Please note that dashboards are not updated with update of CloudFormation Stack. - * Iakov Gan, Senior Solution Architect + * Iakov Gan, Ex-Amazonian @@ -198 +251 @@ Follow [Feedback & Support](./feedback-support.html) guide -Unfortunately FOCUS Format does not include important information like [lineItem/Operation](https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O) that is critical for FinOps use cases. Until FOCUS specification extended to support that we cannot recommend FOCUS for Cost Optimization scenarios. Nevertheless FOCUS can be useful for a wide range high level reporting use cases. +The FOCUS format does not currently include important information like [lineItem/Operation](https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O) that is critical for FinOps use cases. Until the FOCUS specification is extended to support this, we cannot recommend FOCUS for Cost Optimization scenarios. Nevertheless, FOCUS can be useful for a wide range of high-level reporting use cases. @@ -200 +253 @@ Unfortunately FOCUS Format does not include important information like [lineItem -### How we can add XXX FOCUS provider? +### How can we add another FOCUS provider? @@ -203,0 +257,4 @@ Feel free to contribute data export mechanisms for other FOCUS providers. We wil +### Does the dashboard support multiple FOCUS versions? +