Jenkins EC2 Plugin Configuration via Groovy

ec2_cloud.groovy

/*
 * Configure the Jenkins EC2 Plugin via Groovy Script
 * EC2 Plugin URL: https://wiki.jenkins-ci.org/display/JENKINS/Amazon+EC2+Plugin
 */

import hudson.model.*
import jenkins.model.*
import hudson.plugins.ec2.*
import com.amazonaws.services.ec2.model.InstanceType
  
def instance = Jenkins.getInstance()

def ec2_cloud_name = 'gist-example-cloud'
def ec2_instance_cap = 5

def worker_description = 'jenkins-worker'
def worker_label_string = 'worker'

def ami_id = 'ami-AAAAAAAA'
def security_groups = 'sg-11111111,sg-22222222'
def subnet_id = 'subnet-SSSSSSSS'
def instance_type = 'm3.2xlarge'
def instance_profile_arn = 'arn:aws:iam::123456789012:instance-profile/JenkinsInstanceProfile'

def number_of_executors = 8

def ec2_tags = [
  new EC2Tag('Name', 'jenkins-worker')
]

def priv_key_txt = '''
-----BEGIN RSA PRIVATE KEY-----
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-----END RSA PRIVATE KEY-----
'''

  

def worker_ami = new SlaveTemplate(
  // String ami
  ami_id,
  // String zone
  '',
  // SpotConfiguration spotConfig
  null,
  // String securityGroups
  security_groups,
  // String remoteFS
  '',
  // InstanceType type
  InstanceType.fromValue(instance_type),
  // boolean ebsOptimized
  false,
  // String labelString
  worker_label_string,
  // Node.Mode mode
  Node.Mode.NORMAL,
  // String description
  worker_description,
  // String initScript
  '',
  // String tmpDir
  '',
  // String userData
  '',
  // String numExecutors
  "${number_of_executors}",
  // String remoteAdmin
  '',
  // AMITypeData amiType
  new UnixData(null, null),
  // String jvmopts
  '',
  // boolean stopOnTerminate
  false,
  // String subnetId
  subnet_id,
  // List<EC2Tag> tags
  ec2_tags,
  // String idleTerminationMinutes
  '30',
  // boolean usePrivateDnsName
  true,
  // String instanceCapStr
  '50',
  // String iamInstanceProfile
  instance_profile_arn,
  // boolean useEphemeralDevices
  true,
  // boolean useDedicatedTenancy
  false,
  // String launchTimeoutStr
  '1800',
  // boolean associatePublicIp
  false,
  // String customDeviceMapping
  '',
  // boolean connectBySSHProcess
  false,
  // boolean connectUsingPublicIp
  false
)

def new_cloud = new AmazonEC2Cloud(
  // String cloudName
  ec2_cloud_name,
  // boolean useInstanceProfileForCredentials
  true,
  // String credentialsId
  '',
  // String region
  'us-east-1',
  // String privateKey
  priv_key_txt,
  // String instanceCapStr
  "${ec2_instance_cap}",
  // List<? extends SlaveTemplate> templates
  [worker_ami]
)

instance.clouds.add(new_cloud)

Will this overwrite the configuration that is currently in place?

@tleahygoogle I don't believe it will - I believe it will add a new cloud configuration. If you want to modify existing cloud configs, I believe you could do something like:

def instance = Jenkins.getInstance()
def clouds = instance.clouds

And clouds would be a list of Cloud objects.

import hudson.model.*
import hudson.node_monitors.*
import hudson.slaves.*
import java.util.concurrent.*
import jenkins.model.*
import hudson.plugins.ec2.*
import com.amazonaws.services.ec2.model.*
jenkins = Hudson.instance
def now = new Date()
def instance = Jenkins.getInstance()
def clouds = instance.clouds
def ami_id = 'ami-xyz'
def temp=instance.clouds[0].getTemplates()[0]
temp.setAmi(ami_id)

this works if you can get the ami id from somewhere.

is there any way that we can configure ssh keys dynamically, like generating and adding same.

