Amazon EC2 Plugin

Skip to end of metadata
Go to start of metadata

Allow Jenkins to start slaves on EC2 or Ubuntu Enterprise Cloud (Eucalyptus) on demand, and kill them as they get unused.With this plugin, if Jenkins notices that your build cluster is overloaded, it'll start instances using the EC2 API and automatically connect them as Jenkins slaves. When the load goes down, excessive EC2 instances will be terminated. This set up allows you to maintain a small in-house cluster, then spill the spiky build/test loads into EC2 or another EC2 compatible cloud.

Plugin Information

Plugin ID ec2 Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Dependencies
1.21
Feb 28, 2014
1.424
node-iterator-api (version:1.1)
Source Code
Issue Tracking
Maintainer(s)
GitHub
Open Issues
Francis Upton IV (id: francisu)
Kohsuke Kawaguchi (id: kohsuke)
Usage Installations 2013-Apr 773
2013-May 805
2013-Jun 835
2013-Jul 890
2013-Aug 923
2013-Sep 898
2013-Oct 959
2013-Nov 976
2013-Dec 950
2014-Jan 1024
2014-Feb 1041
2014-Mar 1061

Usage

First, go to EC2 and sign up for the service. Then click 'New cloud' to get an EC2 configuration section, enter the Access Key and Secret Access Key which act like a username/password (see IAM section). Because of the way EC2 works, you also need to have an RSA private key that the cloud has the other half for, to permit sshing into the instances that are started. If you have already been using EC2 and have your own key, you can paste it here. Otherwise, you can have Jenkins generate one. If you let Jenkins generate one, you should save this private key in your file system as well, as you'll need this to interactively logon to EC2 instances.

Once you have put in your Access Key and Secret Access Key, select a region for the cloud (not shown in screenshot). You may define only one cloud for each region, and the regions offered in the UI will show only the regions that you don't already have clouds defined for them.

Use "Test Connection" button to verify that Jenkins can successfully talk to EC2. If you are using UEC you need to click on Advanced and fill out the endpoint details for your cluster.

Next, configure AMIs that you want to launch. For this, you need to find the AMI IDs for the OS of your choice. ElasticFox is a good tool for doing that, but there are a number of other ways to do it. Jenkins can work with any Unix AMIs. If using an Ubuntu EC2 or UEC AMI you need to fill out the rootCommandPrefix and remoteAdmin fields under 'advanced'. Windows is currently unsupported.

Configuring labels allow Jenkins to pick the right AMI to start. For example, if all your existing slaves labeled "solaris" are fully busy and you have more builds that are tied to the "solaris" label, Jenkins will start the AMIs that have the "solaris" label.

Init script is the shell script to be run on the newly launched EC2 instance, before Jenkins starts launching a slave agent. If the AMI doesn't have Java pre-installed, you can do this in the init script. This is also a good place to install additional packages that you need for your builds and tests.  The init script is located at /tmp/init.sh and is owned and run by the user account specified in the "Remote User" field (so use of "sudo" may be required for non-root accounts).

Configure several AMIs if you need different OS images.

With this setting, your Jenkins will automatically start instances when the load goes up, and the instances will be terminated (or stopped - see below) automatically if it's idle for more than 30 mins.

By default, instances are terminated when the idle timeout period expires. You can change this by specifying the Stop/Disconnect on Idle Timeout flat in the Advanced properties of the AMI configuration. If this is specified, the instance is stopped when the timeout expires. If the instance is required again, then the plugin will look for a stopped instance that exactly corresponds to the AMI specification and resume it if found. Otherwise a new instance is started. Having the instances be stopped instead of terminated is useful when you are using EBS volumes and want to keep them mounted for the life of the instance and reuse the instance for long periods of time. This can greatly reduce the startup time of the instance since it does not have to build the volume from the snapshot.

Spot Instances

 - Will not be available until the next release (1.19)

Spot instances are similar to EC2 instances, except for a few key differences. They are generally more affordable, but they have the possibility of being terminated if someone has bid more on them than you have and can take longer to provision.  To mitigate some of these issues, your Jenkins and Slave AMIs will need a bit of configuration to convert the Spot slaves to register with Jenkins when they spawn up. Due to these changes, it may appear that a Spot slave will have failed (with a red X), but the message associated with the error will inform you if the Spot instance just has not called back yet or not. For more information on Spot instances, read the information here: http://aws.amazon.com/ec2/spot-instances/

