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(String, String, String, String, Integer) 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
hudson.model.Descriptor<SlaveTemplate>	getDescriptor()
int	getIdleTerminationInMinutes()
String	getImageId()
String	getInitScript()
int	getInstanceCap()
String	getLabels()
Set<hudson.model.labels.LabelAtom>	getLabelSet()
String	getLabelString()
String	getName()
int	getNumExecutors()
String	getRegionId()
String	getSizeId()
int	getSshPort()
String	getUserData()
String	getUsername()
String	getWorkspacePath()
boolean	isInstanceCapReached(String authToken, String cloudName)
Slave	provision(String dropletName, String cloudName, String authToken, String privateKey, Integer sshKeyId)
protected Object	readResolve()

Methods inherited from class java.lang.Object

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

Constructor Detail

SlaveTemplate

@DataBoundConstructor
public SlaveTemplate(String name,
                                           String imageId,
                                           String sizeId,
                                           String regionId,
                                           String username,
                                           String workspacePath,
                                           Integer sshPort,
                                           String idleTerminationInMinutes,
                                           String numExecutors,
                                           String labelString,
                                           String instanceCap,
                                           String userData,
                                           String initScript)

Data is injected from the global Jenkins configuration via jelly.

Parameters:

imageId - an image slug e.g. "debian-8-x64", or an integer e.g. of a backup, such as "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

isInstanceCapReached

public boolean isInstanceCapReached(String authToken,
                                    String cloudName)
                             throws com.myjeeva.digitalocean.exception.RequestUnsuccessfulException,
                                    com.myjeeva.digitalocean.exception.DigitalOceanException

Throws:

com.myjeeva.digitalocean.exception.RequestUnsuccessfulException

com.myjeeva.digitalocean.exception.DigitalOceanException

provision

public Slave provision(String dropletName,
                       String cloudName,
                       String authToken,
                       String privateKey,
                       Integer sshKeyId)
                throws IOException,
                       com.myjeeva.digitalocean.exception.RequestUnsuccessfulException,
                       hudson.model.Descriptor.FormException

Throws:

IOException

com.myjeeva.digitalocean.exception.RequestUnsuccessfulException

hudson.model.Descriptor.FormException

getDescriptor

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

Specified by:

getDescriptor in interface hudson.model.Describable<SlaveTemplate>

getName

public String getName()

getSizeId

public String getSizeId()

getRegionId

public String getRegionId()

getLabels

public String getLabels()

getLabelString

public String getLabelString()

getLabelSet

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

getImageId

public String getImageId()

getUsername

public String getUsername()

getWorkspacePath

public String getWorkspacePath()

getNumExecutors

public int getNumExecutors()

getIdleTerminationInMinutes

public int getIdleTerminationInMinutes()

getInstanceCap

public int getInstanceCap()

getUserData

public String getUserData()

getInitScript

public String getInitScript()

getSshPort

public int getSshPort()

readResolve

protected Object readResolve()