Skip to content

Commit

Permalink
Adding common mistakes
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin-Shi-Dev committed Jul 22, 2024
1 parent c250745 commit 4feb9ea
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/getting_started/prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ Make sure that you have the required permissions for resources for the IAM user
- IAM
- CloudFormation

To confirm you have the required permssion for the resoucres nessary to run the
pipeline you can check with the following script.

.. code-block:: console
$ wget -O- https://raw.githubusercontent.com/cypienta/AWS/v0.7/check_permissions.py | python
Quotas
------
Expand Down
24 changes: 24 additions & 0 deletions docs/source/getting_started/troubleshoot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,27 @@ AWS console for the region you are using. Search for ``Service Quotas``

3. Select the required instance type from the list and click on ``Request
increase at account level``.

Common Mistakes
----------------

Some of the common errors that can result in the failure of the CloudFormation stack:

- Duplicate S3 bucket name
- Incorrect arn for Models/UI
- Incorrect Image for VRL Lambda

Duplicate S3 bucket name
--------------------------
In the case of a duplicate S3 bucket name, delete the failed CloudFormation stack,
then choose a new globally unique S3 bucket name and recreate the stack.

Incorrect arn for Models/UI
----------------------------
In thge case of an incorrect arn for models/UI, delete the failed CloudFormation stack,
then confirm the arns for all models and UI components as seen in :doc:`subscription` and recreate the stack.

Incorrect Image for VRL Lambda
-------------------------------
In the case of an incorrect image for VRL lambda, delete the failed CloudFormation stack,
then ensure that you have the correct ECR Image URI and version number, and recreate the stack.

0 comments on commit 4feb9ea

Please sign in to comment.