Package it.dockins.dockerslaves.api

Class OneShotSlave

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Node

hudson.model.Slave

it.dockins.dockerslaves.api.OneShotSlave

All Implemented Interfaces:

ExtensionPoint, Describable<Node>, ModelObject, PersistenceRoot, ReconfigurableDescribable<Node>, Saveable, SearchableModelObject, SearchItem, AccessControlled, EphemeralNode, Serializable, OnMaster

Direct Known Subclasses:

DockerSlave

public abstract class OneShotSlave
extends Slave
implements EphemeralNode

A slave that is designed to be used only once, for a specific $Run, and as such has a life cycle to fully match the Run's one.

Provisioning such a slave should be a lightweight process, so one can provision them at any time and concurrently to match $Queue load. Typical usage is Docker container based Jenkins agents.

Actual launch of the Slave is postponed until a $Run is created, so we can have a 1:1 match between Run and Executor lifecycle:

• dump the launch log in build log.
• mark the build as $Result.NOT_BUILT on launch failure.
• shut down and remove the Executor on build completion

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Slave

Slave.JnlpJar, Slave.SlaveDescriptor

Nested classes/interfaces inherited from class hudson.model.Node

Node.Mode

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final RunListener	RUN_LISTENER	We listen to loggers creation by $Runs so we can write the executor's launch log into build log.

Fields inherited from class hudson.model.Slave

name, remoteFS

Fields inherited from class hudson.model.Node

holdOffLaunchUntilSave, SKIP_BUILD_CHECK_ON_FLYWEIGHTS

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
OneShotSlave(String name, String nodeDescription, String remoteFS, String labelString, ComputerLauncher launcher)

Method Summary

Modifier and Type	Method	Description
Launcher	createLauncher(TaskListener listener)	Pipeline does not use the same mechanism to use nodes, so we also need to consider $createLauncher(TaskListener) as an event to determine first use of the slave.
OneShotComputer	getComputer()
int	getNumExecutors()

Methods inherited from class hudson.model.Slave

createComputer, drainLabelsToTrim, equals, getClockDifferenceCallable, getDescriptor, getLabelAtomSet, getLabelString, getLauncher, getMode, getNodeDescription, getNodeName, getNodeProperties, getRemoteFS, getRetentionStrategy, getRootPath, getUserId, getWorkspaceFor, getWorkspaceRoot, hashCode, readResolve, save, setLabelString, setLauncher, setMode, setNodeDescription, setNodeName, setNodeProperties, setNumExecutors, setRetentionStrategy, setUserId, toString

Methods inherited from class hudson.model.Node

canTake, canTake, createPath, getACL, getAssignedLabels, getChannel, getClockDifference, getConfigFile, getDisplayName, getFileSystemProvisioner, getLabelCloud, getNodeProperty, getNodeProperty, getNodePropertyDescriptors, getRootDir, getSearchUrl, getSelfLabel, getTemporaryOfflineCause, isAcceptingTasks, isHoldOffLaunchUntilSave, onLoad, reconfigure, reconfigure, setTemporaryOfflineCause, toComputer

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.slaves.EphemeralNode

asNode

Methods inherited from interface hudson.search.SearchItem

getSearchGroup, getSearchIcon

Field Details

RUN_LISTENER

@Extension(ordinal=1.7976931348623157E308)
public static final RunListener RUN_LISTENER

We listen to loggers creation by $Runs so we can write the executor's launch log into build log. Relying on this implementation detail is fragile, but we don't really have a better option yet.

Constructor Details

OneShotSlave

public OneShotSlave(String name,
 String nodeDescription,
 String remoteFS,
 String labelString,
 ComputerLauncher launcher)
             throws Descriptor.FormException,
IOException

Throws:

Descriptor.FormException

IOException

Method Details

getNumExecutors

public int getNumExecutors()

Overrides:

getNumExecutors in class Slave

getComputer

public OneShotComputer getComputer()

Overrides:

getComputer in class Slave

createLauncher

public Launcher createLauncher(TaskListener listener)

Pipeline does not use the same mechanism to use nodes, so we also need to consider $createLauncher(TaskListener) as an event to determine first use of the slave.

Overrides:

createLauncher in class Slave