Older versions of this plugin may not be safe to use. Please review the following warnings before using an older version:
This plugin allows you to deploy into AWS Elastic Beanstalk by Packaging, Creating a new Application Version, and Updating an Environment
Overview and Installation
In order to understand how this plugin works, you need to understand how AWS Elastic Beanstalk works. In a nutshell:
1. You package a zip file with the contents of your app (or the plugin creates you one)
2. This zip file is uploaded as a new S3 Object in a bucket you control
3. The CreateApplicationVersion API call is done in your application, pointing to the file created in the previous step
4. You call the UpdateEnvironment call with the versionLabel from the previous step, triggering an update
The Git Endpoints AWS Publishes automate steps 1-3 and optionally 4. Unfortunately, this is undocumented and AWS so far hasn't released its inner workings despite our attempts to call for help.
This plugin does steps 1-3 and if an environment name is specified and its active, it also does the UpdateEnvironment API call. If you enable the "Zero Deployment" Flag, it creates a parallel environment and deploys into it.We've written this in order to allow more streamlined deployments from Jenkins, specially for non-Maven builds with minimal tweaking
(for Maven builds, we advise you to look at our ingenieux Beanstalker, our Maven Plugin. You'll love it!)
Setting up your Jobs
Once installed, the plugin will allow you to add a new Build Step in Jenkins. You have two options:
a. Build a Zip / WAR file yourself. In this case, just mention "Root Object" as the path to the generated file.
The values for includes/excludes are unnecessary. As for Version Label Format, see some available variables on this url.
b. You want us to build your zip file. The plugin allows you to do it, by specifying include/exclude globs, as long as you define a directory (which, in this case, is the Root Object). Example on a Node.js project:
- Root Object: . (the base directory)
- Includes: */
- Excludes: */.git/,/node_modules/*
Once your build is finished, the plugin does the rest.
If there's a valid environment name defined and active, the plugin will call UpdateEnvironment until the API Call Passes. It tries 15 times, with a 90s interval between calls.
If you turn on "Zero Deployment", the plugin does instead:
- CreateConfigurationTemplate on the existing environment
- CreateEnvironment using the generated template and newer ApplicationVersion
- Waits for Environment getting both Green (Health) and Ready (Status)
- SwapEnvironmentCName among those two environments
- Terminates the original Environment
Use the beanstalker-users mailing list on google groups (link) if you have questions. Of course, there's the github issues (https://github.com/ingenieux/awseb-deployment-plugin/issuesingenieux/awseb-deployment-plugin)
This is a logical step from our ingenieux Beanstalker project, and we hope it helps you to get your stuff done. You can see the full list of credits on docs.ingenieux.com.br (under "Huge Thanks goes To")
And if you're reading this far, why not donate to our parent project, beanstalker?
Version 0.2 (11/12/13)
- First Public Release
- Updated Docs + Plugin Identifies Version to AWS