Aws Deploy Lambda Error While Uploading Function Code Illegal Operation on a Directory

Introduction

Zappa is a very powerful open source python project which lets you build, deploy and update your WSGI app hosted on AWS Lambda + API Gateway easily.This blog is a detailed pace-by-stride focusing on challenges faced while deploying Django application on AWS Lambda using Zappa as a deployment tool.

Building Your Application

If y'all exercise not accept a Django application already you can build i by cloning this GitHub repository.

CODE: https://gist.github.com/velotiotech/ab76374bc689729d61f8d022f67ffa9c.js

Lawmaking: https://gist.github.com/velotiotech/5e25f8aa02ac63db225201838a6c7d5a.js

Once you accept cloned the repository you will need a virtual environment which provides an isolated Python environment for your application. I adopt virtualenvwrapper to create one.

Command :

Code: https://gist.github.com/velotiotech/f914eb0e86beb81b1120fe4e056408a3.js

Lawmaking: https://gist.github.com/velotiotech/84b3a9eabec962a829c0f18669340ebb.js

Install dependencies from requirements.txt.

Lawmaking: https://gist.github.com/velotiotech/45cb7456d2c98e37c8042dcaf9ac1375.js

Lawmaking: https://gist.github.com/velotiotech/67365ee8d1d58400c2e9d1a1405e388b.js

At present if you lot run the server direct information technology will log a warning as the database is non set up even so.

Code: https://gist.github.com/velotiotech/5ccdb2863d7df7b3af7fa0c93e656c1e.js

Code: https://gist.github.com/velotiotech/244489b224198d181a332f6be3f1daa1.js

