com.dubture.jenkins.digitalocean

Class Cloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

com.dubture.jenkins.digitalocean.Cloud

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.slaves.Cloud>, hudson.model.ModelObject, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled

public class Cloud
extends hudson.slaves.Cloud

The Cloud contains the main configuration values for running slaves on DigitalOcean, e.g. apiKey/clientId to connect to the API. The provision(hudson.model.Label, int) method will be called by Jenkins as soon as a new slave needs to be provisioned. The number of

Author:

robert.gruendler@dubture.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cloud.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description
Cloud(String name, String authToken, String privateKey, String sshKeyId, String instanceCap, List<? extends SlaveTemplate> templates) Constructor parameters are injected via jelly in the jenkins global configuration

Method Summary

Modifier and Type	Method and Description
boolean	canProvision(hudson.model.Label label)
com.myjeeva.digitalocean.impl.DigitalOceanClient	getApiClient()
String	getAuthToken()
int	getInstanceCap()
String	getName()
String	getPrivateKey()
int	getSshKeyId()
SlaveTemplate	getTemplateBelowInstanceCap(hudson.model.Label label)
List<SlaveTemplate>	getTemplates()
List<SlaveTemplate>	getTemplates(hudson.model.Label label)
boolean	isInstanceCapReached()
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload) The actual logic for provisioning a new droplet when it's needed by Jenkins.

Methods inherited from class hudson.slaves.Cloud

all, checkPermission, getACL, getDescriptor, getDisplayName, getSearchUrl, hasPermission

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Constructor Detail

Cloud

@DataBoundConstructor
public Cloud(String name,
                                   String authToken,
                                   String privateKey,
                                   String sshKeyId,
                                   String instanceCap,
                                   List<? extends SlaveTemplate> templates)

Constructor parameters are injected via jelly in the jenkins global configuration

Parameters:

name - A name associated with this cloud configuration

authToken - A DigitalOcean V2 API authentication token, generated on their website.

privateKey - An RSA private key in text format

sshKeyId - An identifier (name) for an SSH key known to DigitalOcean

instanceCap - the maximum number of instances that can be started

templates - the templates for this cloud

Method Detail

isInstanceCapReached

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

Throws:

com.myjeeva.digitalocean.exception.RequestUnsuccessfulException

com.myjeeva.digitalocean.exception.DigitalOceanException

provision

public Collection<hudson.slaves.NodeProvisioner.PlannedNode> provision(hudson.model.Label label,
                                                                       int excessWorkload)

The actual logic for provisioning a new droplet when it's needed by Jenkins.

Specified by:

provision in class hudson.slaves.Cloud

Parameters:

label -

excessWorkload -

Returns:

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud

getTemplates

public List<SlaveTemplate> getTemplates(hudson.model.Label label)

getTemplateBelowInstanceCap

public SlaveTemplate getTemplateBelowInstanceCap(hudson.model.Label label)

getName

public String getName()

getAuthToken

public String getAuthToken()

getPrivateKey

public String getPrivateKey()

getSshKeyId

public int getSshKeyId()

getInstanceCap

public int getInstanceCap()

getApiClient

public com.myjeeva.digitalocean.impl.DigitalOceanClient getApiClient()

getTemplates

public List<SlaveTemplate> getTemplates()