Skip to content

Commit 58040ad

Browse files
committed
refactor readme
1 parent f0d1a92 commit 58040ad

File tree

3 files changed

+100
-7
lines changed

3 files changed

+100
-7
lines changed

README.md

Lines changed: 100 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,112 @@
1-
## Cloud Intelligence Dashboard Framework
2-
[Cloud Intelligence Dashboards](https://catalog.workshops.aws/awscid) is a project that provides AWS customers with a series of in-depth and customizable dashboards for the most comprehensive cost and usage details to help optimize cost, track usage goals, and achieve operational excellence.
1+
## CID Data Collection Framework
32

4-
This repostory contains following elements:
5-
* [data-collection](/data-collection) - a set of Cloud Formation Templates for collecting data from Management and Linked Accounts.
6-
* [case-summarization](/case-summarization) - a Cloud Formation Template for deploying the AWS Support Case Summarization plugin that offers the capability to summarize cases through Generative AI powered by Amazon Bedrock.
3+
## Table of Contents
4+
1. [Overview](#Overview)
5+
1. [Architecture of Foundational Dashboards](#Architecture-of-Foundational-Dashboards)
6+
1. [Cost](#Cost)
7+
1. [Prerequisites](#Prerequisites)
8+
1. [Deployment Steps](#Deployment-Steps)
9+
1. [Cleanup](#Cleanup)
10+
1. [FAQ](#FAQ)
11+
1. [Changelogs](#Changelogs)
12+
1. [Feedback](#Feedback)
13+
1. [Security](#Security)
14+
1. [License](#License)
15+
1. [Notices](#Notices)
716

8-
## Support and Contribution
17+
## Overview
18+
This repository is a part of [Cloud Intelligence Dashboards](https://catalog.workshops.aws/awscid), a project that provides AWS customers with a series of in-depth and customizable dashboards for the most comprehensive cost and usage details to help optimize cost, track usage goals, and achieve operational excellence.
919

20+
All Data Collections can be used independently from Dashboards. Typically data collections store data on Amazon S3 and provide AWS Glue tables and Athena Views to explore and use these data.
21+
22+
This repository contains following elements:
23+
* [data-exports](/data-exports) - a Cloud Formation Templates for AWS Data Exports, such as Cost and Usage Report 2.0 and others. This allows a replication of Exports from your Management Account(s) to a Dedicated Data Collection Accounts as well as aggregation of multiple Exports from a set of Linked Accounts.
24+
* [data-collection](/data-collection) - a set of Cloud Formation Templates for collecting infrastructure operational data from Management and Linked Accounts. Such as data from AWS Trusted Advisor, AWS Compute Optimizer, Inventories, Pricing, AWS Health, AWS Support Cases etc. See more about types of data collected [here](/data-collection).
25+
* [case-summarization](/case-summarization) - an additional Cloud Formation Template for deploying the AWS Support Case Summarization plugin that offers the capability to summarize cases through Generative AI powered by Amazon Bedrock.
26+
27+
### Other AWS Services
28+
* [Collection of AWS Config data](https://github.com/aws-samples/config-resource-compliance-dashboard)
29+
30+
### Multi-cloud data
31+
* [Collection of Azure Cost Data](https://github.com/aws-samples/aws-data-pipelines-for-azure-storage/)
32+
* [Collection of GCP Cost Data](https://github.com/awslabs/cid-gcp-cost-dashboard/)
33+
* [Collection of OCI Cost Data](https://github.com/awslabs/cid-oci-cost-dashboard/)
34+
35+
## Architecture Data Exports
36+
37+
![Architecture of Data Exports](images/architecture-data-exports.png "Architecture of Data Exports")
38+
39+
1. [AWS Data Exports](https://aws.amazon.com/aws-cost-management/aws-data-exports/) delivers daily the Cost & Usage Report (CUR2) to an [Amazon S3 Bucket](https://aws.amazon.com/s3/) in the Management Account.
40+
2. [Amazon S3](https://aws.amazon.com/s3/) replication rule copies Export data to a dedicated Data Collection Account S3 bucket automatically.
41+
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.
42+
4. [Amazon QuickSight](https://aws.amazon.com/quicksight/) datasets can read from [Amazon Athena](https://aws.amazon.com/athena/). Check Cloud Intelligence Dashboards.
43+
44+
See more in [data-exports](/data-exports).
45+
46+
## Architecture Data Collection
47+
![Architecture of Advanced Data Collection](images/architecture-data-collection.png "Architecture of Advanced Data Collection")
48+
49+
1. The Advanced Data Collection can be deployed to enable advanced dashboards based on [AWS Trusted Advisor](https://aws.amazon.com/trustedadvisor/), [AWS Health Events](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html) and other sources. Additional data is retrieved from [AWS Organization](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/) for data collection modules on a configurable schedule.
50+
51+
2. The "Account Collector" [AWS Lambda](https://aws.amazon.com/lambda/) in AWS Step Functions retrieves linked account details using [AWS Organizations API](https://docs.aws.amazon.com/organizations/latest/APIReference/Welcome.html).
52+
53+
3. 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/sdk-for-python/).
54+
55+
4. Retrieved data is stored in a centralized [Amazon S3 Bucket](https://aws.amazon.com/s3/).
56+
57+
5. Advanced Cloud Intelligence Dashboards leverage [Amazon Athena](https://aws.amazon.com/athena/) and [Amazon QuickSight](https://aws.amazon.com/quicksight/) for comprehensive data analysis.
58+
59+
60+
See more in [data-collection](/data-collection).
61+
62+
63+
## Cost
64+
The following table provides a sample cost breakdown for deploying of Foundational Dashboards with the default parameters in the US East (N. Virginia) Region for one month.
65+
66+
| AWS Service | Dimensions | Cost [USD] |
67+
|---------------------------------|-------------------------------|------------------|
68+
| S3 | Monthly storage | $5-10/month* |
69+
| AWS Glue Crawler | Monthly operation. | $3/month* |
70+
| AWS Athena | Data scanned monthly | $15/month* |
71+
| **Total Estimated Monthly Cost** | | **<$50** |
72+
73+
\* Costs are relative to the size of collected data (number of workloads, AWS Accounts, Regions etc).
74+
75+
Pleas use AWS Pricing Calculator for precise estimation.
76+
77+
## Prerequisites
78+
You need access to AWS Accounts. We recommend deployment of the Data Collection in a dedicated Data Collection Account, other than your Management (Payer) Account. You can use it to aggregate data from multiple Management (Payer) Accounts or multiple Linked Accounts.
79+
80+
If you do not have access to the Management/Payer Account, you can still collect some types fo data across multiple Linked accounts.
81+
82+
## Deployment and Cleanup Steps
83+
Reference to folders.
84+
* [data-exports](/data-exports)
85+
* [data-collection](/data-collection)
86+
* [case-summarization](/case-summarization)
87+
88+
89+
## Changelogs
90+
Check [Releases](/releases)
91+
92+
## Feedback
93+
Please reference to [this page](https://catalog.workshops.aws/awscid/en-US/feedback-support)
94+
95+
## Contribution
1096
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
1197

1298
## Security
99+
When you build systems on AWS infrastructure, security responsibilities are shared between you and AWS. This [shared responsibility
100+
model](https://aws.amazon.com/compliance/shared-responsibility-model/) reduces your operational burden because AWS operates, manages, and
101+
controls the components including the host operating system, the virtualization layer, and the physical security of the facilities in
102+
which the services operate. For more information about AWS security, visit [AWS Cloud Security](http://aws.amazon.com/security/).
13103

14104
See [SECURITY](SECURITY.md) for more information.
15105

16106
## License
107+
This project is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file.
108+
109+
## Notices
110+
Dashboards and their content: (a) are for informational purposes only, (b) represents current AWS product offerings and practices, which are subject to change without notice, and (c) does not create any commitments or assurances from AWS and its affiliates, suppliers or licensors. AWS content, products or services are provided “as is” without warranties, representations, or conditions of any kind, whether express or implied. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers.
17111

18-
This project is licensed under the Apache-2.0 License.
19112

560 KB
Loading
401 KB
Loading

0 commit comments

Comments
 (0)