https://github.com/trjohnst/lambda-flask-boilerplate
Boilerplate repo to deploy flask apps with zappa in a docker container to AWS
https://github.com/trjohnst/lambda-flask-boilerplate
boilerplate docker flask python zappa
Last synced: 2 months ago
JSON representation
Boilerplate repo to deploy flask apps with zappa in a docker container to AWS
- Host: GitHub
- URL: https://github.com/trjohnst/lambda-flask-boilerplate
- Owner: trjohnst
- Created: 2018-10-08T06:52:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-10T23:16:04.000Z (over 6 years ago)
- Last Synced: 2025-01-24T08:28:35.932Z (4 months ago)
- Topics: boilerplate, docker, flask, python, zappa
- Language: Dockerfile
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overview
This is a boilerplate repo to get started with [Zappa](https://github.com/Miserlou/Zappa). You can use it to build a docker image that can be used to create containers for deploying serverless python apps (built with frameworks like [Flask](http://flask.pocoo.org/), [Django](https://www.djangoproject.com/), etc) to AWS. It was made with [these instructions](https://hackernoon.com/deploy-a-serverless-flask-application-on-aws-lambda-d8ca58af42a4) and includes a few fixes for issues that I experienced with the setup.
This was run on Docker 18.06.1 on a Mac.
I'm using [python:3.6-alpine](https://github.com/docker-library/python/blob/0c0365d804c2ef4ee8edef652e6a39cdf461e3b2/3.6/alpine3.8/Dockerfile) as a base image to keep things lightweight. The resulting image will be under 500MB.
# Usage
## 1. AWS Configs
Add a `config` file and `credentials` file to the `aws` folder. You can refer to the [sample config](aws/sample_config) and the [sample credentials](aws/sample_credentials).
You can generate your own credentials after setting up an AWS account, going into your AWS console and following [these instructions](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
## 2. Zappa Settings
Modify the [zappa_settings.json](zappa_settings.json) file to include your region (matching the one from aws/config) and your profile (matching the one provided in aws/credentials). The current file uses `us-west-1` (California) and `default` as specified in [the sample config](aws/sample_config).
## 3. Build the image
You can build the image simply with `./build-docker.sh`
## 4. Deploying in a container
```bash
# Run a container from the image
./run-docker.sh
# Activate the pre-made python virtual environment (it has everything you need installed)
source serverlessbot/bin/activate
# Deploy your dev instance
zappa deploy dev
```
The end of the deployment will say `Deployment complete!` followed by a URL. You can navigate to the URL and verify that it says "Hello World!"
## 5. Undeploying
Once you are done running your test, you should undeploy to clean up.
You can undeploy, while in the virtual environment, with `zappa undeploy` and hit `y` when prompted.
I've also found that the S3 buckets stick around so you may want to delete the bucket that you created. You can find this bucket in your AWS console and it will correspond to the `s3_bucket` setting in [zappa_settings.json](zappa_settings.json).
## 6. Exiting
```bash
# Get out of the python virtual environment
deactivate
# Exit the container
exit
```
# Troubleshooting
## Operation Not Found
If you encounter output like the following:
```bash
Traceback (most recent call last):
File "/usr/local/lib/python3.6/site-packages/zappa/core.py", line 911, in upload_to_s3
self.s3_client.head_bucket(Bucket=bucket_name)
File "/usr/local/lib/python3.6/site-packages/botocore/client.py", line 320, in _api_call
return self._make_api_call(operation_name, kwargs)
File "/usr/local/lib/python3.6/site-packages/botocore/client.py", line 623, in _make_api_call
raise error_class(parsed_response, operation_name)
botocore.exceptions.ClientError: An error occurred (404) when calling the HeadBucket operation: Not Found
```
Double check your credentials! It's likely the `aws/credential` credentials file that you created is not setup right. For instance, having a different region in [zappa_settings.json](zappa_settings.json) from your `aws/config`.
## Anything else
If an error looks cryptic from the command line or from following the steps above, try using `zappa tail` from the python virtual environment or looking at AWS CloudWatch Logs.