I'm using jenkinsci docker image as microservice and trying to auto fill all the ec2 info with environment variables. Docker's .env files can be used to specify ami configurations info but not sure of injecting aws credentials in to the plugin with out exposing on the source code. help me!! if I it's a good practice to have a dedicated iam user for an s3 file with credentails and then add the user to ec2 instance running jenkins on docker.

Awesome work man!

Very helpful, thanks.

It was great starting point.
In Version 1.44.1 both SlaveTemplate and AmazonEC2Cloud constructors have been changed.
The below works in Version 1.44.1
////////////////////////////////////////////////////////////////////////////////////////////
import hudson.model.*
import jenkins.model.*
import hudson.plugins.ec2.*
import com.amazonaws.services.ec2.model.InstanceType

def instance = Jenkins.getInstance()

def ec2_cloud_name = 'jenkins-slaves'
def ec2_instance_cap = 5

def worker_description = 'java-slave'
def worker_label_string = 'java'

def ami_id = 'ami-xxxxxx'
def security_groups = 'jenkins-sg'
def subnet_id = 'subnet-xxxxx1 subnet-xxxxx2 subnet-xxxxxx3'
def instance_type = 't2.medium'
def instance_profile_arn = 'arn:aws:iam::123123123:instance-profile/jenkins-role'

def number_of_executors = 4

def ec2_tags = [
new EC2Tag('Name', 'jenkins-java-worker')
]

def priv_key_txt = '''
-----BEGIN RSA PRIVATE KEY-----
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-----END RSA PRIVATE KEY-----
'''

def worker_ami = new SlaveTemplate(
// String ami
ami_id,
// String zone
'',
// SpotConfiguration spotConfig
null,
// String securityGroups
security_groups,
// String remoteFS
'/home/ubuntu',
// InstanceType type
InstanceType.fromValue(instance_type),
// boolean ebsOptimized
false,
// String labelString
worker_label_string,
// Node.Mode mode
Node.Mode.NORMAL,
// String description
worker_description,
// String initScript
'',
// String tmpDir
'',
// String userData
'',
// String numExecutors
"${number_of_executors}",
// String remoteAdmin
'ubuntu',
// AMITypeData amiType
new UnixData('', '', '', '22'),
// String jvmopts
'',
// boolean stopOnTerminate
false,
// String subnetId
subnet_id,
// List tags
ec2_tags,
// String idleTerminationMinutes
'15',
// // boolean usePrivateDnsName
// true,
// String instanceCapStr
'50',
// String iamInstanceProfile
instance_profile_arn,
// boolean deleteRootOnTermination
true,
// boolean useEphemeralDevices
false,
// boolean useDedicatedTenancy
false,
// String launchTimeoutStr
'1800',
// boolean associatePublicIp
false,
// String customDeviceMapping
'',
// boolean connectBySSHProcess
false,
// boolean monitoring
false,
// boolean t2Unlimited
false,
// ConnectionStrategy connectionStrategy
hudson.plugins.ec2.ConnectionStrategy.PRIVATE_IP,
// int maxTotalUses
-1

)

def new_cloud = new AmazonEC2Cloud(
// String cloudName
ec2_cloud_name,
// boolean useInstanceProfileForCredentials
true,
// String credentialsId
'',
// String region
'eu-central-1',
// String privateKey
priv_key_txt,
// String instanceCapStr
"${ec2_instance_cap}",
// List<? extends SlaveTemplate> templates
[worker_ami ],
//String roleArn
'',
//String roleSessionName
''
)

instance.clouds.add(new_cloud)

Thank you,It worked. How to add host verification strategy here ?

Hi, this code only updates in-memory config. How to trigger save to disk and trigger Job Configuration History to commit the new config?
Edit: to save the new config to disk you need to call: instance.save()

Here is how I do it:

// get Jenkins instance
Jenkins jenkins = Jenkins.getInstance()

// add cloud configuration
jenkins.clouds.add(amazonEC2Cloud)

// save current Jenkins state to disk
jenkins.save()
echo "Added new Ec2 Cloud for worker nodes: ${thisCloudname} - ${thisDescription}"