Package org.csanchez.jenkins.plugins.kubernetes.pipeline

Class KubernetesNodeContext

java.lang.Object

org.csanchez.jenkins.plugins.kubernetes.pipeline.KubernetesNodeContext

All Implemented Interfaces:

Serializable

public class KubernetesNodeContext
extends Object
implements Serializable

helper class for steps running in a kubernetes `node` context

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
KubernetesNodeContext(org.jenkinsci.plugins.workflow.steps.StepContext context)	Create new Kubernetes context

Method Summary

Modifier and Type	Method	Description
final KubernetesSlave	getKubernetesSlave()	Get Node from the StepContext.
String	getNamespace()	Kubernetes namespace Pod is running in.
String	getPodName()	Kubernetes Pod name.
io.fabric8.kubernetes.client.dsl.PodResource	getPodResource()	Get node PodResource.

Methods inherited from class java.lang.Object

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

Constructor Details

KubernetesNodeContext

public KubernetesNodeContext(@NonNull
 org.jenkinsci.plugins.workflow.steps.StepContext context)
                      throws Exception

Create new Kubernetes context

Parameters:

context - step context, not null

Throws:

Exception - if Node context not instance of KubernetesSlave or interrupted.

Method Details

getPodName

@NonNull
public String getPodName()

Kubernetes Pod name.

Returns:

pod name, never null

getNamespace

@Nullable
public String getNamespace()

Kubernetes namespace Pod is running in.

Returns:

kubernetes namespace or null

getPodResource

@NonNull
public io.fabric8.kubernetes.client.dsl.PodResource getPodResource()
                                                            throws IOException,
InterruptedException,
org.jenkinsci.plugins.kubernetes.auth.KubernetesAuthException

Get node PodResource.

Returns:

client pod resource, never null

Throws:

IOException - if IO exception

InterruptedException - if interrupted

org.jenkinsci.plugins.kubernetes.auth.KubernetesAuthException - if authentication failure

See Also:

• KubernetesCloud.getPodResource(String, String)

getKubernetesSlave

@NonNull
public final KubernetesSlave getKubernetesSlave()
                                         throws IOException,
InterruptedException

Get Node from the StepContext. If the context instance is instance of KubernetesSlave it will be returned otherwise an exception is thrown.

Returns:

kubernetes slave node context, never null

Throws:

IOException - if IO exception

InterruptedException - if interrupted

AbortException - if Node context is not instance of KubernetesSlave