org.jenkinsci.plugins.oneshot

Class OneShotSlave

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Node

hudson.model.Slave

org.jenkinsci.plugins.oneshot.OneShotSlave

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.Node>, hudson.model.ModelObject, hudson.model.ReconfigurableDescribable<hudson.model.Node>, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, hudson.slaves.EphemeralNode, Serializable, jenkins.util.io.OnMaster

public class OneShotSlave
extends hudson.model.Slave
implements hudson.slaves.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

Author:

Nicolas De Loof

See Also:

Serialized Form

Nested Class Summary

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

hudson.model.Slave.JnlpJar, hudson.model.Slave.SlaveDescriptor

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

hudson.model.Node.InternalComputerListener, hudson.model.Node.Mode

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.model.queue.CauseOfBlockage	BecauseNodeIsDedicated Build is blocked because node is dedicated to another queue item

Fields inherited from class hudson.model.Slave

name, remoteFS

Fields inherited from class hudson.model.Node

holdOffLaunchUntilSave

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
OneShotSlave(hudson.model.Queue.BuildableItem queueItem, String nodeDescription, String remoteFS, hudson.slaves.ComputerLauncher launcher, Charset charset)

Method Summary

Modifier and Type	Method and Description
OneShotSlave	asNode()
hudson.model.queue.CauseOfBlockage	canTake(hudson.model.Queue.BuildableItem item)
OneShotComputer	createComputer()
hudson.Launcher	createLauncher(hudson.model.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. see https://issues.jenkins-ci.org/browse/JENKINS-35521
protected void	doActualLaunch(hudson.model.TaskListener listener)
protected Charset	getCharset()
OneShotComputer	getComputer()
String	getDisplayName()
String	getNodeDescription()
int	getNumExecutors()
long	getQueueItemId()
protected boolean	hasExecutable()
void	setExecutable() Set executable based on current Executor activity.
void	setExecutable(hudson.model.Run run) Assign a $Run to this OneShotSlave.

Methods inherited from class hudson.model.Slave

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

Methods inherited from class hudson.model.Node

canTake, checkPermission, createPath, getACL, getAssignedLabels, getChannel, getClockDifference, getFileSystemProvisioner, getLabelCloud, getNodePropertyDescriptors, getSearchUrl, getSelfLabel, hasPermission, isAcceptingTasks, isHoldOffLaunchUntilSave, reconfigure, save, toComputer

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

Field Detail

BecauseNodeIsDedicated

public static final hudson.model.queue.CauseOfBlockage BecauseNodeIsDedicated

Build is blocked because node is dedicated to another queue item

Constructor Detail

OneShotSlave

public OneShotSlave(hudson.model.Queue.BuildableItem queueItem,
                    String nodeDescription,
                    String remoteFS,
                    hudson.slaves.ComputerLauncher launcher,
                    Charset charset)
             throws hudson.model.Descriptor.FormException,
                    IOException

Parameters:

queueItem - The Queue.Item this slave is assigned to

nodeDescription - Node description for UI

remoteFS - agent working directory

launcher - ComputerLauncher used to bootstrap this slave.

charset - Computer's Charset. Need to be set by caller as we can't determine this one before actual launch.

Throws:

Descriptor.FormException

IOException

Method Detail

canTake

public hudson.model.queue.CauseOfBlockage canTake(hudson.model.Queue.BuildableItem item)

Overrides:

canTake in class hudson.model.Node

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.ModelObject

Overrides:

getDisplayName in class hudson.model.Node

getNodeDescription

public String getNodeDescription()

Overrides:

getNodeDescription in class hudson.model.Slave

getQueueItemId

public long getQueueItemId()

getCharset

protected Charset getCharset()

createComputer

public OneShotComputer createComputer()

Overrides:

createComputer in class hudson.model.Slave

getNumExecutors

public int getNumExecutors()

Overrides:

getNumExecutors in class hudson.model.Slave

hasExecutable

protected boolean hasExecutable()

getComputer

public OneShotComputer getComputer()

Overrides:

getComputer in class hudson.model.Slave

setExecutable

public void setExecutable(hudson.model.Run run)

Assign a $Run to this OneShotSlave. By design, only one Run can be assigned, then slave is shut down. This method has to be called just as the $Run as been created, typically relying on RunListener.fireFinalized(Run) event. It run the actual launch of the executor and collect it's log into the the Run's $BuildListener.

Delaying launch of the executor until the Run is actually started allows to fail the build on launch failure, so we have a strong 1:1 relation between a Run and it's Executor.

setExecutable

public void setExecutable()

Set executable based on current Executor activity. Required for pipeline support.

doActualLaunch

protected void doActualLaunch(hudson.model.TaskListener listener)

createLauncher

public hudson.Launcher createLauncher(hudson.model.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. see https://issues.jenkins-ci.org/browse/JENKINS-35521

Overrides:

createLauncher in class hudson.model.Slave

asNode

public OneShotSlave asNode()

Specified by:

asNode in interface hudson.slaves.EphemeralNode