com.nirima.jenkins.plugins.docker

Class DockerTemplate

java.lang.Object

com.nirima.jenkins.plugins.docker.DockerTemplate

All Implemented Interfaces:

hudson.model.Describable<DockerTemplate>

public class DockerTemplate
extends Object
implements hudson.model.Describable<DockerTemplate>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerTemplate.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field and Description
int	instanceCap
String	remoteFs
String	remoteFsMapping

Constructor Summary

Constructors

Constructor and Description
DockerTemplate() fully default
DockerTemplate(DockerTemplateBase dockerTemplateBase, String labelString, String remoteFs, String remoteFsMapping, String instanceCapStr, List<? extends hudson.slaves.NodeProperty<?>> nodeProperties)
DockerTemplate(DockerTemplateBase dockerTemplateBase, String labelString, String remoteFs, String remoteFsMapping, String instanceCapStr, List<? extends hudson.slaves.NodeProperty<?>> nodeProperties, hudson.model.Node.Mode mode, int numExecutors, DockerComputerLauncher launcher, hudson.slaves.RetentionStrategy retentionStrategy, boolean removeVolumes, DockerImagePullStrategy pullStrategy) Contains all available arguments

Method Summary

Modifier and Type	Method and Description
com.github.dockerjava.api.command.CreateContainerCmd	fillContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig)
static String[]	filterStringArray(String[] arr)
Integer	getCpuShares()
hudson.model.Descriptor<DockerTemplate>	getDescriptor()
String	getDisplayName()
String	getDnsString()
String[]	getDockerCommandArray()
DockerTemplateBase	getDockerTemplateBase()
String	getEnvironmentsString()
List<String>	getExtraHosts()
String	getExtraHostsString()
String	getFullImageId()
String	getImage()
int	getInstanceCap()
String	getInstanceCapStr()
Set<hudson.model.labels.LabelAtom>	getLabelSet()
String	getLabelString()
DockerComputerLauncher	getLauncher()
String	getMacAddress()
Integer	getMemoryLimit()
Integer	getMemorySwap()
hudson.model.Node.Mode	getMode()
List<? extends hudson.slaves.NodeProperty<?>>	getNodeProperties()
int	getNumExecutors()
Iterable<com.github.dockerjava.api.model.PortBinding>	getPortMappings()
DockerSlaveProvisioner	getProvisioner(DockerCloud cloud)
DockerImagePullStrategy	getPullStrategy()
org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint	getRegistry()
String	getRemoteFs()
String	getRemoteFsMapping()
hudson.slaves.RetentionStrategy	getRetentionStrategy()
hudson.slaves.RetentionStrategy	getRetentionStrategyCopy() tmp fix for terminating boolean caching
String	getShortDescription()
String[]	getVolumes()
String	getVolumesFrom() Deprecated.
String[]	getVolumesFrom2()
String	getVolumesFromString()
String	getVolumesString()
boolean	isRemoveVolumes()
Object	readResolve() Initializes data structure that we don't persist.
void	setDockerTemplateBase(DockerTemplateBase dockerTemplateBase)
void	setLauncher(DockerComputerLauncher launcher)
void	setMode(hudson.model.Node.Mode mode)
void	setNodeProperties(List<? extends hudson.slaves.NodeProperty<?>> nodeProperties)
void	setNumExecutors(int numExecutors) Experimental option allows set number of executors
void	setPullStrategy(DockerImagePullStrategy pullStrategy)
void	setRemoveVolumes(boolean removeVolumes)
void	setRetentionStrategy(hudson.slaves.RetentionStrategy retentionStrategy)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

remoteFsMapping

public final String remoteFsMapping

remoteFs

public String remoteFs

instanceCap

public final int instanceCap

Constructor Detail

DockerTemplate

public DockerTemplate()

fully default

DockerTemplate

@DataBoundConstructor
public DockerTemplate(@Nonnull
                                            DockerTemplateBase dockerTemplateBase,
                                            String labelString,
                                            String remoteFs,
                                            String remoteFsMapping,
                                            String instanceCapStr,
                                            List<? extends hudson.slaves.NodeProperty<?>> nodeProperties)

