docs: add a notice of creating bot stack related to frontend WAF #670
Conversation
fbukevin
requested review from
statefb,
wadabee and
Yukinobu-Mine
as code owners
Respecting to this isssue: aws-samples#633 I think this information in README should be helpful for other users(either the official document or the Caution explicitly).
Add some note of deployment
README.md
Outdated
| There are two ways to deploy a chatbot: | ||
|
|
||
| - Super-easy deployment: This method is designed for the very first user of BrChat. | ||
| - Using CDK: Notice that it requires large amount of space to register container layers. Expand your disk of VM for Cloud9 before you deploy. |
There was a problem hiding this comment.
Ah sorry, I removed the previous one, but omitted the later one.
README.md
Outdated
| - Super-easy deployment: This method is designed for the very first user of BrChat. | ||
| - Using CDK: Notice that it requires large amount of space to register container layers. Expand your disk of VM for Cloud9 before you deploy. | ||
|
|
||
| Both method require usig CDK config file in cdk/cdk.js. To use custom bootstrap, please refer to [deploy.md](deploy.md). |
There was a problem hiding this comment.
only cdk deployment requires modification of cdk.json
There was a problem hiding this comment.
If you want to use another qualifier, even using bin.sh requires modification cdk.json.
We had struggle with it very much. Because in deploy.yml, it calls cdk/cdk.json.
There was a problem hiding this comment.
As I mentioned earlier, the target users for super-easy deployment is "the very first user of BrChat". If need to change options which can only be modified via cdk.json (can not change via arguments on bin.sh), it should be an advanced usage so recommend to use deployment by CDK.
There was a problem hiding this comment.
Thanks for your confirmation. Actually, that's not work easily. Just as a caution, in the same account, the code of this project sometime will encounters resource confliction when deploying multiple chatbot. We collaborate with AWS support and addressed this issue.
There was a problem hiding this comment.
Understood. Could you clarify what you're ultimately trying to achieve with this PR?
* Add dead letter queue to API stack, to limit retries * fix DLQ name Change SQS queue DLQ name according to https://qiita.com/tmokmss/items/721a99e9a62499d6d54a. also changed "DLQ" => "Dlq" because not using capitalize-acronym rule.
Issue #, if available:
#633
Description of changes:
Just add a notice to README to inform future user notice the bedrock region setting. I think this information in README should be helpful for other users(either the official document or the Caution explicitly).
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.