Rolling deploys for AWS AutoScale Groups
License2Deploy is an automated solution for rolling deployments in AWS written in python.
The rolling deployment will:
- Double your instances in your autoscale group
- Confirm that the instances are healthy
- Confirm that the new instances are InService in the Elastic Load Balanacer
- Drop your autoscale group instance count back to what it was at prior to deployment
- Ensure that the old instances are out of the load balancer
usage: rolling_deploy [-h] -e ENV -p PROJECT -b BUILD_NUM -a AMI_ID
[-P PROFILE] [-c CONFIG] [-s STACK_NAME] [-f FORCE_REDEPLOY]
[-C CREATION_WAIT] [-r READY_WAIT] [-H HEALTH_WAIT] [-o ONLY_NEW_WAIT]
optional arguments:
-h, --help show this help message and exit
-e ENV, --environment ENV
Environment
-p PROJECT, --project PROJECT
Project name
-b BUILD_NUM, --build BUILD_NUM
Build Number
-a AMI_ID, --ami AMI_ID
AMI ID
-P PROFILE, --profile PROFILE
Profile name as designated in aws credentials/config
files
-c CONFIG, --config CONFIG
Config file Location, eg.
/opt/License2Deploy/config.yml
-s STACK_NAME, --stack STACK_NAME
Stack name if AutoScaling Group created via CloudFormation
-f FORCE_REDEPLOY, --force-redeploy FORCE_REDEPLOY
Whether to force redeploy current running build, default to false
-C CREATION_WAIT, --creation-wait CREATION_WAIT
Time to wait for EC2 instances to be created
(# of tries, interval of each try in seconds), default (10, 60)
e.g. -C 10 60
-r READY_WAIT, --ready-wait READY_WAIT
Time to wait for EC2 instances to come up and be ready
(# of tries, interval of each try in seconds), default (10, 30)
e.g. -r 10 30
-H HEALTH_WAIT, --health-wait HEALTH_WAIT
Time to wait for EC2 instances to be health checked
(# of tries, interval of each try in seconds), default (10, 30)
e.g. -H 10 30
-o ONLY_NEW_WAIT, --only-new-wait ONLY_NEW_WAIT
Time to wait for old EC2 instances to terminate
(# of tries, interval of each try in seconds), default (10, 30)
e.g. -o 10 30
-A ASG_LOGICAL_NAME, --asg-logical-name ASG_LOGICAL_NAME
ASG Logical Name from CFN
-L LOAD_BALANCER, --load_balancer LOAD_BALANCER
LoadBalancerName
There are a few requirements in order for the automated rolling deployments to work:
- As stated above, this has to be done in AWS (Amazon Web Services)
- You need an autoscale group
- Instances in the autoscale group need to be behind an Elastic Load Balancer (ELB)
- All instances in the autoscale group need to be tagged with a build number
- This is an important step as when the script runs, it will differentiate the old builds from the new builds based off of the build number that is passed in as a command line parameter
- The credentials for the user need to be in the ~/.aws/credentials file and if not passed in as a command line argument, the script will look at the 'default' profile.
- The script needs the AMI ID of the instances that will be built.
- The reason for the AMI ID is to ensure that if it was just created, it is not in a pending state and it is ready to be used to build an instance.
- Lastly, you should modify the regions.yml file to fit your environment as the environment is what is passed to the script, and the script will work the logic out based on what is in the yaml config.
- Example of environments: qa, stg, prd, dev, test, etc.
To run unit tests:
$ tox
python License2Deploy/rolling_deploy.py