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.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.console.ConsoleLogFilter	LOG_FILTER 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
OneShotSlave	asNode()
hudson.model.Computer	createComputer()
hudson.Launcher	createLauncher(hudson.model.TaskListener listener) Pipeline does not use the same mecanism to use nodes, so we also need to consider $createLauncher(TaskListener) as an event to determine first use of the slave.
OneShotComputer	getComputer()
String	getNodeDescription()
int	getNumExecutors()
protected boolean	hasExecutable()
protected void	provision()
void	setComputerListener(hudson.model.TaskListener computerListener) Assign the $ComputerLauncher listener as the node is actually started, so we can pipe it to the $Run log.
void	setExecutable(hudson.model.Queue.Executable executable) 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, setNodeName, setRetentionStrategy, setUserId, toString

Methods inherited from class hudson.model.Node

canTake, canTake, checkPermission, createPath, getACL, getAssignedLabels, getChannel, getClockDifference, getDisplayName, getFileSystemProvisioner, getLabelCloud, getNodePropertyDescriptors, getSearchUrl, getSelfLabel, hasPermission, isAcceptingTasks, isHoldOffLaunchUntilSave, reconfigure, 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

LOG_FILTER

@Extension
public static final hudson.console.ConsoleLogFilter LOG_FILTER

We listen to loggers creation by $Runs so we can write the executor's launch log into build log.

Constructor Detail

OneShotSlave

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

Throws:

hudson.model.Descriptor.FormException

IOException

Method Detail

getNodeDescription

public String getNodeDescription()

Overrides:

getNodeDescription in class hudson.model.Slave

createComputer

public hudson.model.Computer createComputer()

Overrides:

createComputer in class hudson.model.Slave

getNumExecutors

public int getNumExecutors()

Overrides:

getNumExecutors in class hudson.model.Slave

setComputerListener

public void setComputerListener(hudson.model.TaskListener computerListener)

Assign the $ComputerLauncher listener as the node is actually started, so we can pipe it to the $Run log. We need this as we can't just use getComputer().getListener()

See Also:

OneShotComputer.COMPUTER_LISTENER

hasExecutable

protected boolean hasExecutable()

getComputer

public OneShotComputer getComputer()

Overrides:

getComputer in class hudson.model.Slave

provision

protected void provision()

setExecutable

public void setExecutable(hudson.model.Queue.Executable executable)

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. It run the actual launch of the executor and collect it's log so we can pipe it to the Run's $BuildListener (which is created later).

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.

createLauncher

public hudson.Launcher createLauncher(hudson.model.TaskListener listener)

Pipeline does not use the same mecanism 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 hudson.model.Slave

asNode

public OneShotSlave asNode()

Specified by:

asNode in interface hudson.slaves.EphemeralNode