Skip to content

Commit

Permalink
Update doc about deploying ESF using SAR AWS console (#767)
Browse files Browse the repository at this point in the history
This PR is to update the doc about the limitation of deploying ESF using SAR AWS console: one deployment per region.
This PR also sets mypy == 1.10.1 and types-requests<2.31.0.7 as a workaround for fixing CI.
  • Loading branch information
kaiyan-sheng authored Aug 21, 2024
1 parent 1962405 commit 58d1cfa
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
7 changes: 6 additions & 1 deletion docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,8 @@ NOTE: To deploy the forwarder directly without using SAR, refer to <<aws-serverl
[[aws-serverless-forwarder-deploy-console]]
=== Deploy using {aws} Console

NOTE: Only one deployment per region is allowed when using the {aws} console directly.

. Log in to {aws} console and open **Lambda**.
. Click **Applications** and then **Create application**.
. Click **Serverless application** and search for **elastic-serverless-forwarder**.
Expand All @@ -333,7 +335,10 @@ NOTE: To deploy the forwarder directly without using SAR, refer to <<aws-serverl
[role="screenshot"]
image::images/aws-serverless-forwarder-create-function.png[Create Elastic Serverless Forwarder Lambda function within SAR]
+
. Complete the **Application settings** according to <<aws-serverless-forwarder-define-deploy-parameters>>.
. Complete the **Application settings** according to <<aws-serverless-forwarder-define-deploy-parameters>>.
You must specify the parameters even if they already exist in the `config.yaml` file. Depends on the input type, at least
one if the parameters `ElasticServerlessForwarderSQSEvents`, `ElasticServerlessForwarderS3SQSEvents`,
`ElasticServerlessForwarderKinesisEvents`, `ElasticServerlessForwarderCloudWatchLogsEvents` should de defined.
. After your settings have been added, click **Deploy**.
. On the Applications page for **serverlessrepo-elastic-serverless-forwarder**, click **Deployments**.
. Refresh the **Deployment history** until you see the `Create complete` status update. It should take around 5 minutes to deploy &mdash; if the deployment fails for any reason, the create events will be rolled back and you will be able to see an explanation for which event failed.
Expand Down
2 changes: 1 addition & 1 deletion requirements-lint.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ black
flake8
flake8-per-file-ignores
isort
mypy
mypy==1.10.1
types-PyYAML
types-mock
pyflakes>=3.0.0,<3.3.0
1 change: 1 addition & 0 deletions requirements-tests.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ pysimdjson==5.0.2
python-rapidjson==1.14
cysimdjson==23.8
responses==0.24.1
types-requests<2.31.0.7
testcontainers==3.7.1
pyOpenSSL==24.0.0

0 comments on commit 58d1cfa

Please sign in to comment.