com.nirima.jenkins.plugins.docker

Class DockerCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

com.nirima.jenkins.plugins.docker.DockerCloud

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 DockerCloud
extends hudson.slaves.Cloud

Docker Cloud configuration. Contains connection configuration, DockerTemplate contains configuration for running docker image.

Author:

magnayn

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerCloud.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
String	credentialsId Deprecated.
String	dockerHostname
int	readTimeout
String	version

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description
DockerCloud(String name, List<? extends DockerTemplate> templates, org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint dockerHost, int containerCap, int connectTimeout, int readTimeout, String version, String dockerHostname)
DockerCloud(String name, List<? extends DockerTemplate> templates, String serverUrl, int containerCap, int connectTimeout, int readTimeout, String credentialsId, String version, String dockerHostname) Deprecated.
DockerCloud(String name, List<? extends DockerTemplate> templates, String serverUrl, String containerCapStr, int connectTimeout, int readTimeout, String credentialsId, String version, String dockerHostname) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addJobTemplate(long jobId, DockerTemplate template) Adds a template which is temporary provided and bound to a specific job.
void	addTemplate(DockerTemplate t) Add a new template to the cloud
boolean	canProvision(hudson.model.Label label)
int	countCurrentDockerSlaves(String imageName) Counts the number of instances in Docker currently running that are using the specified image.
boolean	equals(Object o)
com.github.dockerjava.api.DockerClient	getClient() Connects to Docker.
static DockerCloud	getCloudByName(String name)
int	getConnectTimeout()
int	getContainerCap()
String	getContainerCapStr() Deprecated. use getContainerCap()
org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint	getDockerHost()
String	getDockerHostname()
String	getServerUrl() Deprecated.
DockerTemplate	getTemplate(hudson.model.Label label) Gets first DockerTemplate that has the matching Label.
DockerTemplate	getTemplate(String template)
List<DockerTemplate>	getTemplates()
List<DockerTemplate>	getTemplates(hudson.model.Label label) Multiple amis can have the same label.
boolean	isExposeDockerHost()
boolean	isTriton()
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)
Object	readResolve()
void	removeJobTemplate(long jobId) Removes a template which is bound to a specific job.
void	removeTemplate(DockerTemplate t) Remove Docker template
static String	runContainer(DockerTemplateBase dockerTemplateBase, com.github.dockerjava.api.DockerClient dockerClient, DockerComputerLauncher launcher) for publishers/builders.
protected String	sanitizeUrl(String url)
void	setContainerCap(int containerCap)
void	setExposeDockerHost(boolean exposeDockerHost)
protected boolean	shouldPullImage(String imageName, DockerImagePullStrategy pullStrategy)
String	toString()

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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

credentialsId

@Deprecated
public transient String credentialsId

Deprecated.

readTimeout

public final int readTimeout

version

public final String version

dockerHostname

public final String dockerHostname

Constructor Detail

DockerCloud

@DataBoundConstructor
public DockerCloud(String name,
                                         List<? extends DockerTemplate> templates,
                                         org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint dockerHost,
                                         int containerCap,
                                         int connectTimeout,
                                         int readTimeout,
                                         String version,
                                         String dockerHostname)

DockerCloud

@Deprecated
public DockerCloud(String name,
                               List<? extends DockerTemplate> templates,
                               String serverUrl,
                               int containerCap,
                               int connectTimeout,
                               int readTimeout,
                               String credentialsId,
                               String version,
                               String dockerHostname)

Deprecated.

DockerCloud

@Deprecated
public DockerCloud(String name,
                               List<? extends DockerTemplate> templates,
                               String serverUrl,
                               String containerCapStr,
                               int connectTimeout,
                               int readTimeout,
                               String credentialsId,
                               String version,
                               String dockerHostname)

Deprecated.

Method Detail

getConnectTimeout

public int getConnectTimeout()

getDockerHost

public org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint getDockerHost()

getServerUrl

@Deprecated
public String getServerUrl()

Deprecated.

getDockerHostname

public String getDockerHostname()

getContainerCapStr

@Deprecated
public String getContainerCapStr()

Deprecated. use getContainerCap()

getContainerCap

public int getContainerCap()

setContainerCap

public void setContainerCap(int containerCap)

sanitizeUrl

protected String sanitizeUrl(String url)

getClient

public com.github.dockerjava.api.DockerClient getClient()

Connects to Docker.

Returns:

Docker client.

provision

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

Specified by:

provision in class hudson.slaves.Cloud

runContainer

public static String runContainer(DockerTemplateBase dockerTemplateBase,
                                  com.github.dockerjava.api.DockerClient dockerClient,
                                  DockerComputerLauncher launcher)

for publishers/builders. Simply runs container in docker cloud

shouldPullImage

protected boolean shouldPullImage(String imageName,
                                  DockerImagePullStrategy pullStrategy)

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud

getTemplate

@CheckForNull
public DockerTemplate getTemplate(String template)

getTemplate

@CheckForNull
public DockerTemplate getTemplate(hudson.model.Label label)

Gets first DockerTemplate that has the matching Label.

addTemplate

public void addTemplate(DockerTemplate t)

Add a new template to the cloud

addJobTemplate

public void addJobTemplate(long jobId,
                           DockerTemplate template)

Adds a template which is temporary provided and bound to a specific job.

Parameters:

jobId - Unique id (per master) of the job to which the template is bound.

template - The template to bound to a specific job.

removeJobTemplate

public void removeJobTemplate(long jobId)

Removes a template which is bound to a specific job.

Parameters:

jobId - Id of the job.

getTemplates

public List<DockerTemplate> getTemplates()

getTemplates

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

Multiple amis can have the same label.

Returns:

Templates matched to requested label assuming slave Mode

removeTemplate

public void removeTemplate(DockerTemplate t)

Remove Docker template

countCurrentDockerSlaves

public int countCurrentDockerSlaves(String imageName)
                             throws Exception

Counts the number of instances in Docker currently running that are using the specified image.

Parameters:

imageName - If null, then all instances are counted.

This includes those instances that may be started outside Hudson.

Throws:

Exception

getCloudByName

public static DockerCloud getCloudByName(String name)

readResolve

public Object readResolve()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

isTriton

public boolean isTriton()

isExposeDockerHost

public boolean isExposeDockerHost()

setExposeDockerHost

@DataBoundSetter
public void setExposeDockerHost(boolean exposeDockerHost)