org.jenkinsci.plugins.oneshot

Class OneShotProvisioner<T extends OneShotSlave>

java.lang.Object

org.jenkinsci.plugins.oneshot.OneShotProvisioner<T>

All Implemented Interfaces:

hudson.ExtensionPoint

public abstract class OneShotProvisioner<T extends OneShotSlave>
extends Object
implements hudson.ExtensionPoint

This provisioner is responsible to create $OneShotSlaves. Plugins to manage lightweight agents can use this extension point to determine jobs which require.

Author:

Nicolas De Loof

Nested Class Summary

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	WAIT_FOR_RESOURCES

Constructor Summary

Constructors

Constructor and Description
OneShotProvisioner()

Method Summary

Modifier and Type	Method and Description
static List<OneShotProvisioner>	all()
abstract boolean	canRun(hudson.model.Queue.Item item) Determine if the underlying infrastructure has enough resources to create a slave for this $Queue.Item.
protected int	countExecutors(Class<T> type, com.google.common.base.Predicate<T>... filters) Utility method to count active one-shot-executors.
abstract T	prepareExecutorFor(hudson.model.Queue.BuildableItem item) Prepare a $OneShotSlave to run this $Queue.BuildableItem.
abstract boolean	usesOneShotExecutor(hudson.model.Queue.Item item) Determine if this $Queue.Item do rely on One-Shot executors, and should be handled by this specific provisioner.

Methods inherited from class java.lang.Object

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

Field Detail

WAIT_FOR_RESOURCES

public static final hudson.model.queue.CauseOfBlockage WAIT_FOR_RESOURCES

Constructor Detail

OneShotProvisioner

public OneShotProvisioner()

Method Detail

usesOneShotExecutor

public abstract boolean usesOneShotExecutor(hudson.model.Queue.Item item)

Determine if this $Queue.Item do rely on One-Shot executors, and should be handled by this specific provisioner.

canRun

public abstract boolean canRun(hudson.model.Queue.Item item)

Determine if the underlying infrastructure has enough resources to create a slave for this $Queue.Item.

Implementation can rely on this to reduce concurrent executors on a static infrastructure, or to schedule new resources on an elastic one.

prepareExecutorFor

@Nonnull
public abstract T prepareExecutorFor(hudson.model.Queue.BuildableItem item)
                                       throws Exception

Prepare a $OneShotSlave to run this $Queue.BuildableItem. The actual slave isn't launched, just prepared which means we can use it's node name as a label to for assignment. Implementation should create adequate OneShotSlave derived class but not run any actual provisioning, which will get postponed until the run has started and OneShotSlave.doActualLaunch(TaskListener) is ran.

Throws:

Exception

all

public static List<OneShotProvisioner> all()

countExecutors

protected int countExecutors(Class<T> type,
                             com.google.common.base.Predicate<T>... filters)

Utility method to count active one-shot-executors. Implementors can rely on this to implement $canRun(Queue.Item) using a simple max number of instances approach, comparable to $AbstractCloudImpl.setInstanceCap(int)