Also trying to access admin folio (http://localhost:8000/admin/) volition throw an "OperationalError" exception with below log at server end.

Lawmaking: https://gist.github.com/velotiotech/66ca4dd926c477acc0bdf56adda75911.js

In society to ready this you need to run the migration into your database and so that essential tables similar auth_user, sessions, etc are created before any request is made to the server.

CODE: https://gist.github.com/velotiotech/a564184b8eec31fa4b6dfc6d3fb0fd86.js

CODE: https://gist.github.com/velotiotech/1fccc974d19b2aa7fbc79604f166aa71.js

NOTE: Utilize DATABASES from project settings file to configure your database that you would want your Django application to use one time hosted on AWS Lambda. By default, its configured to create a local SQLite database file every bit backend.

Y'all can run the server again and it should now load the admin panel of your website.

Do verify if you have the zappa python package into your virtual environment earlier moving forrad.

Configuring Zappa Settings

Deploying with Zappa is uncomplicated as it only needs a configuration file to run and rest will be managed past Zappa. To create this configuration file run from your project root directory -

Lawmaking: https://gist.github.com/velotiotech/64b2fb2d76fd9cecb6fa0494893ab1a6.js

Code: https://gist.github.com/velotiotech/2119f47b95061bd78737771c7def11fe.js

You can verify zappa_settings.json generated at your project root directory.

TIP: The virtual environment name should not exist the same as the Zappa project proper noun, equally this may cause errors.

Additionally, y'all could specify other settings in zappa_settings.json file as per requirement using Advanced Settings.

Now, you're ready to deploy!

IAM Permissions

In order to deploy the Django Application to Lambda/Gateway, setup an IAM role (eg. ZappaLambdaExecutionRole) with the post-obit permissions:

CODE: https://gist.github.com/velotiotech/e938baad91a45b341fae116a7b430d91.js

Deploying Django Application

Before deploying the application, ensure that the IAM office is fix in the config JSON every bit follows:

Lawmaking: https://gist.github.com/velotiotech/a949942b8a5684ddfbfd238ba42bad6d.js

Once your settings are configured, you lot tin package and deploy your awarding to a stage called "dev" with a unmarried control:

Code: https://gist.github.com/velotiotech/226e082cb4a15860c41dc50c8eb10aee.js

Code: https://gist.github.com/velotiotech/58086ab91ab3abc6efe6d8001b7fe59a.js

Yous should see that your Zappa deployment completed successfully with URL to API gateway created for your awarding.

Troubleshooting

1. If y'all are seeing the post-obit error while deployment, information technology's probably considering you practice not accept sufficient privileges to run deployment on AWS Lambda. Ensure your IAM role has all the permissions as described in a higher place or gear up "manage_roles" to truthful so that Zappa can create and manage the IAM part for you.

CODE: https://gist.github.com/velotiotech/83a80278e5b9412274f08895390570c4.js

2. The below error will be caused as you accept not listed "events.amazonaws.com" as Trusted Entity for your IAM Office. You can add together the aforementioned or set "keep_warm" parameter to false in your Zappa settings file. Your Zappa deployment was partially deployed as it got terminated abnormally.

CODE: https://gist.github.com/velotiotech/c3bff02fe90ef2c1a2eff0320b013dab.js

3. Adding the parameter and running zappa update will cause above fault. Equally you tin see it says "Stack django-zappa-sa-dev does non exists" equally the previous deployment was unsuccessful. To set this, delete the Lambda function from console and rerun the deployment.

Code: https://gist.github.com/velotiotech/454b47d56b78ed9fadf441ce49bf8d68.js

4. If you run into any distribution error, delight try downward-grading your pip version to 9.0.i.

CODE: https://gist.github.com/velotiotech/772b30353ec89c3190468d091868366f.js

Lawmaking: https://gist.github.com/velotiotech/55a2e822827a92f468c018ece747a774.js

or,

If you run into NotFoundException(Invalid REST API Identifier issue) please try undeploying the Zappa stage and retry over again.

Lawmaking: https://gist.github.com/velotiotech/8b4e99abcc58583ddca0e1887c7bc77c.js

TIP: To understand how your application works on serverless surround delight visit this link.

Postal service Deployment Setup

Drift database

At this point, you should have an empty database for your Django application to fill upward with a schema.

CODE: https://gist.github.com/velotiotech/186cfb61d6f4a5f32b8ad8895415c089.js

Once you lot run above control the database migrations will be practical on the database as specified in your Django settings.

Creating Superuser of Django Awarding

Yous as well might need to create a new superuser on the database. You could utilise the following command on your project directory.

Code: https://gist.github.com/velotiotech/2180f1ff30565a4347698feebcf6d01f.js

Alternatively,

CODE: https://gist.github.com/velotiotech/bd9a931cd3c9f4c08e10d0c190c88ac3.js

Note that your application must be connected to the same database as this is run as standard Django administration command (not a Zappa command).

Managing static files

Your Django awarding will be having a dependency on static files, Django admin panel uses a combination of JS, CSS and image files.

Annotation: Zappa is for running your awarding code, not for serving static web assets. If you programme on serving custom static assets in your web application (CSS/JavaScript/images/etc.), you'll likely want to use a combination of AWS S3 and AWS CloudFront.

You will need to add post-obit packages to your virtual environment required for management of files to and from S3 django-storages and boto.

CODE: https://gist.github.com/velotiotech/71d013e77a0ea0892a31f0a3c7dbcd51.js

Once you have setup the Django application to serve your static files from AWS S3, run following control to upload the static file from your project to S3.

CODE: https://gist.github.com/velotiotech/fc6953222abf0d748696891f9bdb7fcc.js

CODE: https://gist.github.com/velotiotech/450d04c22b2c9bbad612794bc7940b99.js

Check that at least 61 static files are moved to S3 saucepan. Admin console is congenital over 61 static files.

NOTE: STATICFILES_DIR must be configured properly to collect your files from the appropriate location.

Tip: You need to render static files in your templates by loading static path and using the aforementioned. Example, {% static %}

Setting Up API Gateway

To connect to your Django application you lot also demand to ensure y'all take API gateway setup for your AWS Lambda Function. You demand to have GET methods ready for all the URL resources used in your Django application. Alternatively, you can setup a proxy method to allow all subresources to exist processed through one API method.

Go to AWS Lambda function console and add API Gateway from 'Add together triggers'.

1. Configure API, Deployment Stage, and Security for API Gateway. Click Relieve once it is done.

2. Become to API Gateway console and,

a. Recreate ANY method for / resources.

i. Check `Apply Lambda Proxy integration`

two. Set `Lambda Region` and `Lambda Function` and `Save` it.

a. Recreate Whatsoever method for /{proxy+} resource.

i. Select `Lambda Function Proxy`

two. Prepare`Lambda Region` and `Lambda Function` and `Save` information technology.

3. Click on Action and select Deploy API. Set Deployment Stage and click Deploy

4. Ensure that Get and POST method for / and Proxy are set as Override for this method

Setting Up Custom SSL Endpoint

Optionally, you could also prepare your ain custom defined SSL endpoint with Zappa and install your certificate with your domain by running certify with Zappa.

CODE: https://gist.github.com/velotiotech/0c7b94fd895ecbd3dee2cae91dd4c55d.js

Now you lot are ready to launch your Django Application hosted on AWS Lambda.

Additional Notes:

In one case deployed, you must run "zappa update <stage-proper noun>" for updating your already hosted AWS Lambda function.</stage-name>
You tin can check server logs for investigation by running "zappa tail" control.
To un-deploy your application, simply run: `zappa undeploy <stage-name>`</stage-name>

You've seen how to deploy Django application on AWS Lambda using Zappa. If you are creating your Django application for first time yous might too want to read Edgar Roman's Django Zappa Guide.

First edifice your Django awarding and let u.s. know in the comments if you need any assist during your awarding deployment over AWS Lambda.

johnsonthynand.blogspot.com

Source: https://www.velotio.com/engineering-blog/deploy-serverless-event-driven-python-applications-using-zappa