Package sh.createos.jenkins.sandbox

Class CreateOSCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.slaves.Cloud

sh.createos.jenkins.sandbox.CreateOSCloud

All Implemented Interfaces:

ExtensionPoint, Describable<Cloud>, ModelObject, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithContextMenu

public class CreateOSCloud
extends Cloud

Jenkins cloud implementation that provisions ephemeral CreateOS sandbox agents.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateOSCloud.AgentRecovery	Runs recoverStaleAgents() once Jenkins has finished starting.
static class	CreateOSCloud.DescriptorImpl	Exposes CreateOS cloud metadata, options, and validation to Jenkins.

Nested classes/interfaces inherited from class hudson.slaves.Cloud

Cloud.CloudState

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor	Description
CreateOSCloud(String name)	Creates a cloud with the default CreateOS API endpoint and capacity.

Method Summary

Modifier and Type	Method	Description
CreateOSApiClient	buildApiClient()	Builds an authenticated API client from this cloud's configured Jenkins credential.
boolean	canProvision(Cloud.CloudState state)
String	getApiUrl()
int	getContainerCap()
String	getCredentialsId()
String	getDisplayName()
int	getExecSandboxCap()
List<SandboxTemplate>	getTemplates()
Collection<NodeProvisioner.PlannedNode>	provision(Cloud.CloudState state, int excessWorkload)
static void	recoverStaleAgents()	Decides what to do with each CreateOS agent restored from an earlier controller process.
void	setApiUrl(String apiUrl)
void	setContainerCap(int containerCap)
void	setCredentialsId(String credentialsId)
void	setDisplayName(String displayName)
void	setExecSandboxCap(int execSandboxCap)
void	setTemplates(List<SandboxTemplate> templates)

Methods inherited from class hudson.slaves.Cloud

all, canProvision, doConfigSubmit, doDoDelete, getACL, getDescriptor, getIcon, getIconAltText, getIconClassName, getSearchUrl, getUrl, provision, reconfigure, reconfigure, registerPermissions

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic, getDynamic, removeAction, removeActions, replaceAction, replaceActions

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.search.SearchItem

getSearchGroup, getSearchIcon

Constructor Details

CreateOSCloud

@DataBoundConstructor
public CreateOSCloud(String name)

Creates a cloud with the default CreateOS API endpoint and capacity.

Method Details

recoverStaleAgents

public static void recoverStaleAgents()

Decides what to do with each CreateOS agent restored from an earlier controller process.

An agent whose sandbox is still running is kept rather than destroyed: the sandbox kept its workspace, so a Pipeline that was mid-build can resume through Durable Task. An inbound agent's process is still running in that sandbox and reconnects its WebSocket by itself; an SSH agent only lost its tunnel with the previous JVM, and Jenkins relaunches it through a new one.

A template can opt out with "Delete agents on controller restart", for agents meant to be strictly one-process-lifetime; those are terminated, as is a node whose sandbox has gone and so has nothing left to reconnect to.

Driven from ItemListener.onLoaded() rather than an @Initializer: the work needs Computer objects, which exist only once startup is finished, and @Initializer(after = COMPLETED) can never run because that milestone is terminal — scheduling against it wedges the initialization graph instead (JENKINS-37759).

canProvision

public boolean canProvision(Cloud.CloudState state)

Overrides:

canProvision in class Cloud

provision

public Collection<NodeProvisioner.PlannedNode> provision(Cloud.CloudState state,
 int excessWorkload)

Overrides:

provision in class Cloud

buildApiClient

public CreateOSApiClient buildApiClient()

Builds an authenticated API client from this cloud's configured Jenkins credential.

getApiUrl

public String getApiUrl()

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class Cloud

setDisplayName

@DataBoundSetter
public void setDisplayName(String displayName)

setApiUrl

@DataBoundSetter
public void setApiUrl(String apiUrl)

getCredentialsId

public String getCredentialsId()

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

getContainerCap

public int getContainerCap()

setContainerCap

@DataBoundSetter
public void setContainerCap(int containerCap)

getExecSandboxCap

public int getExecSandboxCap()

setExecSandboxCap

@DataBoundSetter
public void setExecSandboxCap(int execSandboxCap)

getTemplates

public List<SandboxTemplate> getTemplates()

setTemplates

@DataBoundSetter
public void setTemplates(List<SandboxTemplate> templates)