Skip to content

Commit c096fcf

Browse files
authored
massive doc migration (#1277)
1 parent f51e6dd commit c096fcf

File tree

20 files changed

+62
-62
lines changed

20 files changed

+62
-62
lines changed

CID-CMD.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Cloud Intelligence Dashboards provides a python tool for installation and upgrade of Dashboards. This tool can also export dashboards to deployable artifacts including QuickSight Dashboards, Athena Views, Glue Tables etc.
44

5-
CID is also provided in a form of CloudFormation templates. See detailed instructions in the [Well Architected Workshop](https://catalog.workshops.aws/awscid/en-US/dashboards/foundational/cudos-cid-kpi/deploy) site.
5+
CID is also provided in a form of CloudFormation templates. See detailed instructions in the [AWS Documentation](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/deployment-in-global-regions.html) site.
66

77

88
## Before you start

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@
2121
## Overview
2222
The Cloud Intelligence Dashboards is an open-source framework, lovingly cultivated and maintained by a group of customer-obsessed AWSers, that gives customers the power to get high-level and granular insight into their cost and usage data. Supported by the Well-Architected framework, the dashboards can be deployed by any customer using a CloudFormation template or a command-line tool in their environment in under 30 minutes. These dashboards help you to drive financial accountability, optimize cost, track usage goals, implement best-practices for governance, and achieve operational excellence across all your organization.
2323

24-
Cloud Intelligence Dashboards Framework provides AWS customers with [more then 20 Dashboards](https://catalog.workshops.aws/awscid/dashboards/).
24+
Cloud Intelligence Dashboards Framework provides AWS customers with [more then 20 Dashboards](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/dashboards.html).
2525
* Foundational Dashboards - A set of main Dashboards that only require Cost and Usage Report(CUR)
2626
* Advanced Dashboards - Require CID Data Collection and CUR
2727
* Additional Dashboards - Require various custom datasources or created for very specific use cases.
2828

29-
We recommend starting with deployment of [Foundational Dashboards](https://catalog.workshops.aws/awscid/en-US/dashboards/foundational/cudos-cid-kpi/deploy). Then deploy [Data Collection](https://catalog.workshops.aws/awscid/en-US/data-collection) and [Advanced Dashboards](https://catalog.workshops.aws/awscid/en-US/dashboards/advanced). Check for [Additional](https://catalog.workshops.aws/awscid/en-US/dashboards/additional) Dashboards.
29+
We recommend starting with deployment of [Foundational Dashboards](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/dashboard-foundational.html). Then deploy [Data Collection](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/data-collection.html) and [Advanced Dashboards](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/dashboards.html#advanced-dashboards). Check for [Additional](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/dashboards.html#additional-dashboards) Dashboards.
3030

3131

32-
[![Documentation >](assets/images/documentation.svg)](https://catalog.workshops.aws/awscid/en-US/dashboards/foundational/cudos-cid-kpi/deploy)
32+
[![Documentation >](assets/images/documentation.svg)](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/deployment-in-global-regions.html)
3333

3434

3535
## Architecture of Foundational Dashboards
@@ -39,9 +39,9 @@ We recommend starting with deployment of [Foundational Dashboards](https://catal
3939
2. [Amazon S3](https://aws.amazon.com/s3/) replication rule copies Export data to a dedicated Data Collection Account S3 bucket automatically.
4040
3. [Amazon Athena](https://aws.amazon.com/athena/) allows querying data directly from the S3 bucket using an [AWS Glue](https://aws.amazon.com/glue/) table schema definition.
4141
4. [Amazon QuickSight](https://aws.amazon.com/quicksight/) creates datasets from [Amazon Athena](https://aws.amazon.com/athena/), refreshes daily and caches in [SPICE](https://docs.aws.amazon.com/quicksight/latest/user/spice.html)(Super-fast, Parallel, In-memory Calculation Engine) for [Amazon QuickSight](https://aws.amazon.com/quicksight/)
42-
5. User Teams (Executives, FinOps, Engineers) can access Cloud Intelligence Dashboards in [Amazon QuickSight](https://aws.amazon.com/quicksight/). Access is secured through [AWS IAM](https://aws.amazon.com/iam/), IIC ([AWS IAM Identity Center](https://aws.amazon.com/iam/identity-center/), formerly SSO), and optional [Row Level Security](https://catalog.workshops.aws/awscid/en-US/customizations/row-level-security).
42+
5. User Teams (Executives, FinOps, Engineers) can access Cloud Intelligence Dashboards in [Amazon QuickSight](https://aws.amazon.com/quicksight/). Access is secured through [AWS IAM](https://aws.amazon.com/iam/), IIC ([AWS IAM Identity Center](https://aws.amazon.com/iam/identity-center/), formerly SSO), and optional [Row Level Security](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/row-level-security.html).
4343

44-
This foundational architecture is recommended for starting and allows deployment of [Foundational Dashboards](https://catalog.workshops.aws/awscid/en-US/dashboards/foundational) like CUDOS, CID and KPI.
44+
This foundational architecture is recommended for starting and allows deployment of [Foundational Dashboards](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/dashboard-foundational.html) like CUDOS, CID and KPI.
4545

4646
## Architecture of Advanced Dashboards
4747
![Advanced Architecture](assets/images/advanced-architecture.png "Foundational Architecture")
@@ -50,14 +50,14 @@ This foundational architecture is recommended for starting and allows deployment
5050
2. [Amazon S3](https://aws.amazon.com/s3/) replication rule copies Export data to a dedicated Data Collection Account S3 bucket automatically.
5151
3. [Amazon Athena](https://aws.amazon.com/athena/) allows querying data directly from the S3 bucket using an [AWS Glue](https://aws.amazon.com/glue/) table schema definition.
5252
4. [Amazon QuickSight](https://aws.amazon.com/quicksight/) creates datasets from [Amazon Athena](https://aws.amazon.com/athena/), refreshes daily and caches in [SPICE](https://docs.aws.amazon.com/quicksight/latest/user/spice.html)(Super-fast, Parallel, In-memory Calculation Engine) for [Amazon QuickSight](https://aws.amazon.com/quicksight/)
53-
5. User Teams (Executives, FinOps, Engineers) can access Cloud Intelligence Dashboards in [Amazon QuickSight](https://aws.amazon.com/quicksight/). Access is secured through [AWS IAM](https://aws.amazon.com/iam/), IIC ([AWS IAM Identity Center](https://aws.amazon.com/iam/identity-center/), formerly SSO), and optional [Row Level Security](https://catalog.workshops.aws/awscid/en-US/customizations/row-level-security).
53+
5. User Teams (Executives, FinOps, Engineers) can access Cloud Intelligence Dashboards in [Amazon QuickSight](https://aws.amazon.com/quicksight/). Access is secured through [AWS IAM](https://aws.amazon.com/iam/), IIC ([AWS IAM Identity Center](https://aws.amazon.com/iam/identity-center/), formerly SSO), and optional [Row Level Security](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/row-level-security.html).
5454
6. Optionally, the Advanced data collection can be deployed to enable advanced dashboards based on [AWS Trusted Advisor](https://aws.amazon.com/premiumsupport/trustedadvisor/), [AWS Health](https://aws.amazon.com/premiumsupport/technology/aws-health-dashboard/) Events and other sources. Additional data is retrieved from [AWS Organizations](https://aws.amazon.com/organizations/) or Linked Accounts. In this case [Amazon EventBridge](https://aws.amazon.com/eventbridge/) rule triggers an [AWS Step Functions](https://aws.amazon.com/step-functions/) workflow for data collection modules on a configurable schedule.
5555
7. The "Account Collector" [AWS Lambda](https://aws.amazon.com/lambda/) in AWS Step Functions retrieves linked account details using AWS Organizations API.
5656
8. The "Data Collection" Lambda function in AWS Step Functions assumes role in each linked account to retrieve account-specific data via [AWS SDK](https://aws.amazon.com/developer/tools/).
5757
9. Retrieved data is stored in a centralized Amazon S3 Bucket.
58-
10. [Advanced Cloud Intelligence Dashboards](https://catalog.workshops.aws/awscid/en-US/dashboards/advanced) leverage Amazon Athena and Amazon QuickSight for comprehensive data analysis.
58+
10. [Advanced Cloud Intelligence Dashboards](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/dashboards.html#advanced-dashboards) leverage Amazon Athena and Amazon QuickSight for comprehensive data analysis.
5959

60-
This advanced data collection architecture allows deployment of [Advanced Dashboards](https://catalog.workshops.aws/awscid/en-US/dashboards/advanced) like Trusted Advisor Dashboard, Health, Graviton, Compute Optimizer Dashboard and many more.
60+
This advanced data collection architecture allows deployment of [Advanced Dashboards](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/dashboards.html#advanced-dashboards) like Trusted Advisor Dashboard, Health, Graviton, Compute Optimizer Dashboard and many more.
6161

6262

6363
## Cost
@@ -126,23 +126,23 @@ There are several ways we can deploy dashboards:
126126
1. Using cid-cmd tool from command line
127127
1. [CloudFormation Template](./cfn-templates/cid-cfn.yml) using cid-cmd tool in Amazon Lambda. (Recommended)
128128

129-
Please refer to the deployment documentation [here](https://catalog.workshops.aws/awscid/en-US/dashboards/foundational/cudos-cid-kpi/deploy).
129+
Please refer to the deployment documentation [here](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/deployment-in-global-regions.html).
130130

131-
[![Deployment Guide >](assets/images/deployment-guide-button.svg)](https://catalog.workshops.aws/awscid/en-US/dashboards/foundational/cudos-cid-kpi/deploy)
131+
[![Deployment Guide >](assets/images/deployment-guide-button.svg)](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/deployment-in-global-regions.html)
132132

133133

134134
## Cleanup
135-
Please refer to the documentation [here](https://catalog.workshops.aws/awscid/en-US/dashboards/teardown).
135+
Please refer to the documentation [here](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/dashboard-teardown.html).
136136

137137
## FAQ
138-
Please refer to the documentation [here](https://catalog.workshops.aws/awscid/en-US/faqs).
138+
Please refer to the documentation [here](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/faq.html).
139139

140140
## Changelogs
141141
For dashboards please check Change Logs [here](changes/)
142142
For CID deployment tool, including Cli and CFN please check [Releases](/releases)
143143

144144
## Feedback
145-
Please reference to [this page](https://catalog.workshops.aws/awscid/en-US/feedback-support)
145+
Please reference to [this page](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/feedback-support.html)
146146

147147
## Security
148148
When you build systems on AWS infrastructure, security responsibilities are shared between you and AWS. This [shared responsibility

cfn-templates/cid-cfn.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Metadata:
1919
- DeployCostIntelligenceDashboard
2020
- DeployKPIDashboard
2121
- Label:
22-
default: Trusted Advisor and Compute Optimizer Dashboards. To deploy these two dashboard, you must first deploy the Optimization Data Collection Lab (https://catalog.workshops.aws/awscid/en-US/data-collection/)
22+
default: Trusted Advisor and Compute Optimizer Dashboards. To deploy these two dashboard, you must first deploy the Optimization Data Collection Lab (https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/data-collection.html)
2323
Parameters:
2424
- OptimizationDataCollectionBucketPath
2525
- DeployTAODashboard
@@ -198,12 +198,12 @@ Parameters:
198198
AllowedValues: ["yes", "no"]
199199
DeployTAODashboard:
200200
Type: String
201-
Description: Deploy Trusted Advisor Organizational Dashboard (TAO) - WARNING! Before deploying this dashboard, you need Optimization Data Collection Lab to be installed first https://catalog.workshops.aws/awscid/en-US/data-collection/
201+
Description: Deploy Trusted Advisor Organizational Dashboard (TAO) - WARNING! Before deploying this dashboard, you need Optimization Data Collection Lab to be installed first https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/data-collection.html
202202
Default: "no"
203203
AllowedValues: ["yes", "no"]
204204
DeployComputeOptimizerDashboard:
205205
Type: String
206-
Description: Deploy Compute Optimizer Dashboard (COD) - WARNING! Before deploying this dashboard, you need Optimization Data Collection Lab to be installed first https://catalog.workshops.aws/awscid/en-US/data-collection/
206+
Description: Deploy Compute Optimizer Dashboard (COD) - WARNING! Before deploying this dashboard, you need Optimization Data Collection Lab to be installed first https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/data-collection.html
207207
Default: "no"
208208
AllowedValues: ["yes", "no"]
209209
OptimizationDataCollectionBucketPath:

changes/CHANGELOG-cora.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* Improved ResourceType categorization to explicitly categorize Unattached EBS Volumes with new Resource Type 'EBS Volume: Unattached'
66

77
## CORA - v0.0.8
8-
Added support for organizational taxonomy https://catalog.workshops.aws/awscid/en-US/dashboards/add-organizational-taxonomy
8+
Added support for organizational taxonomy https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/add-organizational-taxonomy.html
99

1010
## CORA - v0.0.7
1111
* Added Support of Idle recommendations

changes/CHANGELOG-cudos.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
* **Executive: Trends**: Sheet 'MoM Trends' renamed to 'Trends'. Added control Trends Type which allows to switch between Monthly, Weekly and Daily Trends. Added control Trends Time Range which allows to adjust a time period when switching between Trend Types. Changed positioning of Product and Account Trends visuals to effectively present more than 3 trends periods.
1313
* **Databases**: Added 'Amazon ElastiCache Redis Migration to Valkey - Adoption Tracking and Potential Savings' section with visuals 'ElastiCache Redis vs Valkey: Cost Breakdown', 'ElastiCache Valkey: Achieved Cost Efficiency Gains vs Redis', 'Monthly Cost Savings Opportunities with Migration to Valkey' and 'Redis Cache Instances and Serverlless Cache: Cost Savings Opportunities with migration to Valkey' to track migration progress to Valkey.
14-
* **Taxonomy Explorer**: 'TAGSplorer sheet complexly redesigned and renamed to Taxonomy Explorer. Now it allows to interactively explore cost and usage details across 2 Taxonomy Dimensions such as tags and account level mappings which added to the dashboard via new [Add Organizational Taxonomy](https://catalog.workshops.aws/awscid/en-US/dashboards/add-organizational-taxonomy) capability.
14+
* **Taxonomy Explorer**: 'TAGSplorer sheet complexly redesigned and renamed to Taxonomy Explorer. Now it allows to interactively explore cost and usage details across 2 Taxonomy Dimensions such as tags and account level mappings which added to the dashboard via new [Add Organizational Taxonomy](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/add-org-taxonomy.html) capability.
1515
* **AI/ML**: Added 'Amazon Bedrock Model Unit Cost' and 'Amazon Bedrock Cost per Legal Entity' visuals . Updated Bedrock UsageType Group for more accurate usage type categorization. Added Model Name calculated field to group different model ids under the same name on 'Amazon Bedrock Daily Cost per Resource' visual.
1616
* **Amazon S3 Summary**: Added 'Group By' control which allows to switch between S3 Operation and S3 UsageType Group in 'Total Cost per Bucket by Operation', 'Daily Cost Bucket Explorer' and 'Daily Storage Bucket Explorer' visuals.
1717
* **Analytics**: Added new section AWS Glue with 'AWS Glue Spend per Account','AWS Glue Spend per UsageType Group', 'AWS Glue Spend per Usage Type' and 'AWS Glue Detailed Resource View' visuals.
@@ -68,7 +68,7 @@
6868
* **Databases:** Fix for Normalized Instance Hours not shown on RI Coverage and Daily Elasticity visuals.
6969

7070
# CUDOS - 5.1.0
71-
**Important!** If you have CUDOS v5.0.0 deployed you can use [standard update process](https://catalog.workshops.aws/awscid/en-US/dashboards/update). If you have previous version deployed follow [this guide](https://catalog.workshops.aws/awscid/en-US/faqs#how-to-update-to-cudos-v5-if-i-have-previous-version-of-cudos-installed) to deploy CUDOS v5. You can check version of your currently deployed dashboard on the About tab.
71+
**Important!** If you have CUDOS v5.0.0 deployed you can use [standard update process](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/update-dashboards.html). If you have previous version deployed follow [this guide](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/faq.html#how-to-update-to-cudos-v5-if-i-have-previous-version-of-cudos-installed) to deploy CUDOS v5. You can check version of your currently deployed dashboard on the About tab.
7272

7373
**Changes**
7474
* **Executive: Billing Summary**: Added control to group Invoice and Amortized Spend by Payer Account, Charge Type Group and Service Category from [FOCUS](https://focus.finops.org/#specification) specification.
@@ -82,7 +82,7 @@
8282
* **Storage**: Changed 'Volume Explorer: TOP 50 EBS Volume Details' filter from previous month to last 30 days.
8383

8484
# CUDOS - 5.0.0
85-
**Important!** Learn more about CUDOS v5 and how to deploy in our [FAQ](https://catalog.workshops.aws/awscid/en-US/faqs#cudos-v5-faqs) page.
85+
**Important!** Learn more about CUDOS v5 and how to deploy in our [FAQ](https://docs.aws.amazon.com/guidance/latest/cloud-intelligence-dashboards/faq.html#cudos-v5-faqs) page.
8686

8787
**Changes**
8888
* Re-designed dataset structure. All datasets used by CUDOS v5 use fast QuickSight SPICE storage which reduces time required to load visuals. CUDOS v5 is using 3 datasets:

0 commit comments

Comments
 (0)