com.dubture.jenkins.digitalocean

Class DigitalOceanCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.slaves.Cloud

com.dubture.jenkins.digitalocean.DigitalOceanCloud

All Implemented Interfaces:

ExtensionPoint, Describable<Cloud>, ModelObject, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithContextMenu

public class DigitalOceanCloud
extends Cloud

The DigitalOceanCloud 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	DigitalOceanCloud.ConverterImpl
static class	DigitalOceanCloud.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem

Field Summary

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description
DigitalOceanCloud(String name, String sshKeyId, String instanceCap, Boolean usePrivateNetworking, String timeoutMinutes, String connectionRetryWait, List<? extends SlaveTemplate> templates) Constructor parameters are injected via jelly in the jenkins global configuration
DigitalOceanCloud(String name, String authToken, String privateKey, String sshKeyId, String instanceCap, Boolean usePrivateNetworking, String timeoutMinutes, String connectionRetryWait, List<? extends SlaveTemplate> templates) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	canProvision(Label label)
com.myjeeva.digitalocean.impl.DigitalOceanClient	getApiClient()
String	getAuthTokenCredentialId()
static String	getAuthTokenFromCredentialId(String credentialId)
Integer	getConnectionRetryWait()
String	getDisplayName()
int	getInstanceCap()
String	getName()
String	getPrivateKeyCredentialId()
static String	getPrivateKeyFromCredentialId(String credentialId)
int	getSshKeyId()
List<SlaveTemplate>	getTemplates()
Integer	getTimeoutMinutes()
Boolean	getUsePrivateNetworking()
Collection<NodeProvisioner.PlannedNode>	provision(Label label, int excessWorkload) The actual logic for provisioning a new droplet when it's needed by Jenkins.
protected Object	readResolve()
void	setAuthTokenCredentialId(String credentialId)
void	setPrivateKeyCredentialId(String credentialId)

Methods inherited from class hudson.slaves.Cloud

all, getACL, getDescriptor, getSearchUrl, getUrl

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic, removeAction, removeActions, replaceAction, replaceActions

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

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission

Constructor Detail

DigitalOceanCloud

@Deprecated
public DigitalOceanCloud(String name,
                                     String authToken,
                                     String privateKey,
                                     String sshKeyId,
                                     String instanceCap,
                                     Boolean usePrivateNetworking,
                                     String timeoutMinutes,
                                     String connectionRetryWait,
                                     List<? extends SlaveTemplate> templates)

Deprecated.

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

usePrivateNetworking - Whether to use private networking to connect to the cloud.

timeoutMinutes - the timeout in minutes.

connectionRetryWait - the time to wait for SSH connections to work

templates - the templates for this cloud

DigitalOceanCloud

@DataBoundConstructor
public DigitalOceanCloud(String name,
                                               String sshKeyId,
                                               String instanceCap,
                                               Boolean usePrivateNetworking,
                                               String timeoutMinutes,
                                               String connectionRetryWait,
                                               List<? extends SlaveTemplate> templates)

Constructor parameters are injected via jelly in the jenkins global configuration

Parameters:

name - A name associated with this cloud configuration

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

instanceCap - the maximum number of instances that can be started

usePrivateNetworking - Whether to use private networking to connect to the cloud.

timeoutMinutes - the timeout in minutes.

connectionRetryWait - the time to wait for SSH connections to work

templates - the templates for this cloud

Method Detail

setPrivateKeyCredentialId

@DataBoundSetter
public void setPrivateKeyCredentialId(String credentialId)

getPrivateKeyCredentialId

public String getPrivateKeyCredentialId()

setAuthTokenCredentialId

@DataBoundSetter
public void setAuthTokenCredentialId(String credentialId)

getAuthTokenCredentialId

public String getAuthTokenCredentialId()

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class Cloud

provision

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

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

Specified by:

provision in class Cloud

Parameters:

label - name of the field

excessWorkload - if the workload can be overloaded

Returns:

the number of planned nodes

canProvision

public boolean canProvision(Label label)

Specified by:

canProvision in class Cloud

getName

public String getName()

getAuthTokenFromCredentialId

public static String getAuthTokenFromCredentialId(String credentialId)

getPrivateKeyFromCredentialId

public static String getPrivateKeyFromCredentialId(String credentialId)

getSshKeyId

public int getSshKeyId()

getInstanceCap

public int getInstanceCap()

getApiClient

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

getTemplates

public List<SlaveTemplate> getTemplates()

getTimeoutMinutes

public Integer getTimeoutMinutes()

getConnectionRetryWait

public Integer getConnectionRetryWait()

getUsePrivateNetworking

public Boolean getUsePrivateNetworking()

readResolve

protected Object readResolve()