-
Notifications
You must be signed in to change notification settings - Fork 249
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #744 from aws-solutions/feature/v6.0.1
Feature/v6.0.1
- Loading branch information
Showing
71 changed files
with
682 additions
and
270 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
# In-place upgrade of QnABot | ||
|
||
If you have previously deployed the solution and want to perform in-place upgrade, please refer to [Update the solution](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/update-the-solution.html) | ||
|
||
# Migrating QnABot Configurations and Data from Existing Cloudformation Stack to New Cloudformation Stack | ||
|
||
If you have previously deployed the solution but do not want to perform in-place upgrade or encountered issues during in-place upgrade or in case of a breaking change which does not allow you to upgrade in place, you may try migrating the solution configuration and data using this procedure: | ||
|
||
> **_NOTE:_** | ||
Before getting started, we highly recommend reading [QnABot on AWS Implementation Guide](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/update-the-solution.html) to plan your deployment and refer to [revisions](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/revisions.html) for any changes. | ||
|
||
A. Deploying Cloudformation Stack: | ||
1. Sign in to the AWS CloudFormation console, select your existing QnABot on AWS CloudFormation stack > Parameters. Make a note of the parameters of your existing stack. | ||
2. Deploy latest QnABot stack by enter the appropriate Amazon S3 URL. For more information on deploying solution, please see [QnABot on AWS Implementation Guide](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/deploy-the-solution.html): | ||
|
||
- If using the default main template: [launch here](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/latest/qnabot-on-aws-main.template) | ||
|
||
- If using the VPC template: [launch here](https://solutions-reference.s3.amazonaws.com/qnabot-on-aws/latest/qnabot-on-aws-vpc.template) | ||
|
||
3. Under Parameters, modify them as necessary per the notes made in Step 1. | ||
4. Choose Next. | ||
6. On the Configure stack options page, choose Next. | ||
7. On the Review page, review and confirm the settings. Be sure to check the box acknowledging that the template might create AWS Identity and Access Management (IAM) resources. | ||
8. Choose View change set and verify the changes. Click Submit to deploy the stack. | ||
9. Wait and confirm that deployment is complete | ||
|
||
B. Exporting and Import QnAs: | ||
|
||
1. Export QnAs from previous stack: | ||
|
||
a. Sign in to the content designer of previous stack, choose the tools menu ( ☰ ), and then choose the Export. | ||
|
||
b. Click on Export. For more details, please refer to [Importing and exporting chatbot answers](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/importing-and-exporting-chatbot-answers.html). | ||
|
||
> **_NOTE:_** | ||
If for any event QnABot designer is not accessible, you may also find this data in S3 Export Bucket if it has been previously exported. If you do not find this data in export bucket, you may also find it OpenSearch indices. | ||
2. Importing QnAs to new stack: | ||
|
||
a. Sign in to the content designer of your newly deployed stack, choose the tools menu ( ☰ ), choose the Import, and then choose From File. | ||
|
||
b. Import the JSON file exported previously in Step B.1.b. | ||
|
||
|
||
C. Verifying and copying settings in the designer: | ||
1. Export settings from previous stack: | ||
|
||
a. Sign in to the content designer of previous stack, select the tools menu ( ☰ ), and then choose Settings. | ||
|
||
b. Click on Export Settings. | ||
|
||
|
||
2. Import settings to new stack: | ||
|
||
a. Sign in to the content designer of your newly deployed stack, select the tools menu ( ☰ ), and then choose Settings. | ||
|
||
b. Click on Import Settings. | ||
|
||
3. Please note there maybe new settings or enhancement with new releases. We recommend to review their description and modify them as required. | ||
> **_NOTE:_** | ||
If for any reason, the QnABot designer of the previous stack is not accessible, you may also find these settings backed up in AWS Systems Manager Parameter Store of your previous stack. In that case, you will refer to those settings from the Parameter Store and update them manually in the settings page of the newly deployed stack. | ||
|
||
D. Post-migration verification and cleaning: | ||
|
||
1. Verify questions, answers and text passages that were imported are successfully loaded in the designer. | ||
2. Verify settings were imported correctly or correct them as necessary. | ||
3. Once you have loaded the questions, choose Edit from the Tools menu, choose LEX REBUILD from the top right edit card menu (⋮) and make sure it's successful. This also re-trains Amazon Lex using the newly added questions as training data. For more information, please refer to [Lex rebuild](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/configuring-intent-and-slot-matching.html#lex-rebuild). | ||
4. Using chat client provided through QnABot, please ensure that the questions are being answered corrently. You can also use the content designer to tune, test, and troubleshoot answers to fix problems. For more information, please refer to [Tuning, testing, and troubleshooting unexpected answers](https://docs.aws.amazon.com/solutions/latest/qnabot-on-aws/tuning-testing-and-troubleshooting-unexpected-answers.html). | ||
> **_NOTE:_** | ||
If you have deployed [AWS Lex Web UI](https://github.com/aws-samples/aws-lex-web-ui/blob/master/README.md) (this is not maintained as part of QnABot on AWS) to integrate with QnABot on AWS, please verify you have updated required information (e.g LexV2BotId, LexV2BotAliasId etc) available under newly deployed QnABot on AWS CloudFormation stack > Outputs. For more details, please refer to [Deploy a Web UI for Your Chatbot](https://aws.amazon.com/blogs/machine-learning/deploy-a-web-ui-for-your-chatbot/). | ||
5. Deleting your previous QnABot stack: | ||
|
||
a. Before deleting the previous stack, please validate if you need to retain any AWS CloudWatch Logs and data in AWS S3 buckets created by QnaBot. | ||
b. After validating, you may proceed to delete your existing deployment by selecting your existing QnABot on AWS CloudFormation stack > Delete. | ||
|
||
|
||
### Frequently Asked Questions (FAQs): | ||
- Do I need to back-up and migrate Amazon DynamoDb database table? | ||
- This is not required as it only contains user chat information to disambiguate follow-up questions from previous question and answer context. Once users start interacting with QnABot, the table rows will be populated and updated. | ||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.