com.dubture.jenkins.digitalocean

Class SlaveTemplate

java.lang.Object

com.dubture.jenkins.digitalocean.SlaveTemplate

All Implemented Interfaces:

hudson.model.Describable<SlaveTemplate>

public class SlaveTemplate
extends Object
implements hudson.model.Describable<SlaveTemplate>

A SlaveTemplate represents the configuration values for creating a new slave via a DigitalOcean droplet.

Holds things like Image ID, sizeId and region used for the specific droplet.

The provision(DigitalOceanClient, String, String, Integer, StreamTaskListener) method is the main entry point to create a new droplet via the DigitalOcean API when a new slave needs to be provisioned.

Author:

robert.gruendler@dubture.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SlaveTemplate.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected Cloud	parent

Constructor Summary

Constructors

Constructor and Description
SlaveTemplate(String imageId, String sizeId, String regionId, String idleTerminationInMinutes, String numExecutors, String labelString, String userData, String initScript) Data is injected from the global Jenkins configuration via jelly.

Method Summary

Modifier and Type	Method and Description
String	createDropletName()
hudson.model.Descriptor<SlaveTemplate>	getDescriptor()
int	getIdleTerminationInMinutes()
String	getImageId()
String	getInitScript()
String	getLabels()
Set<hudson.model.labels.LabelAtom>	getLabelSet()
String	getLabelString()
int	getNumExecutors()
Cloud	getParent()
String	getRegionId()
String	getSizeId()
String	getUserData()
Slave	provision(com.myjeeva.digitalocean.impl.DigitalOceanClient apiClient, String dropletName, String privateKey, Integer sshKeyId, hudson.util.StreamTaskListener listener) Creates a new droplet on DigitalOcean to be used as a Jenkins slave.
protected Object	readResolve()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parent

protected transient Cloud parent

Constructor Detail

SlaveTemplate

@DataBoundConstructor
public SlaveTemplate(String imageId,
                                           String sizeId,
                                           String regionId,
                                           String idleTerminationInMinutes,
                                           String numExecutors,
                                           String labelString,
                                           String userData,
                                           String initScript)

Data is injected from the global Jenkins configuration via jelly.

Parameters:

imageId - an image id e.g. "12345678"

sizeId - the image size e.g. "512mb" or "1gb"

regionId - the region e.g. "nyc1"

idleTerminationInMinutes - how long to wait before destroying a slave

numExecutors - the number of executors that this slave supports

labelString - the label for this slave

userData - user data for DigitalOcean to apply when building the slave

initScript - setup script to configure the slave

Method Detail

provision

public Slave provision(com.myjeeva.digitalocean.impl.DigitalOceanClient apiClient,
                       String dropletName,
                       String privateKey,
                       Integer sshKeyId,
                       hudson.util.StreamTaskListener listener)
                throws IOException,
                       com.myjeeva.digitalocean.exception.RequestUnsuccessfulException,
                       hudson.model.Descriptor.FormException

Creates a new droplet on DigitalOcean to be used as a Jenkins slave.

Parameters:

apiClient - the v2 API client to use

privateKey - the RSA private key to use

sshKeyId - the SSH key name name to use

listener - the listener on which to report progress

Returns:

the provisioned Slave

Throws:

IOException

com.myjeeva.digitalocean.exception.RequestUnsuccessfulException

Descriptor.FormException

getDescriptor

public hudson.model.Descriptor<SlaveTemplate> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<SlaveTemplate>

createDropletName

public String createDropletName()

getSizeId

public String getSizeId()

getRegionId

public String getRegionId()

getLabels

public String getLabels()

getLabelString

public String getLabelString()

getLabelSet

public Set<hudson.model.labels.LabelAtom> getLabelSet()

getParent

public Cloud getParent()

getImageId

public String getImageId()

getNumExecutors

public int getNumExecutors()

getIdleTerminationInMinutes

public int getIdleTerminationInMinutes()

getUserData

public String getUserData()

getInitScript

public String getInitScript()

readResolve

protected Object readResolve()