Enable Spot Request

To enable to use of Spot as opposed to EC2 for an instance, the "Use Spot Instance" check box must be checked.  Also, a bid price must be specified.  If you want to determine what the current price of the instance is without going to the AWS website, pick your region and instance type(as you already should) and click "Check Current Spot Price".
To choose between a Persistent or One Time bid (to keep the bid alive until cancelled or to stop the bid after it has been fulfilled once), choose from the drop down menu.

Configure Jenkins for Spot Support

For Jenkins, the major configuration change will be if you have a restrictive firewall, since these instances need to connect back to Jenkins.  The first configuration change to Jenkins is to change your Jenkins URL option in the Configure Jenkins page to be the external URL to the server.  One port that needs to be open is the one that you use to access Jenkins, the other is the JNLP port, which is generally randomly assigned.  To set the JNLP port to something predictable, follow the Connection Mechanism section on this page. Jenkins CLI

Configure AMI for Spot Support

In order for your EC2 instance to know that it is to be a Jenkins slave, it must be preconfigured with start up commands so that it can register itself with Jenkins.  The Jenkins information is passed to the Spot slaves via EC2 user-data.  This information includes the name that Jenkins has given the slave, and the configured URL for the Jenkins master node.  

Sample scripts for assisting in configuring an Ubuntu based AMI to work with the Jenkins ec2-plugin and Spot slaves are included with the installation of the plugin. 
Config Script:

(jenkins_server)/plugin/ec2/AMI-Scripts/ubuntu-ami-setup.sh

Startup Script:

(jenkins_server)/plugin/ec2/AMI-Scripts/ubuntu-init.py

The config script is run by the user from the EC2 instance with root access.  It installs Java onto the instance and fetches the startup script and sets it to run when the machine starts up.  It can be retrieved from the above url using a command like wget, or copied over using a tool like scp.

wget (jenkins_server)/plugin/ec2/AMI-Scripts/ubuntu-ami-setup.sh

Once the scripts have been downloaded, the script can be run. Running this script will also run the ubuntu-init.py script, so there is no need to run it on its own.

sudo sh ubuntu-ami-setup.sh jenkins_server{:port}

Note: ‘http://” will be prepended to the jenkins_server parameter

The config script then fetches the startup script and sets up the AMI to register itself with a Jenkins master node when it gets started.

After setting up the image, you can save the image using Amazon’s EC2 web console. To do this, right click on your instance from the console and select “Create Image (EBS AMI)”.

In order to set up additional images using other operating systems, you can configure your own startup script based on the startup script above.  This script should perform the following actions when the machine is started up:

# Verify that Java is installed

# Install Java if it is not installed

# Read user data for the EC2 instance. It is available from [http://169.254.169.254/latest/user-data]

# Values are passed in with the format of JENKINS_URL=[jenkins_url]&SLAVE_NAME=[slave_name]&USER_DATA=[other_user_data]

# Parse the values to retrieve the Jenkins_Url and Slave_name
# Fetch the slave.jar from the Jenkins master using wget (or something similar)

wget [Jenkins_Url]jnlpJars/slave.jar -O slave.jar
# Register the salve to the Jenkins master node

java -jar slave.jar -jnlpUrl [Jenkins_Url]computer/ slaveName slave-agent.jnlp

IAM setup

It's possible to create a separate account for jenkins using the Amazon IAM feature. Go to the IAM tab in AWS console and create a user. Then go to user's Permissions tab and use this policy (change username if your user is not called jenkins):

{
  "Statement": [
    {
      "Sid": "Stmt1312295543082",
      "Action": [
        "ec2:CancelSpotInstanceRequests",
        "ec2:GetConsoleOutput",
        "ec2:RequestSpotInstances",
        "ec2:RunInstances",
        "ec2:StartInstances",
        "ec2:StopInstances",
        "ec2:TerminateInstances",
        "ec2:CreateTags"
        "ec2:DescribeInstances"
      ],
      "Effect": "Allow",
      "Resource": "*"
    }
  ]
}

