docs: update post-upgrading in upgrade page

[dengmingtong]

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Summary

update docs for post upgrading actions

Implementation highlights

(describe how the merge request does for feature changes, share the RFC link if it has)

Test checklist

• add new test cases
• all code changes are covered by unit tests
• end-to-end tests
  • deploy web console with CloudFront + S3 + API gateway
  • deploy web console within VPC
  • deploy ingestion server
    • with MSK sink
    • with KDS sink
    • with S3 sink
  • deploy data processing
  • deploy data modeling
    • new Redshift Serverless
    • provisioned Redshift
    • Athena
  • deploy with reporting
  • streaming ingestion
    • with Redshift Serverless
    • with provisioned Redshift

Is it a breaking change

• add parameters without default value in stack
• introduce new service permission in stack
• introduce new top level stack module

Miscellaneous

• introduce new symbol link source file(s) to be shared among infra code, web console frontend, and web console backend

[github-actions]

Etl common library's test coverage

Overall Project	93.55%	🍏

There is no coverage information present for the Files changed

[github-actions]

Streaming ingestion flink application's test coverage

Overall Project	93.82%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	98.15%	🍏

There is no coverage information present for the Files changed

[aws-solution-clickstream-analytics]

SonarQube Quality Gate Result

• Result: ✅ OK
• Triggered by @dengmingtong on pull_request

Metric	Status	Value	Error Threshold
Reliability rating	✅ OK	1	> 1
Security rating	✅ OK	1	> 1
Sqale rating	✅ OK	1	> 1
Coverage	✅ OK	83.70	< 80
Duplicated lines density	✅ OK	8.60	> 30
Blocker violations	✅ OK	0	> 0
Bugs	✅ OK	0	> 0
Code smells	✅ OK	10	> 40
Critical violations	✅ OK	0	> 0
Major violations	✅ OK	0	> 0
Vulnerabilities	✅ OK	0	> 0

View on SonarQube

updated: 8/17/2024, 04:05:28 (UTC+0)

[aws-solution-clickstream-analytics]

SonarQube Code Analytics

Quality Gate passed

Additional information

The following metrics might not affect the Quality Gate status but improving them will improve your project code quality.

Issues

0 Bugs

0 Vulnerabilities

0 Code Smells

Coverage and Duplications

No data Coverage

No data Duplication

[github-actions]

Etl common library's test coverage

Overall Project	93.55%	🍏

There is no coverage information present for the Files changed

[github-actions]

Streaming ingestion flink application's test coverage

Overall Project	93.82%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	98.15%	🍏

There is no coverage information present for the Files changed

[aws-solution-clickstream-analytics]

SonarQube Quality Gate Result

• Result: ✅ OK
• Triggered by @dengmingtong on pull_request

Metric	Status	Value	Error Threshold
Reliability rating	✅ OK	1	> 1
Security rating	✅ OK	1	> 1
Sqale rating	✅ OK	1	> 1
Coverage	✅ OK	83.70	< 80
Duplicated lines density	✅ OK	8.60	> 30
Blocker violations	✅ OK	0	> 0
Bugs	✅ OK	0	> 0
Code smells	✅ OK	10	> 40
Critical violations	✅ OK	0	> 0
Major violations	✅ OK	0	> 0
Vulnerabilities	✅ OK	0	> 0

View on SonarQube

updated: 8/19/2024, 07:06:04 (UTC+0)

[github-actions]

Etl common library's test coverage

Overall Project	93.55%	🍏

There is no coverage information present for the Files changed

[github-actions]

Streaming ingestion flink application's test coverage

Overall Project	93.82%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	98.15%	🍏

There is no coverage information present for the Files changed

[aws-solution-clickstream-analytics]

SonarQube Quality Gate Result

• Result: ✅ OK
• Triggered by @dengmingtong on pull_request

Metric	Status	Value	Error Threshold
Reliability rating	✅ OK	1	> 1
Security rating	✅ OK	1	> 1
Sqale rating	✅ OK	1	> 1
Coverage	✅ OK	83.70	< 80
Duplicated lines density	✅ OK	8.60	> 30
Blocker violations	✅ OK	0	> 0
Bugs	✅ OK	0	> 0
Code smells	✅ OK	10	> 40
Critical violations	✅ OK	0	> 0
Major violations	✅ OK	0	> 0
Vulnerabilities	✅ OK	0	> 0

View on SonarQube

updated: 8/20/2024, 08:29:21 (UTC+0)

[github-actions]

Etl common library's test coverage

Overall Project	93.55%	🍏

There is no coverage information present for the Files changed

[github-actions]

Streaming ingestion flink application's test coverage

Overall Project	93.82%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	98.15%	🍏

There is no coverage information present for the Files changed

[github-actions]

