Merge pull request #656 from aws-solutions/develop

Update to v5.4.5

CHANGELOG.md

@@ -5,11 +5,15 @@ 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).
 
+## [5.4.5] - 2023-11-1
+### Updated
+- Security patch for browserify-sign
+
 ## [5.4.4] - 2023-10-24
- ### Updated
- - Security patch for urllib3
+### Updated
+- Security patch for urllib3
 
- ### Fixed
+### Fixed
 - Fixed fulfillment throws an exception when a Preprocessing Lambda Hook is configured([issue #651](https://github.com/aws-solutions/qnabot-on-aws/issues/651))
 - Improved error handling
 

README.md

@@ -119,6 +119,66 @@ Refer to [CHANGELOG.md](CHANGELOG.md) file for details of new features in each v
 
 A [workshop](https://qnabot.workshop.aws) is also available that walks you through QnABot features.
 
+## QnABot Deployable Solution Versions
+
+As QnABot evolves over the years, it makes use of various services and functionality which may go in and out of support. This section serves as a reference to the deployable solution versions along with links to their Public and VPC CloudFormation templates.
+
+_Note: **Deployable solution versions** refers to the ability to deploy the version of QnABot in their AWS accounts. **Actively supported versions** for QnABot is only available for the latest version of QnABot._
+
+### Deployable Versions
+
+- [v5.4.5](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.4.5) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.5/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.5/qnabot-on-aws-vpc.template)
+  - _For those upgrading from `v5.4.X` to later versions, if you are upgrading from a deployment with LLMApi set to SAGEMAKER then set this value to DISABLED before upgrading. After upgrading, return this value back to SAGEMAKER.._
+- [v5.4.4](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.4.4) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.4/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.4/qnabot-on-aws-vpc.template)
+- [v5.4.3](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.4.3) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.3/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.3/qnabot-on-aws-vpc.template)
+  - _We do not recommend to use this version due to a potential issue with the testall functionality which may introduce a high number of versions stored in the testall S3 bucket. Please use the latest version available or v5.4.4+_
+- [v5.4.2](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.4.2) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.2/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.2/qnabot-on-aws-vpc.template)
+  - _We do not recommend to use this version due to a potential issue with the testall functionality which may introduce a high number of versions stored in the testall S3 bucket. Please use the latest version available or v5.4.4+_
+- [v5.4.1](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.4.1) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.1/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.1/qnabot-on-aws-vpc.template)
+- [v5.4.0](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.4.0) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.0/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.4.0/qnabot-on-aws-vpc.template)
+  - _Note: Lambda Runtimes have been updated this release. Solution now uses: [nodejs18 and python3.10]_
+- [v5.3.4](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.3.4) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.4/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.4/qnabot-on-aws-vpc.template)
+- [v5.3.3](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.3.3) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.3/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.3/qnabot-on-aws-vpc.template)
+- [v5.3.2](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.3.2) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.2/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.2/qnabot-on-aws-vpc.template)
+- [v5.3.1](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.3.1) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.1/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.1/qnabot-on-aws-vpc.template)
+- [v5.3.0](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.3.0) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.0/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.3.0/qnabot-on-aws-vpc.template)
+- [v5.2.7](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.2.7) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.7/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.7/qnabot-on-aws-vpc.template)
+- [v5.2.6](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.2.6) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.6/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.6/qnabot-on-aws-vpc.template)
+- [v5.2.5](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.2.5) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.5/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.5/qnabot-on-aws-vpc.template)
+- [v5.2.4](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.2.4) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.4/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.4/qnabot-on-aws-vpc.template)
+- [v5.2.3](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.2.3) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.3/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.3/qnabot-on-aws-vpc.template)
+- [v5.2.2](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.2.2) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.2/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.2/qnabot-on-aws-vpc.template)
+- [v5.2.1](https://github.com/aws-solutions/qnabot-on-aws/releases/tag/v5.2.1) - [Public](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.1/qnabot-on-aws-main.template)/[VPC](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/v5.2.1/qnabot-on-aws-vpc.template)
+  - _Note: Lambda Runtimes have been updated this release. Solution now uses: [nodejs16 and python3.9]_
+
+### Undeployable Versions
+- All solutions less than `v5.2.1` are no longer deployable due to Lambda Runtime deprecations.
+- **Upcoming/Recent deprecations**
+  - nodejs16 will enter [Phase 1 deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy) on Mar 11, 2024.
+
+### Why would a solution version no longer be deployable?
+For QnABot, the most common reason is due to [AWS Lambda Runtimes being deprecated](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy). When a Lambda runtime has been marked as deprecated, customers can no longer create new Lambda functions in their AWS account. This means that older versions of our solutions that make use of those runtimes will fail to deploy. This makes it hard for the community to provide support as we are unable to deploy a similar environment to investigate issues and reproduce bug reports.
+
+### What should I do if my version of the solution is no longer deployable?
+If you've currently got an existing deployment working for you, there is nothing requiring you to update. However, it is **_strongly_** recommended that you build a plan to test and migrate production deployments to a supported version. The further away a deployment gets from `latest` the greater risk it is at to experiencing instability (especially with regards to deployment).
+
+And for those looking to get started with the solution for the first time, it is always recommended you use the latest version. It is the most secure, stable, and feature-rich version of QnABot!
+
+### How do I update my solution version?
+In most cases, a simple [Update Stack operation](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/update-the-solution.html) should allow you to migrate your instance onto a newer version while maintaining your data on the new deployment.
+
+> Note: For those upgrading from `v5.4.X` to later versions, if you are upgrading from a deployment with LLMApi set to SAGEMAKER then set this value to DISABLED before upgrading. After upgrading, return this value back to SAGEMAKER.
+
+The team _**strongly**_ recommends that any upgrades (especially between minor/major versions) first be tested on a non-production instance to check for any regressions. This is critical if you have made custom modifications to your deployment, integrate with external services, or are jumping between multiple versions.
+
+Some additional precautions you can take are:
+
+ - export all of your questions using the Content Designer UI ([instructions](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/use-qnabot-on-aws.html#importing-and-exporting-chatbot-answers))
+ - export all of your settings using the Content Designer UI (click `Export Settings` at the bottom of settings page)
+ - backup DynamoDB table ([instructions](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/amazon-dynamodb-backups.html)) 
+ - create a manual snapshot of your OpenSearch Domain ([instructions](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-snapshots.html))
+
+ ---
 ## Anonymous Metrics
 This solution collects anonymous operational metrics to help AWS improve the
 quality of features of the solution. For more information, including how to disable

lambda/aws-sdk-layer/package.json

@@ -1,6 +1,6 @@
 {
     "name": "aws-layer",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot Lambda aws-sdk-layer",
     "main": "index.js",
     "scripts": {

lambda/cfn-lambda-layer/package.json

@@ -1,6 +1,6 @@
 {
     "name": "cfn-lambda-layer",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot Cfn Lambda Layer",
     "main": "index.js",
     "scripts": {

lambda/cfn/package.json

@@ -1,6 +1,6 @@
 {
     "name": "cfn",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot Cfn Lambda",
     "main": "index.js",
     "scripts": {

lambda/common-modules-layer/package.json

@@ -1,6 +1,6 @@
 {
     "name": "common-modules-layer",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot Common-modules-layer lambda",
     "main": "index.js",
     "scripts": {

lambda/connect/package.json

@@ -1,6 +1,6 @@
 {
     "name": "connect",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "Lambda function used to support the Connect setup wizard",
     "repository": {
         "type": "git",

lambda/es-proxy-layer/package.json

@@ -1,6 +1,6 @@
 {
     "name": "proxy-es",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot Lambda managing querying of data store",
     "main": "index.js",
     "author": {

lambda/export/package.json

@@ -1,6 +1,6 @@
 {
     "name": "import",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot Lambda handling export of QIDs",
     "main": "index.js",
     "author": {

lambda/fulfillment/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fulfillment",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot Lambda handling fulfillment of user requests",
     "main": "handler.js",
     "scripts": {

lambda/genesys/package.json

@@ -1,6 +1,6 @@
 {
     "name": "genesys",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "Lambda function used to support the Genesys setup wizard",
     "repository": {
         "type": "git",

lambda/import/package.json

@@ -1,6 +1,6 @@
 {
     "name": "import",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot Lambda handling import of QIDs",
     "main": "index.js",
     "scripts": {

lambda/js_lambda_hook_sdk/package.json

@@ -1,6 +1,6 @@
 {
     "name": "js_lambda_hook_sdk",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot convienience layer, allowing users to create custom lambda hooks",
     "directories": {
         "lambda_hook_sdk": "lambda_hook_sdk",

lambda/lex-build/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lex-build",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot lambda for rebuilding Amazon Lex bots",
     "main": "handler.js",
     "scripts": {

lambda/proxy-es/package.json

@@ -1,6 +1,6 @@
 {
     "name": "proxy-es",
-    "version": "5.4.4",
+    "version": "5.4.5",
     "description": "QnABot Lambda function is used to proxy request from apigateway to elasticsearch",
     "main": "index.js",
     "author": {