Changelog

Version 1.20 (Nov 8, 2013)

Version 1.19 (Oct 8, 2013)

Version 1.18 (April 9, 2013)

  • Add m3.xlarge and m3.2xlarge instance types
  • Failure starting slave nodes (issue #15319)
  • Tags feature is broken (issue #15239)
  • EC2 Nodes which share an AMI ID get the wrong labels (issue #7690)
  • Sometimes starts the wrong instance (issue #15158)
  • Stopped (as opposed to terminated) slaves are counted against the active instance count for the purpose of launching; can prevent launching of instances (issue #7883)
  • Upgrade aws-java-sdk dependency to 1.3.30
  • Explicitly add MIT license to all plugin code
  • Fallback a manual or timeout-based terminate to stop if terminate fails (to avoid charges)
  • Give Jenkins nodes useful names (issue #15078)
  • Keep track of instances being provisioned; use this count when determining total/AMI instance caps (issue #6691)
  • Bring back remoteFS in the slave configuration page
  • Let user configure node.mode for EC2 slaves

Version 1.17 (September 12, 2012)

  • Resume stopped EC2 instances (issue #14884)
  • Added support for EC2 tags, VPC subnets/security groups
  • Added support for public/private DNS
  • EC2 documentation for VPC/security groups not clear (issue #15149)

Version 1.16 (May 26, 2012)

Version 1.15 (May 21, 2012)

  • Stopped (as opposed to terminated) slaves are counted against the active instance count for the purpose of launching; can prevent launching of instance (issue #7883)
  • Clarification and updating of help (issue #12789)
  • The init script was called each time instance was connected to (issue #12771)
  • EC2 slaves fail to launch when using versions prior to 1.9 (issue #7219)
  • Force registration of converter (issue #10118)
  • Convert to Amazon EC2 libraries(issue #12539)
  • Allow non-root user name (issue #5867)
  • Allow specification of security group (issue #8617)
  • Add support for M1 Medium instance (issue #13432)
  • Allow instances to be stopped (instead of terminated (issue #12772)
  • Option to set zone as well as region for instance (issue #8946)

Version 1.14 (Feb 22, 2012)

  • Fixed a typo in Tokyo region name, and added Oregon and Sao Paulo regions.

Version 1.13 (Jul 29, 2011)

Version 1.12 (Jul 19, 2011)

  • Label expressions are handled correctly (issue #9773)
  • Fixed a false-positive "check AMI" validation error (issue #9415)

Version 1.11 (Mar 15, 2011)

  • Fixed a bug in the form validation (issue #6063)
  • Reuse the client for better resource usage (pull request).
  • SSH port is now configurable
  • Eucalyptus doesn't report the IP address right away, so we need to keep checking. (issue #5851)
  • Added new Tokyo region.

Version 1.10 (Nov 7 2010)

  • Added APAC region support.

Version 1.9 (Aug 11 2010)

  • Fixed bug in backwards-compatibility of persisted configuration (issue #6782)

Version 1.8 (Apr 09 2010)

  • Fixed the fatal problem in configuration persistence (issue #6113)

Version 1.7 (Mar 17 2010)

Version 1.6 (Feb 15 2010)

Version 1.5 (Nov 20 2009)

  • Number of executors wasn't properly persisted (issue #4906)

Version 1.4 (Aug 5 2009)

  • Jenkins does several retries on SSH logins to give sshd extra time to initialize itself (issue #4119)

Version 1.3 (July 27 2009)

  • User-data can be now specified to the launching instances (issue #4115)
  • # of executors can be now configured (issue #4116)

Version 1.2 (Jun 18 2009)

  • Fixed the dependency issue with recent Jenkins

Version 1.1 (May 28 2009)

  • Re-implemented the instance cap so that it uses AWS API for # of instances to prevent run-away EC2 instances.
  • Improved the performance of instance launches
  • Fixed a bug where a long init script may cause Jenkins to start additional instances.
  • If the init script has run once, don't run it again when reconnecting.

Version 1.0

  • Initial release

Developer Information

ec2 plugin build

Labels

Edit
plugin-cluster plugin-cluster Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Add Comment