Version 1.0.1 release

Version 1.0.1 release

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is 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).
 
+## [1.0.1] - 2023-11-15
+
+### Fixed
+
+- Updated various README URLs to the correct values
+- Resolved an issue where the Aurora PostgresSQL cluster's version defaulted to 11 instead of 13 in some regions
+- Pinned Node and Python versions in Proton manifest.yml for every module
+
 ## [1.0.0] - 2023-09-05
 
 ### Added

setup.py

@@ -14,7 +14,7 @@
 
 setuptools.setup(
     name="connected-mobility-solution-on-aws",
-    version="1.0.0",
+    version="1.0.1",
     description="The administrative module to deploy all CMS modules and assets",
     long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",

source/backstage/README.md

@@ -2,18 +2,19 @@
 
 **[Connected Mobility Solution on AWS](https://aws.amazon.com/solutions/implementations/connected-mobility-solution-on-aws/)** | **[🚧 Feature request](https://github.com/aws-solutions/connected-mobility-solution-on-aws/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)** | **[🐛 Bug Report](https://github.com/aws-solutions/connected-mobility-solution-on-aws/issues/new?assignees=&labels=bug&template=bug_report.md&title=)** | **[❓ General Question](https://github.com/aws-solutions/connected-mobility-solution-on-aws/issues/new?assignees=&labels=question&template=general_question.md&title=)**
 
-**Note**: If you want to use the solution without building from source, navigate to the [AWS Solution Page](https://dummy.com).
+**Note**: If you want to use the solution without building from source, navigate to the
+[AWS Solution Page](https://aws.amazon.com/solutions/implementations/connected-mobility-solution-on-aws/).
 
 ## Table of Contents
 
 - [Connected Mobility Solution on AWS - Backstage Module](#connected-mobility-solution-on-aws---backstage-module)
   - [Table of Contents](#table-of-contents)
   - [Solution Overview](#solution-overview)
+  - [Architecture Diagram](#architecture-diagram)
   - [AWS CDK and Solutions Constructs](#aws-cdk-and-solutions-constructs)
   - [Customizing the Module](#customizing-the-module)
   - [Prerequisites](#prerequisites)
-    - [Optional but Helpful](#optional-but-helpful)
-    - [MacOS Installation Instructions](#macos-installation-instructions)
+      - [MacOS Installation Instructions](#macos-installation-instructions)
     - [Clone the Repository](#clone-the-repository)
     - [Unit Test](#unit-test)
     - [Build](#build)
@@ -33,7 +34,11 @@ and functional interface to manage and deploy software. CMS modules are configur
 deeper features into the Backstage design.
 
 For more information and a detailed deployment guide, visit the
-[CMS Backstage Module](https://aws.amazon.com/solutions/implementations/cms-backstage/) solution page.
+[CMS Backstage Module](https://docs.aws.amazon.com/solutions/latest/connected-mobility-solution-on-aws/backstage-module.html) solution page.
+
+## Architecture Diagram
+
+![CMS Backstage Architecture Diagram](./documentation/architecture/cms-backstage-architecture-diagram.svg)
 
 ## AWS CDK and Solutions Constructs
 
@@ -52,11 +57,12 @@ In addition to the AWS Solutions Constructs, the solution uses AWS CDK directly
 - [NVM](https://github.com/nvm-sh/nvm)
 - [NPM 8+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
 - [Node 18+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
-- [Pipenv](https://pipenv.pypa.io/en/latest/installation/)
+- [Pipenv](https://pipenv.pypa.io/en/latest/installation.html)
 
-#### Optional but Helpful
+Required For Local Development Only:
 
-- Pyenv [Github Repository](https://github.com/pyenv/pyenv)
+- [Docker](https://www.docker.com/products/docker-desktop/)
+- [Docker Compose v1](https://docs.docker.com/compose/install/) (v2 is included with Docker)
 
 #### MacOS Installation Instructions
 
@@ -148,19 +154,18 @@ Basic usage should stay within the free tier.
 
 ## Collection of Operational Metrics
 
-This solution collects anonymous operational metrics to help AWS improve the quality and features of the solution. For
-more information, including how to disable this capability, please see the
-[implementation guide](https://docs.aws.amazon.com/solutions/latest/cms-backstage/operational-metrics.html).
+This solution collects anonymous operational metrics to help AWS improve
+the quality and features of the solution. For more information, including
+how to disable this capability, please see the
+[implementation guide](https://docs.aws.amazon.com/solutions/latest/connected-mobility-solution-on-aws/operational-metrics.html).
 
 ## License
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License").
 You may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
+You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,

source/backstage/cdk/source/infrastructure/stacks/env.py

@@ -67,7 +67,9 @@ def __init__(self, scope: Any, stack_id: str) -> None:
         self.database = aws_rds.ServerlessCluster(
             self,
             "backstage-aurora-postgres",
-            engine=aws_rds.DatabaseClusterEngine.AURORA_POSTGRESQL,
+            engine=aws_rds.DatabaseClusterEngine.aurora_postgres(
+                version=aws_rds.AuroraPostgresEngineVersion.VER_13_9
+            ),
             parameter_group=self.parameter_group,
             credentials=pg_admin,
             vpc=vpc,

source/infrastructure/stacks/__init__.py

@@ -20,7 +20,7 @@ class CmsConstantsClass:
     MODULE_NAME: str = f"Connected-mobility-solution-on-aws-{STAGE}"
     SOLUTION_NAME: str = "Connected Mobility Solution on AWS"
     SOLUTION_ID: str = "SO0241"
-    SOLUTION_VERSION: str = "v1.0.0"
+    SOLUTION_VERSION: str = "v1.0.1"
     APPLICATION_TYPE: str = "AWS-Solutions"
     USER_AGENT_STRING: str = f"AWSSOLUTION/{SOLUTION_ID}/{SOLUTION_VERSION}"
 

templates/environments/cms_environment/v1/infrastructure/README.md

@@ -2,7 +2,7 @@
 
 **[Connected Mobility Solution on AWS](https://aws.amazon.com/solutions/implementations/connected-mobility-solution-on-aws/)** | **[🚧 Feature request](https://github.com/aws-solutions/connected-mobility-solution-on-aws/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)** | **[🐛 Bug Report](https://github.com/aws-solutions/connected-mobility-solution-on-aws/issues/new?assignees=&labels=bug&template=bug_report.md&title=)** | **[❓ General Question](https://github.com/aws-solutions/connected-mobility-solution-on-aws/issues/new?assignees=&labels=question&template=general_question.md&title=)**
 
-**Note**: If you want to use the solution without building from source, navigate to the [AWS Solution Page](https://dummy.com).
+**Note**: If you want to use the solution without building from source, navigate to the [AWS Solution Page](https://aws.amazon.com/solutions/implementations/connected-mobility-solution-on-aws/).
 
 ## Table of Contents
 - [Connected Mobility Solution on AWS - Environment](#connected-mobility-solution-on-aws---environment)
@@ -24,19 +24,18 @@ List of functionality
 
 ## Collection of Operational Metrics
 
-This solution collects anonymous operational metrics to help AWS improve the quality and features of the solution. For
-more information, including how to disable this capability, please see the
-[implementation guide](https://docs.aws.amazon.com/solutions/latest/cms-environmentr/operational-metrics.html).
+This solution collects anonymous operational metrics to help AWS improve
+the quality and features of the solution. For more information, including
+how to disable this capability, please see the
+[implementation guide](https://docs.aws.amazon.com/solutions/latest/connected-mobility-solution-on-aws/operational-metrics.html).
 
 ## License
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License").
 You may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
+You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,

templates/environments/cms_environment/v1/infrastructure/source/config/constants.py

@@ -15,7 +15,7 @@ class EnvironmentConstantsClass:
     MODULE_NAME: str = "cms-environment-on-aws"
     SOLUTION_NAME: str = "Connected Mobility Solution on AWS"
     SOLUTION_ID: str = "SO0241"
-    SOLUTION_VERSION: str = "v1.0.0"
+    SOLUTION_VERSION: str = "v1.0.1"
     APPLICATION_TYPE: str = "AWS-Solutions"
     CAPABILITY_ID = "CMS.6"
     USER_AGENT_STRING: str = f"AWSSOLUTION/{SOLUTION_ID}/{SOLUTION_VERSION} AWSSOLUTION-CAPABILITY/{CAPABILITY_ID}/{SOLUTION_VERSION}"

templates/modules/cms_alerts_on_aws/v1/instance_infrastructure/README.md

@@ -2,7 +2,7 @@
 
 **[Connected Mobility Solution on AWS](https://aws.amazon.com/solutions/implementations/connected-mobility-solution-on-aws/)** | **[🚧 Feature request](https://github.com/aws-solutions/connected-mobility-solution-on-aws/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)** | **[🐛 Bug Report](https://github.com/aws-solutions/connected-mobility-solution-on-aws/issues/new?assignees=&labels=bug&template=bug_report.md&title=)** | **[❓ General Question](https://github.com/aws-solutions/connected-mobility-solution-on-aws/issues/new?assignees=&labels=question&template=general_question.md&title=)**
 
-**Note**: If you want to use the solution without building from source, navigate to the [AWS Solution Page](https://dummy.com).
+**Note**: If you want to use the solution without building from source, navigate to the [AWS Solution Page](https://aws.amazon.com/solutions/implementations/connected-mobility-solution-on-aws/).
 
 ## Table of Contents
 - [Connected Mobility Solution on AWS - Alerts Module](#connected-mobility-solution-on-aws---alerts-module)
@@ -12,7 +12,6 @@
   - [AWS CDK and Solutions Constructs](#aws-cdk-and-solutions-constructs)
   - [Customizing the Module](#customizing-the-module)
   - [Prerequisites](#prerequisites)
-      - [Optional but Helpful](#optional-but-helpful)
       - [MacOS Installation Instructions](#macos-installation-instructions)
     - [Clone the Repository](#clone-the-repository)
     - [Unit Test](#unit-test)
@@ -42,15 +41,13 @@ In addition to the AWS Solutions Constructs, the solution uses AWS CDK directly
 
 ## Prerequisites
 
-- Python 3.8+
-- NVM
-- NPM 8+
-- Node 18+
-- Pipenv
+- [Python 3.8+](https://www.python.org/downloads/)
+- [NVM](https://github.com/nvm-sh/nvm)
+- [NPM 8+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- [Node 18+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- [Pipenv](https://pipenv.pypa.io/en/latest/installation.html)
 
-#### Optional but Helpful
-
-- Pyenv
+#### MacOS Installation Instructions
 
 Pyenv [Github Repository](https://github.com/pyenv/pyenv)
 
@@ -59,13 +56,6 @@ brew install pyenv
 pyenv install 3.10.9
 ```
 
-#### MacOS Installation Instructions
-
-```bash
-brew install pyenv
-pyenv install 3.10.9
-```
-
 Pipenv [Github Repository](https://github.com/pypa/pipenv)
 
 ```bash
@@ -154,19 +144,18 @@ Basic usage should stay within the free tier.
 
 ## Collection of Operational Metrics
 
-This solution collects anonymous operational metrics to help AWS improve the quality and features of the solution. For
-more information, including how to disable this capability, please see the
-[implementation guide](https://docs.aws.amazon.com/solutions/latest/cms-provisioningr/operational-metrics.html).
+This solution collects anonymous operational metrics to help AWS improve
+the quality and features of the solution. For more information, including
+how to disable this capability, please see the
+[implementation guide](https://docs.aws.amazon.com/solutions/latest/connected-mobility-solution-on-aws/operational-metrics.html).
 
 ## License
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License").
 You may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
+You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,

templates/modules/cms_alerts_on_aws/v1/instance_infrastructure/manifest.yaml

@@ -5,13 +5,15 @@ infrastructure:
     - rendering_engine: codebuild
       settings:
         image: aws/codebuild/amazonlinux2-x86_64-standard:5.0
-        runtimes:
-          nodejs: 18
         provision:
           # Run when create/update is triggered for environment or service
           # Install dependencies
+          - n 18.17.1
           - npm install -g aws-cdk@latest --force
-          - pipenv install --dev
+          - pyenv install 3.10.9
+          - pyenv global 3.10.9
+          - pyenv exec pip install pipenv
+          - pipenv install --dev --python 3.10.9
           - pipenv run cdk deploy --require-approval never
 
           # Script to convert CFN outputs into outputs for Proton
@@ -24,6 +26,10 @@ infrastructure:
           # add the following to the above command if there are outputs: --outputs file://./outputs.json
         deprovision:
           # Install dependencies and destroy resources
+          - n 18.17.1
           - npm install -g aws-cdk@latest --force
-          - pipenv install --dev
+          - pyenv install 3.10.9
+          - pyenv global 3.10.9
+          - pyenv exec pip install pipenv
+          - pipenv install --dev --python 3.10.9
           - pipenv run cdk destroy --force

templates/modules/cms_alerts_on_aws/v1/instance_infrastructure/source/config/constants.py

@@ -15,7 +15,7 @@ class AlertsConstantsClass:
     MODULE_NAME: str = "cms-alerts-on-aws"
     SOLUTION_NAME: str = "Connected Mobility Solution on AWS"
     SOLUTION_ID: str = "SO0241"
-    SOLUTION_VERSION: str = "v1.0.0"
+    SOLUTION_VERSION: str = "v1.0.1"
     APPLICATION_TYPE: str = "AWS-Solutions"
     CAPABILITY_ID = "CMS.10"
     USER_AGENT_STRING: str = f"AWSSOLUTION/{SOLUTION_ID}/{SOLUTION_VERSION} AWSSOLUTION-CAPABILITY/{CAPABILITY_ID}/{SOLUTION_VERSION}"

templates/modules/cms_alerts_on_aws/v1/instance_infrastructure/source/tests/infrastructure/__snapshots__/test_snapshot/test_cms_alerts_on_aws_snapshot.json

@@ -147,7 +147,7 @@
             "TOKEN_VALIDATION_LAMBDA_ARN": {
               "Ref": "cmsalertsmoduleinputsconstructssmtokenvalidationlambdaarnParameter1CA960BF"
             },
-            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.0 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.0"
+            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.1 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.1"
           }
         },
         "FunctionName": "cms-alerts-on-aws-stack-dev-authorization-lambda",
@@ -373,7 +373,7 @@
           "ApplicationType": "AWS-Solutions",
           "SolutionID": "SO0241",
           "SolutionName": "Connected Mobility Solution on AWS",
-          "Version": "v1.0.0"
+          "Version": "v1.0.1"
         },
         "Description": "Attribute group for solution information",
         "Name": {
@@ -944,7 +944,7 @@
               "Ref": "cmsalertsnotificationconstructnotificationstable6C23B163"
             },
             "SNS_TOPIC_PREFIX": "CMS",
-            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.0 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.0"
+            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.1 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.1"
           }
         },
         "FunctionName": "cms-alerts-on-aws-stack-dev-create-alerts-lambda",
@@ -1559,7 +1559,7 @@
             "DEPLOYMENT_UUID": {
               "Ref": "deploymentuuidParameter"
             },
-            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.0 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.0"
+            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.1 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.1"
           }
         },
         "FunctionName": "cms-alerts-on-aws-stack-dev-send-notifications-lambda",
@@ -1818,7 +1818,7 @@
             "ALERTS_SNS_TOPIC_ARN": {
               "Ref": "cmsalertssnstosqsconstructsnstopic5DB29F7E"
             },
-            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.0 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.0"
+            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.1 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.1"
           }
         },
         "FunctionName": "cms-alerts-on-aws-stack-dev-publish-lambda",
@@ -2411,7 +2411,7 @@
               "Ref": "cmsalertsusersubscriptionsconstructusersubscriptiontopicgeneralkeyD95E7C20"
             },
             "SNS_TOPIC_PREFIX": "CMS",
-            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.0 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.0",
+            "USER_AGENT_STRING": "AWSSOLUTION/SO0241/v1.0.1 AWSSOLUTION-CAPABILITY/CMS.10/v1.0.1",
             "USER_EMAIL_SUBSCRIPTIONS_TABLE": {
               "Ref": "cmsalertsusersubscriptionsconstructuseremailsubscriptionstableA74BB966"
             }