zops

Utils for devops teams that want to deploy using Zappa

##Use cases?

####Users I work on a team where two teams exists, engineers and systems (devops eam). We wanted to use Zappa but the systems team doesn't want to (and shouldn't) give admin rights to all engineers (even if it is the staging account). We wanted to give users keys that they could use to deploy their apps and also (more importantly) wanted separate IAM users for every Jenkins build. I've tried to give each user only the privileges needed for the app and stage requested.

####CI, Deploy the Initial and Following Versions

We also needed the ability to skip the zappa deploy command because we want to deploy using our CI/CD servers (Jenkin, CircleCI, TravisCI, and etc.). I'm also morally against putting if/then logic in Jenkins and other CI build scripts. So I chose to deploy a small Flask app with the same name the real project will use.

##Install

pip install zops

##Usage

###Zops

This commands lists the commands for you. There is only one option for this command and it is --profile_name. The profile_name option sets the credentials profile from your ~/.aws/credentials file. This option can be passed to all subcommands.

>>>zops
Usage: zops [OPTIONS] COMMAND [ARGS]...

Options:
  --profile_name TEXT  Credentials profile name.
  --help               Show this message and exit.

Commands:
  create_user
  delete_user
  deploy_initial
  undeploy_initial
  user_credentials

###Create User

Create an IAM user tailored to your app, stage, region, function and static buckets.

Option: --user_temp_class - Change the class used to build the CloudFormation template for creating a user

>>>zops create_user blog dev
Username: dev_user
Function Bucket: your_functions_bucket
Static Bucket: your_apps_static_bucket
AWS Region Name [us-east-1]: us-east-1
Creating user: zappablogdevuser

###User Credentials

Get credentials for the user you created with the create_user command.

>>>zops user_credentials blog dev
+-----------+------------------------------------------+
| Attribute | Value                                    |
+-----------+------------------------------------------+
| SecretKey | your_secret_key_here                     |
| AccessKey | your_access_key_here                     |
+-----------+------------------------------------------+

###Deploy Initial

The deploy_initial command runs the zappa deploy command in order to deploy an initial WSGI app so your continuous integration server can run the zappa update command with no problems. The command deploys a small Flask app using the newly created credentials.

#####Make Appropriate Directories

In order to achieve this the zappa deploy requires that you create an empty folder with the exact name of the folder you will deploy from within your CI environment or from the command line. Important: This does not mean that you should move your code here, keep your code where you normally store it. This should remain an empty directory. The zappa deploy commannd uses the directory name (ex. projecta from below) to determine the Lambda and API Gateway name.

- workspace
   |_ zops
       |_ projecta #Create a new empty folder for each project
       |_ projectb
       |_ projectc

>>>zops deploy_initial blog dev
Function Bucket: your_function_bucket
AWS Region Name [us-east-1]: us-east-1
Creating initial app...
Deploying initial app...
100%|██████████████████████████████████████████████████████████████████| 3.71M/3.71M [00:03<00:00, 1.08MB/s]
100%|████████████████████████████████████████████████████████████| 1008/1008 [01:39<00:00,  5.25 endpoint/s]
Deleting local copy of initial app...

###Undeploy Initial

Undeploy the Zappa app with the given name and stage

>>>zops undeploy_initial blog dev
Function Bucket: your_function_bucket
AWS Region Name [us-east-1]:
Creating initial app...
Undeploying initial app...
Deleting local copy of initial app...