com.github.kostyasha.yad

Class DockerCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

com.github.kostyasha.yad.commons.AbstractCloud

com.github.kostyasha.yad.DockerCloud

All Implemented Interfaces:

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

public class DockerCloud
extends AbstractCloud
implements Serializable

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

See Also:

Serialized Form

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 inherited from class com.github.kostyasha.yad.commons.AbstractCloud

containerCap, provisionedImages, templates

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description
DockerCloud(String name, List<DockerSlaveTemplate> templates, int containerCap, DockerConnector connector)

Method Summary

Modifier and Type	Method and Description
int	countCurrentDockerSlaves(DockerSlaveTemplate template) Counts the number of instances in Docker currently running that are using the specified template.
boolean	equals(Object o)
com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.DockerClient	getClient() Connects to Docker.
static DockerCloud	getCloudByName(String name)
DockerConnector	getConnector()
DockerCloud.DescriptorImpl	getDescriptor()
int	hashCode()
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)
Object	readResolve()
String	runContainer(DockerSlaveTemplate slaveTemplate) Run docker container for given template
DockerCloud	setConnector(DockerConnector connector)
String	toString()

Methods inherited from class com.github.kostyasha.yad.commons.AbstractCloud

addTemplate, canProvision, decrementAmiSlaveProvision, getContainerCap, getTemplate, getTemplate, getTemplateById, getTemplates, getTemplates, removeTemplate, setContainerCap, setTemplates

Methods inherited from class hudson.slaves.Cloud

all, checkPermission, getACL, 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, notify, notifyAll, wait, wait, wait

Constructor Detail

DockerCloud

@DataBoundConstructor
public DockerCloud(String name,
                                         List<DockerSlaveTemplate> templates,
                                         int containerCap,
                                         @Nonnull
                                         DockerConnector connector)

Method Detail

getConnector

public DockerConnector getConnector()

setConnector

public DockerCloud setConnector(DockerConnector connector)

getClient

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

Connects to Docker.

Returns:

Docker client.

provision

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

Specified by:

provision in class hudson.slaves.Cloud

runContainer

public String runContainer(DockerSlaveTemplate slaveTemplate)
                    throws com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.exception.DockerException,
                           IOException

Run docker container for given template

Returns:

container id

Throws:

com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.exception.DockerException

IOException

countCurrentDockerSlaves

public int countCurrentDockerSlaves(DockerSlaveTemplate template)
                             throws Exception

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

Parameters:

template - If null, then all instances are counted.

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDescriptor

public DockerCloud.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.slaves.Cloud>

Overrides:

getDescriptor in class hudson.slaves.Cloud