Package org.csanchez.jenkins.plugins.kubernetes

Class KubernetesSlave

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Node

hudson.model.Slave

hudson.slaves.AbstractCloudSlave

org.csanchez.jenkins.plugins.kubernetes.KubernetesSlave

All Implemented Interfaces:

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

public class KubernetesSlave
extends AbstractCloudSlave

Author:

Carlos Sanchez carlos@apache.org

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KubernetesSlave.Builder	Builds a KubernetesSlave instance.
static final class	KubernetesSlave.DescriptorImpl

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 inherited from class hudson.model.Slave

name

Fields inherited from class hudson.model.Node

holdOffLaunchUntilSave, SKIP_BUILD_CHECK_ON_FLYWEIGHTS

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KubernetesSlave(String name, PodTemplate template, String nodeDescription, String cloudName, String labelStr, ComputerLauncher computerLauncher, RetentionStrategy rs)
	KubernetesSlave(PodTemplate template, String nodeDescription, String cloudName, String labelStr, RetentionStrategy rs)	Deprecated. Use KubernetesSlave.Builder instead.
	KubernetesSlave(PodTemplate template, String nodeDescription, KubernetesCloud cloud, Label label)	Deprecated. Use KubernetesSlave.Builder instead.
	KubernetesSlave(PodTemplate template, String nodeDescription, KubernetesCloud cloud, String labelStr)	Deprecated. Use KubernetesSlave.Builder instead.
	KubernetesSlave(PodTemplate template, String nodeDescription, KubernetesCloud cloud, String labelStr, RetentionStrategy rs)	Deprecated. Use KubernetesSlave.Builder instead.

Method Summary

Modifier and Type	Method	Description
protected void	_terminate(TaskListener listener)
void	annotateTtl(TaskListener listener)
static KubernetesSlave.Builder	builder()	Returns a new KubernetesSlave.Builder instance.
KubernetesComputer	createComputer()
Launcher	createLauncher(TaskListener listener)
boolean	equals(Object o)
Cloud	getCloud()	Deprecated. Please use the strongly typed getKubernetesCloud() instead.
String	getCloudName()
KubernetesCloud	getKubernetesCloud()	Returns the cloud instance which created this agent.
String	getNamespace()
Optional<io.fabric8.kubernetes.api.model.Pod>	getPod()	Get Pod reference for this agent.
String	getPodName()
PodRetention	getPodRetention(KubernetesCloud cloud)
String	getRemoteFS()
FilePath	getRootPath()
TaskListener	getRunListener()	Makes a best effort to find the build log corresponding to this agent.
PodTemplate	getTemplate()
String	getTemplateId()
PodTemplate	getTemplateOrNull()
int	hashCode()
protected Object	readResolve()
void	setNamespace(String namespace)

Methods inherited from class hudson.slaves.AbstractCloudSlave

terminate

Methods inherited from class hudson.model.Slave

getClockDifferenceCallable, getComputer, getDescriptor, getLabelAtomSet, getLabelString, getLauncher, getMode, getNodeDescription, getNodeName, getNodeProperties, getNumExecutors, getRetentionStrategy, getUserId, getWorkspaceFor, getWorkspaceRoot, 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, 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.search.SearchItem

getSearchGroup, getSearchIcon

Constructor Details

KubernetesSlave

@Deprecated
public KubernetesSlave(PodTemplate template,
 String nodeDescription,
 KubernetesCloud cloud,
 String labelStr)
                throws Descriptor.FormException,
IOException

Deprecated.

Use KubernetesSlave.Builder instead.

Throws:

Descriptor.FormException

IOException

KubernetesSlave

@Deprecated
public KubernetesSlave(PodTemplate template,
 String nodeDescription,
 KubernetesCloud cloud,
 Label label)
                throws Descriptor.FormException,
IOException

Deprecated.

Use KubernetesSlave.Builder instead.

Throws:

Descriptor.FormException

IOException

KubernetesSlave

@Deprecated
public KubernetesSlave(PodTemplate template,
 String nodeDescription,
 KubernetesCloud cloud,
 String labelStr,
 RetentionStrategy rs)
                throws Descriptor.FormException,
IOException

Deprecated.

Use KubernetesSlave.Builder instead.

Throws:

Descriptor.FormException

IOException

KubernetesSlave

@Deprecated
@DataBoundConstructor
public KubernetesSlave(PodTemplate template,
 String nodeDescription,
 String cloudName,
 String labelStr,
 RetentionStrategy rs)
                throws Descriptor.FormException,
IOException

Deprecated.

Use KubernetesSlave.Builder instead.

Throws:

Descriptor.FormException

IOException

KubernetesSlave

protected KubernetesSlave(String name,
 @NonNull
 PodTemplate template,
 String nodeDescription,
 String cloudName,
 String labelStr,
 ComputerLauncher computerLauncher,
 RetentionStrategy rs)
                   throws Descriptor.FormException,
IOException

Throws:

Descriptor.FormException

IOException

Method Details

getTemplate

@NonNull
public PodTemplate getTemplate()
                        throws IllegalStateException

Throws:

IllegalStateException

getTemplateId

@NonNull
public String getTemplateId()

getTemplateOrNull

@CheckForNull
public PodTemplate getTemplateOrNull()

getRunListener

@NonNull
public TaskListener getRunListener()

Makes a best effort to find the build log corresponding to this agent.

getCloudName

public String getCloudName()

setNamespace

public void setNamespace(@NonNull
 String namespace)

getNamespace

@Nullable
public String getNamespace()

getPodName

public String getPodName()

getRemoteFS

public String getRemoteFS()

Overrides:

getRemoteFS in class Slave

getRootPath

@CheckForNull
public FilePath getRootPath()

Overrides:

getRootPath in class Slave

getCloud

@Deprecated
public Cloud getCloud()

Deprecated.

Please use the strongly typed getKubernetesCloud() instead.

getPod

public Optional<io.fabric8.kubernetes.api.model.Pod> getPod()

Get Pod reference for this agent. If it hasn't been assigned yet or the reference was lost due to restart, it will be looked up.

Returns:

assigned pod, or empty if not assigned or no longer exists

getKubernetesCloud

@NonNull
public KubernetesCloud getKubernetesCloud()

Returns the cloud instance which created this agent.

Returns:

the cloud instance which created this agent.

Throws:

IllegalStateException - if the cloud doesn't exist anymore, or is not a KubernetesCloud.

createComputer

public KubernetesComputer createComputer()

Specified by:

createComputer in class AbstractCloudSlave

getPodRetention

public PodRetention getPodRetention(KubernetesCloud cloud)

_terminate

protected void _terminate(TaskListener listener)
                   throws IOException,
InterruptedException

Specified by:

_terminate in class AbstractCloudSlave

Throws:

IOException

InterruptedException

equals

public boolean equals(Object o)

Overrides:

equals in class Slave

hashCode

public int hashCode()

Overrides:

hashCode in class Slave

createLauncher

public Launcher createLauncher(TaskListener listener)

Overrides:

createLauncher in class Slave

readResolve

protected Object readResolve()

Overrides:

readResolve in class Slave

builder

public static KubernetesSlave.Builder builder()

Returns a new KubernetesSlave.Builder instance.

Returns:

a new KubernetesSlave.Builder instance.

annotateTtl

public void annotateTtl(TaskListener listener)