DockerTemplate

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public DockerTemplate(@Nonnull
                                                                                             DockerTemplateBase dockerTemplateBase,
                                                                                             String labelString,
                                                                                             String remoteFs,
                                                                                             String remoteFsMapping,
                                                                                             String instanceCapStr,
                                                                                             List<? extends hudson.slaves.NodeProperty<?>> nodeProperties,
                                                                                             hudson.model.Node.Mode mode,
                                                                                             int numExecutors,
                                                                                             DockerComputerLauncher launcher,
                                                                                             hudson.slaves.RetentionStrategy retentionStrategy,
                                                                                             boolean removeVolumes,
                                                                                             DockerImagePullStrategy pullStrategy)

Contains all available arguments

Throws:

IOException

Method Detail

getProvisioner

public DockerSlaveProvisioner getProvisioner(DockerCloud cloud)

filterStringArray

public static String[] filterStringArray(String[] arr)

getImage

public String getImage()

getDnsString

public String getDnsString()

getVolumes

@CheckForNull
public String[] getVolumes()

getVolumesString

public String getVolumesString()

getVolumesFrom

@Deprecated
public String getVolumesFrom()

Deprecated.

getVolumesFrom2

public String[] getVolumesFrom2()

getVolumesFromString

public String getVolumesFromString()

getMacAddress

@CheckForNull
public String getMacAddress()

getDisplayName

public String getDisplayName()

getMemoryLimit

public Integer getMemoryLimit()

getMemorySwap

public Integer getMemorySwap()

getCpuShares

public Integer getCpuShares()

getDockerCommandArray

public String[] getDockerCommandArray()

getPortMappings

public Iterable<com.github.dockerjava.api.model.PortBinding> getPortMappings()

getEnvironmentsString

public String getEnvironmentsString()

getExtraHosts

@CheckForNull
public List<String> getExtraHosts()

getExtraHostsString

public String getExtraHostsString()

getRegistry

public org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint getRegistry()

fillContainerConfig

public com.github.dockerjava.api.command.CreateContainerCmd fillContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig)

getFullImageId

public String getFullImageId()

getDockerTemplateBase

public DockerTemplateBase getDockerTemplateBase()

setDockerTemplateBase

public void setDockerTemplateBase(DockerTemplateBase dockerTemplateBase)

isRemoveVolumes

public boolean isRemoveVolumes()

setRemoveVolumes

@DataBoundSetter
public void setRemoveVolumes(boolean removeVolumes)

getLabelString

public String getLabelString()

setMode

@DataBoundSetter
public void setMode(hudson.model.Node.Mode mode)

getMode

public hudson.model.Node.Mode getMode()

setNumExecutors

@DataBoundSetter
public void setNumExecutors(int numExecutors)

Experimental option allows set number of executors

getNumExecutors

public int getNumExecutors()

setRetentionStrategy

@DataBoundSetter
public void setRetentionStrategy(hudson.slaves.RetentionStrategy retentionStrategy)

getRetentionStrategy

public hudson.slaves.RetentionStrategy getRetentionStrategy()

getRetentionStrategyCopy

public hudson.slaves.RetentionStrategy getRetentionStrategyCopy()

tmp fix for terminating boolean caching

setLauncher

@DataBoundSetter
public void setLauncher(DockerComputerLauncher launcher)

getLauncher

public DockerComputerLauncher getLauncher()

getRemoteFs

public String getRemoteFs()

getInstanceCapStr

public String getInstanceCapStr()

getInstanceCap

public int getInstanceCap()

getRemoteFsMapping

public String getRemoteFsMapping()

getLabelSet

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

getPullStrategy

public DockerImagePullStrategy getPullStrategy()

setPullStrategy

@DataBoundSetter
public void setPullStrategy(DockerImagePullStrategy pullStrategy)

getNodeProperties

public List<? extends hudson.slaves.NodeProperty<?>> getNodeProperties()

setNodeProperties

@DataBoundSetter
public void setNodeProperties(List<? extends hudson.slaves.NodeProperty<?>> nodeProperties)
                                        throws IOException

Throws:

IOException

readResolve

public Object readResolve()

Initializes data structure that we don't persist.

toString

public String toString()

Overrides:

toString in class Object

getShortDescription

public String getShortDescription()

getDescriptor

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

Specified by:

getDescriptor in interface hudson.model.Describable<DockerTemplate>