You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-36Lines changed: 35 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
-
# Workload Discovery on AWS (v2.3.5)
1
+
# Workload Discovery on AWS (v2.3.6)
2
2
3
-
Workload Discovery on AWS is a tool that quickly visualizes AWS Cloud workloads as architecture diagrams.
4
-
You can use the solution to build, customize, and share detailed workload visualizations based on live data from AWS.
5
-
This solution works by maintaining an inventory of the AWS resources across your accounts and Regions,
3
+
Workload Discovery on AWS is a tool that quickly visualizes AWS Cloud workloads as architecture diagrams.
4
+
You can use the solution to build, customize, and share detailed workload visualizations based on live data from AWS.
5
+
This solution works by maintaining an inventory of the AWS resources across your accounts and Regions,
6
6
mapping relationships between them, and displaying them in a web user interface (web UI).
7
7
8
-
To find out more about Workload Discovery visit our [AWS Solutions](https://aws.amazon.com/solutions/implementations/workload-discovery-on-aws)
8
+
To find out more about Workload Discovery visit our [AWS Solutions](https://aws.amazon.com/solutions/implementations/workload-discovery-on-aws)
9
9
page.
10
10
11
11
## Launch Workload Discovery
@@ -30,14 +30,14 @@ page.
30
30
31
31
## Installation
32
32
33
-
Workload Discovery is deployed to your account using an AWS CloudFormation template and should take approximately 30
34
-
minutes to deploy. See the [deployment guide](https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/automated-deployment.html)
35
-
for instructions, and [the cost overview](https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/overview.html#cost)
33
+
Workload Discovery is deployed to your account using an AWS CloudFormation template and should take approximately 30
34
+
minutes to deploy. See the [deployment guide](https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/automated-deployment.html)
35
+
for instructions, and [the cost overview](https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/overview.html#cost)
36
36
to learn about costs.
37
37
38
38
## Usage
39
39
40
-
A web interface is included with Workload Discovery. Refer to the [documentation](https://github.com/aws-solutions/workload-discovery-on-aws)
40
+
A web interface is included with Workload Discovery. Refer to the [documentation](https://github.com/aws-solutions/workload-discovery-on-aws)
41
41
to learn how to use the application.
42
42
43
43
## Feature requests
@@ -48,30 +48,30 @@ To submit an idea for a feature you would like to see implemented, please [creat
48
48
49
49

50
50
51
-
Workload Discovery is deployed to your account using an AWS CloudFormation template consisting of six components.
52
-
The following is a high level overview of the components. For additional details about each component, refer to
51
+
Workload Discovery is deployed to your account using an AWS CloudFormation template consisting of six components.
52
+
The following is a high level overview of the components. For additional details about each component, refer to
53
53
the [Solution components guide](https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/solution-components.html).
54
54
55
-
The web user interface (UI) interacts with the data component via [AWS AppSync](http://aws.amazon.com/appsync/). The
56
-
web UI requests resource relationship data from the data component. The data component queries and returns data
55
+
The web user interface (UI) interacts with the data component via [AWS AppSync](http://aws.amazon.com/appsync/). The
56
+
web UI requests resource relationship data from the data component. The data component queries and returns data
57
57
from an [Amazon Neptune](http://aws.amazon.com/neptune/) database.
58
58
59
-
The storage management component stores user preferences and saved architecture diagrams. This is implemented using
60
-
[AWS Amplify](http://aws.amazon.com/amplify/) and an [Amazon Simple Storage Service](http://aws.amazon.com/s3/)
59
+
The storage management component stores user preferences and saved architecture diagrams. This is implemented using
60
+
[AWS Amplify](http://aws.amazon.com/amplify/) and an [Amazon Simple Storage Service](http://aws.amazon.com/s3/)
61
61
(Amazon S3) bucket.
62
62
63
-
The discovery component uses [AWS Config](http://aws.amazon.com/config) and AWS API calls to maintain an inventory of
64
-
resource data from imported accounts and Regions, then stores its findings in the data component. This runs every 15
65
-
minutes as a container task on [Amazon Elastic Container Service (Amazon ECS)](https://aws.amazon.com/ecs/) using the
66
-
[AWS Fargate](http://aws.amazon.com/fargate/) launch type. The discovery component container image is built in the
63
+
The discovery component uses [AWS Config](http://aws.amazon.com/config) and AWS API calls to maintain an inventory of
64
+
resource data from imported accounts and Regions, then stores its findings in the data component. This runs every 15
65
+
minutes as a container task on [Amazon Elastic Container Service (Amazon ECS)](https://aws.amazon.com/ecs/) using the
66
+
[AWS Fargate](http://aws.amazon.com/fargate/) launch type. The discovery component container image is built in the
67
67
image deployment component using [AWS CodePipeline](http://aws.amazon.com/codepipeline/) and [AWS CodeBuild](http://aws.amazon.com/codebuild/).
68
68
69
-
The cost component processes [AWS Cost and Usage Reports](https://docs.aws.amazon.com/cur/latest/userguide/what-is-cur.html)
70
-
(AWS CUR) to make cost data available in Workload Discovery. To use this feature, you must [create a report in AWS CUR](https://docs.aws.amazon.com/cur/latest/userguide/cur-create.html)
71
-
to deliver the reports to the ```CostAndUsageReportBucket``` Amazon S3 bucket. When an AWS CUR is delivered, it
72
-
triggers an [AWS Lambda](http://aws.amazon.com/lambda) function to trigger a AWS Glue Crawler that will update a
73
-
table ready for Amazon Athena to query. You can query these AWS CURs via the Workload Discovery UI. You can bring in cost
74
-
data from other accounts discoverable to Workload Discovery by setting up a AWS CUR and setting up replication between
69
+
The cost component processes [AWS Cost and Usage Reports](https://docs.aws.amazon.com/cur/latest/userguide/what-is-cur.html)
70
+
(AWS CUR) to make cost data available in Workload Discovery. To use this feature, you must [create a report in AWS CUR](https://docs.aws.amazon.com/cur/latest/userguide/cur-create.html)
71
+
to deliver the reports to the ```CostAndUsageReportBucket``` Amazon S3 bucket. When an AWS CUR is delivered, it
72
+
triggers an [AWS Lambda](http://aws.amazon.com/lambda) function to trigger a AWS Glue Crawler that will update a
73
+
table ready for Amazon Athena to query. You can query these AWS CURs via the Workload Discovery UI. You can bring in cost
74
+
data from other accounts discoverable to Workload Discovery by setting up a AWS CUR and setting up replication between
75
75
the S3 bucket in the discoverable account and the ```CostAndUsageReportBucket```
76
76
77
77
@@ -117,7 +117,7 @@ cd ./deployment
117
117
118
118
### Deploying a local build
119
119
120
-
When you have made changes to the code, you can build it locally and upload the deployment artefacts to Amazon S3 by
120
+
When you have made changes to the code, you can build it locally and upload the deployment artefacts to Amazon S3 by
121
121
editing and running the bash script referenced below.
122
122
123
123
#### Prerequistes
@@ -126,15 +126,15 @@ editing and running the bash script referenced below.
2. Edit the `local-deploy-script.sh` copy made in step 1. Substitute the value placeholders (marked with angle brackets)
137
-
with your own values, then save the script.
137
+
with your own values, then save the script.
138
138
3. Make the script executable
139
139
```chmod +x ./local-deploy-script.sh```
140
140
4. Run the script
@@ -148,7 +148,7 @@ This will:
148
148
149
149
#### Deploying the CloudFormation template
150
150
151
-
Once you have the deployment artefacts in S3, you can deploy the **workload-discovery-on-aws.template** in the CloudFormation
151
+
Once you have the deployment artefacts in S3, you can deploy the **workload-discovery-on-aws.template** in the CloudFormation
152
152
console. Just pass the link to the template in S3 to CloudFormation and it will do the rest.
153
153
154
154
Parameters required by the template:
@@ -162,21 +162,20 @@ Parameters required by the template:
162
162
***OpensearchInstanceType** - Select the instance type that will be provisioned for the Amazon ElasticSearch Domain.
163
163
***AthenaWorkgroup** - The Workgroup that will be used to issue the Athena query when the Cost feature is enabled.
164
164
***OpensearchMultiAz** - Choose whether to create an Opensearch cluster that spans multiple Availability Zone. Choosing Yes improves resilience; however, increases the cost of this solution.
165
-
165
+
166
166
**Note** - You will need to deploy in the same account and region as the S3 bucket that the deployment artefacts are uploaded to.
167
167
168
168
## Troubleshooting
169
-
If you encounter problems during or after the deployment of Workload Discovery, consult the [debugging flow](./debugging-flowchart.mmd) chart to help
169
+
If you encounter problems during or after the deployment of Workload Discovery, consult the [debugging flow](./debugging-flowchart.mmd) chart to help
170
170
diagnose and rectify common issues.
171
171
172
172
## License
173
173
174
174
See license [here](./LICENSE).
175
175
176
-
## Anonymized data collection
176
+
## Data collection
177
177
178
-
This solution collects anonymized operational metrics to help AWS improve the quality and features of the solution.
179
-
For more information, including how to disable this capability, please see the [Implementation Guide](https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/anonymized-data-collection.html).
178
+
This solution sends operational metrics to AWS (the “Data”) about the use of this solution. We use this Data to better understand how customers use this solution and related services and products. AWS’s collection of this Data is subject to the [AWS Privacy Notice](https://aws.amazon.com/privacy/).
0 commit comments