DockerSlaveProvisioner (Docker plugin 0.18 API)

java.lang.Object
- io.jenkins.docker.DockerSlaveProvisioner

Direct Known Subclasses:

AttachedDockerSlaveProvisioner, JNLPDockerSlaveProvisioner, SSHDockerSlaveProvisioner
```
public abstract class DockerSlaveProvisioner
extends Object
```
Responsible to create the adequate (set of) container(s) to run a Jenkins Agent on Docker. Depending on mechanism used to establish the agent's remoting connection (ssh, jnlp, ...) the actual DockerSlave instance might be registered as a Node before or after the container have been created.

Author:

Nicolas De Loof

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.github.dockerjava.api.DockerClient`	`client`
`protected DockerCloud`	`cloud`
`protected String`	`container`
`protected DockerTemplate`	`template`

Constructor Summary

Constructors
Constructor and Description
`DockerSlaveProvisioner(DockerCloud cloud, DockerTemplate template, com.github.dockerjava.api.DockerClient client)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`prepareCreateContainerCommand(com.github.dockerjava.api.command.CreateContainerCmd cmd)` Implementation can override this method to customize the container to be created as Jenkins Agent.
`abstract DockerSlave`	`provision()` Provision and setup container(s) to create an active `DockerSlave`.
`protected void`	`pullImage()`
`protected String`	`runContainer()`
`protected void`	`setupContainer()` Implementation can override this method to customize the container before it get started.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cloud
```
protected final DockerCloud cloud
```

template

protected final DockerTemplate template

client

protected final com.github.dockerjava.api.DockerClient client

container

@CheckForNull
protected String container

Constructor Detail

DockerSlaveProvisioner

public DockerSlaveProvisioner(DockerCloud cloud,
                              DockerTemplate template,
                              com.github.dockerjava.api.DockerClient client)

Method Detail

provision

public abstract DockerSlave provision()
                               throws IOException,
                                      hudson.model.Descriptor.FormException,
                                      InterruptedException

Provision and setup container(s) to create an active DockerSlave.

Throws:: IOException; hudson.model.Descriptor.FormException; InterruptedException

runContainer

protected String runContainer()
                       throws IOException,
                              InterruptedException

Throws:: IOException; InterruptedException

pullImage
```
protected void pullImage()
```

prepareCreateContainerCommand

protected void prepareCreateContainerCommand(com.github.dockerjava.api.command.CreateContainerCmd cmd)
                                      throws com.github.dockerjava.api.exception.DockerException,
                                             IOException

Implementation can override this method to customize the container to be created as Jenkins Agent. Typically : inject environment variables

Throws:: com.github.dockerjava.api.exception.DockerException; IOException

setupContainer
```
protected void setupContainer()
                       throws IOException,
                              InterruptedException
```
Implementation can override this method to customize the container before it get started. Typically : copy slave.jar into container, etc

Throws:

IOException

InterruptedException

Class DockerSlaveProvisioner