Package io.jenkins.plugins.ranchermanager

Class RancherManifestBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

io.jenkins.plugins.ranchermanager.RancherManifestBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public class RancherManifestBuilder
extends Builder
implements SimpleBuildStep

Freestyle / Pipeline build step: Rancher Manager manifest deploy (@Symbol("rancherManifest")).

Kubernetes namespace comes from the manifest. This step does not create namespaces and does not rewrite YAML. Git source is fetched on the agent via shallow clone.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RancherManifestBuilder.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MANIFEST_FILE
static final String	DEFAULT_REPOSITORY_REFERENCE
static final String	MODE_INHERIT
static final String	MODE_MANUAL
static final String	SOURCE_REPOSITORY
static final String	SOURCE_YAML

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
RancherManifestBuilder(String clusterId)

Method Summary

Modifier and Type	Method	Description
String	getClusterId()
String	getGitCredentialsId()
String	getManifestFilePath()
String	getManifestSource()
String	getManifestYaml()
String	getRancherConnectionMode()
String	getRancherCredentialsId()
String	getRancherUrl()
String	getRepositoryReferenceName()
String	getRepositoryUrl()
String	getWaitTimeoutSeconds()
boolean	isValidateOnly()
boolean	isVerboseLogging()
void	perform(Run<?,?> run, EnvVars buildEnv, TaskListener listener)
void	perform(Run<?,?> run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener)
boolean	requiresWorkspace()	Workspace required when manifest source is Git (Jenkins fetch on agent).
void	setGitCredentialsId(String gitCredentialsId)
void	setManifestFilePath(String manifestFilePath)
void	setManifestSource(String manifestSource)
void	setManifestYaml(String manifestYaml)
void	setRancherConnectionMode(String rancherConnectionMode)
void	setRancherCredentialsId(String rancherCredentialsId)
void	setRancherUrl(String rancherUrl)
void	setRepositoryReferenceName(String repositoryReferenceName)
void	setRepositoryUrl(String repositoryUrl)
void	setValidateOnly(boolean validateOnly)
void	setVerboseLogging(boolean verboseLogging)
void	setWaitTimeoutSeconds(String waitTimeoutSeconds)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform

Field Details

MODE_INHERIT

public static final String MODE_INHERIT

See Also:

• Constant Field Values

MODE_MANUAL

public static final String MODE_MANUAL

See Also:

• Constant Field Values

SOURCE_REPOSITORY

public static final String SOURCE_REPOSITORY

See Also:

• Constant Field Values

SOURCE_YAML

public static final String SOURCE_YAML

See Also:

• Constant Field Values

DEFAULT_MANIFEST_FILE

public static final String DEFAULT_MANIFEST_FILE

See Also:

• Constant Field Values

DEFAULT_REPOSITORY_REFERENCE

public static final String DEFAULT_REPOSITORY_REFERENCE

See Also:

• Constant Field Values

Constructor Details

RancherManifestBuilder

@DataBoundConstructor
public RancherManifestBuilder(String clusterId)

Method Details

getClusterId

public String getClusterId()

getManifestSource

public String getManifestSource()

setManifestSource

@DataBoundSetter
public void setManifestSource(String manifestSource)

getRepositoryUrl

public String getRepositoryUrl()

setRepositoryUrl

@DataBoundSetter
public void setRepositoryUrl(String repositoryUrl)

getManifestFilePath

public String getManifestFilePath()

setManifestFilePath

@DataBoundSetter
public void setManifestFilePath(String manifestFilePath)

getRepositoryReferenceName

public String getRepositoryReferenceName()

setRepositoryReferenceName

@DataBoundSetter
public void setRepositoryReferenceName(String repositoryReferenceName)

getGitCredentialsId

public String getGitCredentialsId()

setGitCredentialsId

@DataBoundSetter
public void setGitCredentialsId(String gitCredentialsId)

getManifestYaml

public String getManifestYaml()

setManifestYaml

@DataBoundSetter
public void setManifestYaml(String manifestYaml)

getRancherConnectionMode

public String getRancherConnectionMode()

setRancherConnectionMode

@DataBoundSetter
public void setRancherConnectionMode(String rancherConnectionMode)

getRancherUrl

public String getRancherUrl()

setRancherUrl

@DataBoundSetter
public void setRancherUrl(String rancherUrl)

getRancherCredentialsId

public String getRancherCredentialsId()

setRancherCredentialsId

@DataBoundSetter
public void setRancherCredentialsId(String rancherCredentialsId)

getWaitTimeoutSeconds

public String getWaitTimeoutSeconds()

setWaitTimeoutSeconds

@DataBoundSetter
public void setWaitTimeoutSeconds(String waitTimeoutSeconds)

isValidateOnly

public boolean isValidateOnly()

setValidateOnly

@DataBoundSetter
public void setValidateOnly(boolean validateOnly)

isVerboseLogging

public boolean isVerboseLogging()

setVerboseLogging

@DataBoundSetter
public void setVerboseLogging(boolean verboseLogging)

requiresWorkspace

public boolean requiresWorkspace()

Workspace required when manifest source is Git (Jenkins fetch on agent).

Specified by:

requiresWorkspace in interface SimpleBuildStep

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 EnvVars buildEnv,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 FilePath workspace,
 @NonNull
 EnvVars env,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException