In order to execute deployment for this project, some tools and frameworks are necessary:
- python 3.7+ installed
- pipenv
- Serverless framework
- make (CMake, GNU Make or BSD Make)
- awscli
You can procede to deployment if you already have these tools
AWS Xray is a resource provided by AWS that can be used to monitor the executions of your applications: More information here XRAY
make DEPLOYMENT_BUCKET="" ES_HOST="" ES_INDEX="" SQS_QUEUE_NAME="" deploy
-
Required variables:
ES_HOST
: The endpoint of elasticsearchDEPLOYMENT_BUCKET
: The aws bucket where the code will be stored
-
Optional
ES_INDEX
: THE NAME OF INDEX (OPTIONAL: IF NOT PROVIDED WILL BE xray-yyyy-mm-dd), the date part is default by the applicationSQS_QUEUE_NAME
: The name of SQS Queue, DEFAULT=xray-to-elasticsearch-delivery You can edit the Makefile variable SQS_QUEUE_NAME for other one of your choice!