Package io.jenkins.plugins.ranchermanager

Class RancherHelmBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

io.jenkins.plugins.ranchermanager.RancherHelmBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public class RancherHelmBuilder
extends Builder
implements SimpleBuildStep

Freestyle / Pipeline build step: Rancher Manager Helm deploy (@Symbol("rancherHelm")).

Resolves connection, validates chart fields, and installs/upgrades via Rancher catalog API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RancherHelmBuilder.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_NAMESPACE
static final String	DEFAULT_REPOSITORY_REFERENCE
static final String	DEFAULT_VALUES_FILE
static final String	MODE_INHERIT
static final String	MODE_MANUAL
static final String	VALUES_NONE
static final String	VALUES_REPOSITORY
static final String	VALUES_YAML

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
RancherHelmBuilder(String clusterId, String releaseName, String chart, String repo)

Method Summary

Modifier and Type	Method	Description
String	getChart()
String	getClusterId()
String	getNamespace()
String	getProject()
String	getRancherConnectionMode()
String	getRancherCredentialsId()
String	getRancherUrl()
String	getReleaseName()
String	getRepo()
String	getValues()
String	getValuesFilePath()
String	getValuesGitCredentialsId()
String	getValuesRepositoryReferenceName()
String	getValuesRepositoryUrl()
String	getValuesSource()
String	getVersion()
String	getWaitTimeoutSeconds()
boolean	isAtomic()
boolean	isEnsureNamespace()
boolean	isForceReinstall()
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()
void	setAtomic(boolean atomic)
void	setEnsureNamespace(boolean ensureNamespace)
void	setForceReinstall(boolean forceReinstall)
void	setNamespace(String namespace)
void	setProject(String project)
void	setRancherConnectionMode(String rancherConnectionMode)
void	setRancherCredentialsId(String rancherCredentialsId)
void	setRancherUrl(String rancherUrl)
void	setValidateOnly(boolean validateOnly)
void	setValues(String values)
void	setValuesFilePath(String valuesFilePath)
void	setValuesGitCredentialsId(String valuesGitCredentialsId)
void	setValuesRepositoryReferenceName(String valuesRepositoryReferenceName)
void	setValuesRepositoryUrl(String valuesRepositoryUrl)
void	setValuesSource(String valuesSource)
void	setVerboseLogging(boolean verboseLogging)
void	setVersion(String version)
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

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

See Also:

• Constant Field Values

DEFAULT_VALUES_FILE

public static final String DEFAULT_VALUES_FILE

See Also:

• Constant Field Values

DEFAULT_REPOSITORY_REFERENCE

public static final String DEFAULT_REPOSITORY_REFERENCE

See Also:

• Constant Field Values

VALUES_NONE

public static final String VALUES_NONE

See Also:

• Constant Field Values

VALUES_REPOSITORY

public static final String VALUES_REPOSITORY

See Also:

• Constant Field Values

VALUES_YAML

public static final String VALUES_YAML

See Also:

• Constant Field Values

Constructor Details

RancherHelmBuilder

@DataBoundConstructor
public RancherHelmBuilder(String clusterId,
 String releaseName,
 String chart,
 String repo)

Method Details

getClusterId

public String getClusterId()

getReleaseName

public String getReleaseName()

getChart

public String getChart()

getRepo

public String getRepo()

getNamespace

public String getNamespace()

setNamespace

@DataBoundSetter
public void setNamespace(String namespace)

getProject

public String getProject()

setProject

@DataBoundSetter
public void setProject(String project)

getVersion

public String getVersion()

setVersion

@DataBoundSetter
public void setVersion(String version)

getValuesSource

public String getValuesSource()

setValuesSource

@DataBoundSetter
public void setValuesSource(String valuesSource)

getValues

public String getValues()

setValues

@DataBoundSetter
public void setValues(String values)

getValuesRepositoryUrl

public String getValuesRepositoryUrl()

setValuesRepositoryUrl

@DataBoundSetter
public void setValuesRepositoryUrl(String valuesRepositoryUrl)

getValuesFilePath

public String getValuesFilePath()

setValuesFilePath

@DataBoundSetter
public void setValuesFilePath(String valuesFilePath)

getValuesGitCredentialsId

public String getValuesGitCredentialsId()

setValuesGitCredentialsId

@DataBoundSetter
public void setValuesGitCredentialsId(String valuesGitCredentialsId)

getValuesRepositoryReferenceName

public String getValuesRepositoryReferenceName()

setValuesRepositoryReferenceName

@DataBoundSetter
public void setValuesRepositoryReferenceName(String valuesRepositoryReferenceName)

isAtomic

public boolean isAtomic()

setAtomic

@DataBoundSetter
public void setAtomic(boolean atomic)

isForceReinstall

public boolean isForceReinstall()

setForceReinstall

@DataBoundSetter
public void setForceReinstall(boolean forceReinstall)

getWaitTimeoutSeconds

public String getWaitTimeoutSeconds()

setWaitTimeoutSeconds

@DataBoundSetter
public void setWaitTimeoutSeconds(String waitTimeoutSeconds)

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)

isEnsureNamespace

public boolean isEnsureNamespace()

setEnsureNamespace

@DataBoundSetter
public void setEnsureNamespace(boolean ensureNamespace)

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()

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