Package	Line Rate	Branch Rate	Health
src	100%	88%	✔
src.analytics	100%	100%	✔
src.analytics.lambdas	92%	88%	✔
src.analytics.lambdas.clear-expired-events-workflow	100%	100%	✔
src.analytics.lambdas.custom-resource	96%	87%	✔
src.analytics.lambdas.load-data-workflow	99%	90%	✔
src.analytics.lambdas.refresh-materialized-views-workflow	96%	88%	✔
src.analytics.lambdas.scan-metadata-workflow	97%	88%	✔
src.analytics.lambdas.sql-execution-sfn	93%	60%	✔
src.analytics.lambdas.user-segments-workflow	96%	79%	✔
src.analytics.private	100%	92%	✔
src.analytics.private.athena	100%	100%	✔
src.analytics.private.segments	100%	100%	✔
src.base-lib.src	100%	100%	✔
src.base-lib.src.auth	89%	65%	✔
src.base-lib.src.common	97%	81%	✔
src.base-lib.src.constant	100%	100%	✔
src.base-lib.src.model	100%	100%	✔
src.common	98%	79%	✔
src.common.lambda	97%	86%	✔
src.control-plane	99%	71%	✔
src.control-plane.auth	93%	12%	✔
src.control-plane.backend	100%	84%	✔
src.control-plane.backend.lambda.api	97%	33%	✔
src.control-plane.backend.lambda.api.common	92%	80%	✔
src.control-plane.backend.lambda.api.middle-ware	88%	79%	✔
src.control-plane.backend.lambda.api.model	95%	52%	✔
src.control-plane.backend.lambda.api.router	98%	97%	✔
src.control-plane.backend.lambda.api.service	86%	68%	✔
src.control-plane.backend.lambda.api.service.quicksight	93%	82%	✔
src.control-plane.backend.lambda.api.service.segments	95%	74%	✔
src.control-plane.backend.lambda.api.store.aws	87%	57%	✔
src.control-plane.backend.lambda.api.store.dynamodb	90%	79%	✔
src.control-plane.backend.lambda.api.test.api	99%	83%	✔
src.control-plane.backend.lambda.api.test.api.segments	100%	100%	✔
src.control-plane.backend.lambda.batch-insert-ddb	94%	86%	✔
src.control-plane.backend.lambda.listen-stack-status	81%	49%	✔
src.control-plane.backend.lambda.listen-state-status	91%	50%	✔
src.control-plane.backend.lambda.sfn-action	88%	50%	✔
src.control-plane.backend.lambda.sfn-workflow	74%	68%	➖
src.control-plane.backend.layer.lambda-web-adapter	98%	40%	✔
src.control-plane.private	100%	100%	✔
src.data-pipeline	100%	100%	✔
src.data-pipeline.lambda.copy-assets	97%	90%	✔
src.data-pipeline.lambda.emr-job-state-listener	97%	92%	✔
src.data-pipeline.lambda.emr-job-submitter	94%	76%	✔
src.data-pipeline.lambda.emr-serverless-app	96%	86%	✔
src.data-pipeline.lambda.init-app-config	100%	82%	✔
src.data-pipeline.lambda.partition-syncer	98%	89%	✔
src.data-pipeline.tables	100%	100%	✔
src.data-pipeline.utils	100%	94%	✔
src.ingestion-server.common-resources	100%	71%	✔
src.ingestion-server.custom-resource	100%	100%	✔
src.ingestion-server.custom-resource.delete-ecs-cluster	98%	90%	✔
src.ingestion-server.custom-resource.update-alb-rules	90%	74%	✔
src.ingestion-server.kafka-s3-connector	100%	100%	✔
src.ingestion-server.kafka-s3-connector.custom-resource.kafka-s3-sink-connector	96%	82%	✔
src.ingestion-server.kinesis-data-stream	100%	100%	✔
src.ingestion-server.kinesis-data-stream.kinesis-to-s3-lambda	100%	100%	✔
src.ingestion-server.kinesis-data-stream.private	100%	100%	✔
src.ingestion-server.server	98%	89%	✔
src.ingestion-server.server-v2	100%	95%	✔
src.ingestion-server.server-v2.private	99%	84%	✔
src.ingestion-server.server.private	100%	90%	✔
src.metrics	100%	100%	✔
src.metrics.custom-resource.add-sns-subscription	95%	86%	✔
src.metrics.custom-resource.get-interval	99%	97%	✔
src.metrics.custom-resource.put-dashboard	97%	84%	✔
src.metrics.custom-resource.set-metrics-widgets	98%	93%	✔
src.private	96%	73%	✔
src.reporting	100%	82%	✔
src.reporting.lambda.custom-resource.quicksight	94%	81%	✔
src.reporting.private	90%	54%	✔
src.streaming-ingestion	100%	100%	✔
src.streaming-ingestion.lambdas.custom-resource	86%	63%	✔
src.streaming-ingestion.private	99%	89%	✔
src.streaming-ingestion.redshift	100%	100%	✔
test	96%	83%	✔
test.common	93%	100%	✔
test.control-plane	97%	64%	✔
test.ingestion-server.server	97%	88%	✔
Summary	96% (79386 / 82785)	75% (6839 / 9172)	✔

Minimum allowed line rate is 60%

[aws-solution-clickstream-analytics]

SonarQube Quality Gate Result

• Result: ✅ OK
• Triggered by @dengmingtong on pull_request

Metric	Status	Value	Error Threshold
Reliability rating	✅ OK	1	> 1
Security rating	✅ OK	1	> 1
Sqale rating	✅ OK	1	> 1
Coverage	✅ OK	83.80	< 80
Duplicated lines density	✅ OK	8.60	> 30
Blocker violations	✅ OK	0	> 0
Bugs	✅ OK	0	> 0
Code smells	✅ OK	10	> 40
Critical violations	✅ OK	0	> 0
Major violations	✅ OK	0	> 0
Vulnerabilities	✅ OK	0	> 0

View on SonarQube

updated: 8/21/2024, 02:35:25 (UTC+0)