Merge pull request #493 from aws-solutions/v2.1.3

update to v2.1.3

Author: svozza

CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project are documented in this file.
 Based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.3] - 2023-12-18
+
+### Fixed
+
+- Rate Limited Exceeded in ORGANIZATIONS mode [478](https://github.com/aws-solutions/workload-discovery-on-aws/issues/478)
+- Incorrect status displayed for EC2 instances, load balancers, databases and lambda functions [483](https://github.com/aws-solutions/workload-discovery-on-aws/issues/483)
+- Missing resource type icons [485](https://github.com/aws-solutions/workload-discovery-on-aws/issues/485)
+- Comma in Service Name Results in Cost Feature sum of account to be 0 [489](https://github.com/aws-solutions/workload-discovery-on-aws/issues/489)
+- "Load Cost" and "Cost Report" buttons are using different time spans by default, but showing the sameone in the UI [490](https://github.com/aws-solutions/workload-discovery-on-aws/issues/490)
+- Comma in Service Name Results causes GraphQL type error [491](https://github.com/aws-solutions/workload-discovery-on-aws/issues/491)
+
+### Changed
+- Frequency at which the scheduled discovery process ECS task runs is now configurable via a CloudFormation parameter. 
+
 ## [2.1.2] - 2023-11-14
 
 ### Fixed
@@ -14,7 +28,7 @@ in large organisation. [478](https://github.com/aws-solutions/workload-discovery
 - Only attempt to discover accounts from provided OU and its children, rather than whole organization.
 - Throttle `SelectAggregateResourceConfig` API to prevent rate limiting from stopping discovery process from reading from the Config aggregator.
 - Remove Retain on organization-wide StackSet so IAM roles are no longer left in organization's accounts after solution is uninstalled.
-- Handle error message difference between AppSync VTL resolvers and JS resolvers that prevented  discovery process from retrying 
+- Handle error message difference between AppSync VTL resolvers and JS resolvers that prevented discovery process from retrying 
 requests to DB if payload was too large.
 
 ### Changed
@@ -28,7 +42,7 @@ and `BatchGetAggregateResourceConfig`.
   - `AWS::EC2::TransitGatewayRouteTable`
   - `AWS::Kinesis::Stream`
   - `AWS::MSK::Cluster`
-- Ensure OAC name length does exceed 64 characters. [462](https://github.com/aws-solutions/workload-discovery-on-aws/issues/462)
+- Ensure OAC name length does not exceed 64 characters. [462](https://github.com/aws-solutions/workload-discovery-on-aws/issues/462)
 - No longer ingest resources with status `ResourceNotRecorded`.
 - Improve performance of `getResourceChanges` function in Discovery process from O(n<sup>2</sup>) to O(n).
 - Retrieve account metadata on frontend in batches of 50.

NOTICE.txt

@@ -47,6 +47,7 @@ py-serializable
 @aws-sdk/client-sts
 @aws-sdk/credential-providers
 @aws-sdk/lib-dynamodb
+@smithy/util-retry
 @aws-sdk/util-arn-parser
 @cloudscape-design/collection-hooks
 @cloudscape-design/components
@@ -57,8 +58,10 @@ py-serializable
 **********************
 MIT License
 **********************
+add
 pip
-cfn-nag 
+cfn-nag
+csv-parse
 uuid 
 material-ui 
 browserslist

README.md

@@ -1,4 +1,4 @@
-# Workload Discovery on AWS (v2.1.2)
+# Workload Discovery on AWS (v2.1.3)
 
 Workload Discovery on AWS is a tool that quickly visualizes AWS Cloud workloads as architecture diagrams. 
 You can use the solution to build, customize, and share detailed workload visualizations based on live data from AWS. 
@@ -165,6 +165,10 @@ Parameters required by the template:
 
 **Note** - You will need to deploy in the same account and region as the S3 bucket that the deployment artefacts are uploaded to.
 
+## Troubleshooting
+If you encounter problems during or after the deployment of Workload Discovery, consult the [debugging flow](./debugging-flowchart.mmd) chart to help 
+diagnose and rectify common issues.
+
 ## License
 
 See license [here](./LICENSE.txt).

debugging-flowchart.mmd

@@ -0,0 +1,72 @@
+flowchart TD
+    A(Deploy
+    CloudFormation Template)
+A --> B{Was deployment
+successful?}
+B -->|Yes| C{What cross
+account discovery
+mode is being
+used?}
+B -->|No| D{Were deployment
+<u><a href='https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/deployment-process-overview.html'>pre-requisites</a></u>
+checked?}
+D -->|Yes| E[Retrieve errors from
+CloudFormation console.
+NB: the error from the
+main stack is insufficent,
+retrieve the error from
+the first nested stack
+failed.]
+D -->|No| F[Follow instructions
+in <u><a href='https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/deployment-process-overview.html'>pre-requisites</a></u>
+documentation]
+F --> A
+C -->|SELF_MANAGED| G{Has the required
+CloudFormation been deployed
+in the accounts and regions
+to be discovered as per the
+<u><a href='https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/deployment-process-overview.html'>documention</a></u>?}
+G --> |No| I[Deploy the global resources
+template exacty once in each
+account and the regional
+template in every region as
+<u><a href='https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/import-a-region.html'>documented</a></u>.]
+G --> |Yes| UiErrors{Are there errors dispalyed in the UI}
+UiErrors --> |Yes| GetUiLogs[Retrieve any browser errors
+using the browser dev tools.]
+C -->|AWS_ORGANIZATIONS| UiErrors
+UiErrors --> |No| MissingResources{Are there resource types
+<u><a href='https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/supported-resources-1.html'>supported by WD</a></u>
+that are missing and that are
+known to be deployed in
+the target accounts?}
+OutOfMemory --> |No| DbCpuStats{Do either the Neptune
+or Opensearch DBs
+have abnormally high
+CPU spikes? Verify by following
+<u><a href='https://aws-solutions.github.io/workload-discovery-on-aws/workload-discovery-on-aws/2.0/scaling-the-discovery-process.html#_prerequisites'>the pre-requisite steps</a></u>.}
+DbCpuStats ---> |No| GetEcsLogs[Retrieve the logs for the
+discovery process running
+in ECS as per
+<u><a href='https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/deployment-process-overview.html'>the documention</a></u>.]
+DbCpuStats ---> |Yes| ScaleDbs[Increase the instance
+size of the DBs
+through CloudFormation
+as per the
+<u><a href='https://aws-solutions.github.io/workload-discovery-on-aws/workload-discovery-on-aws/2.0/scaling-the-discovery-process.html#_increasing_the_database_instance_sizes'>the documention</a></u>.]
+ScaleDbs --> A
+OutOfMemory --> |Yes| L[Increase the memory of
+the discovery task
+by updating the Memory
+parameter in
+CloudFormation as per
+<u><a href='https://docs.aws.amazon.com/solutions/latest/workload-discovery-on-aws/launch-the-stack.html'>the documentation</a></u>.]
+L --> A
+MissingResources ----> |No| UiProblem[Describe the problem you are
+seeing and the steps to reproduce]
+MissingResources --> |Yes| OutOfMemory[Are there out of memory
+errors for the discovery
+process running in ECS?
+Verify by following
+<u><a href='https://aws-solutions.github.io/workload-discovery-on-aws/workload-discovery-on-aws/2.0/scaling-the-discovery-process.html#_prerequisites_2'>the pre-requisite steps</a></u>.]
+