org.microbean.helm.maven

Class UpdateReleaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.microbean.helm.maven.AbstractHelmMojo

org.microbean.helm.maven.AbstractReleaseMojo

org.microbean.helm.maven.AbstractSingleReleaseMojo

org.microbean.helm.maven.AbstractMutatingReleaseMojo

org.microbean.helm.maven.AbstractForceableMutatingReleaseMojo

org.microbean.helm.maven.UpdateReleaseMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="update")
public class UpdateReleaseMojo
extends AbstractForceableMutatingReleaseMojo

Updates a release with a new chart.

Author:

Laird Nelson

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
UpdateReleaseMojo(MavenProject project, MavenSession session) Creates a new UpdateReleaseMojo.

Method Summary

Modifier and Type	Method and Description
protected AbstractChartLoader<URL>	createChartLoader() Creates and returns an AbstractChartLoader capable of loading a Helm chart from a URL.
protected void	execute(Callable<ReleaseManager> releaseManagerCallable) Performs a release-oriented task using a ReleaseManager available from the supplied Callable.
URL	getChartUrl() Returns a URL identifying a Helm chart that can be read by the AbstractChartLoader produced by the createChartLoader() method.
boolean	getResetValues() Returns true if, during the update, values should be reset to the values built in to the new chart.
boolean	getReuseValues() Returns true if, during the update, any new values should be merged with those present in the prior version of the release being updated.
String	getValuesYaml() Returns a YAML String representing the values to use to customize the update.
URI	getValuesYamlUri() Returns a URI identifying a YAML document containing the values to use to customize the installation.
void	setChartUrl(URL chartUrl) Sets the URL identifying a Helm chart that can be read by the AbstractChartLoader produced by the createChartLoader() method.
void	setResetValues(boolean resetValues) Sets whether, during the update, values should be reset to the values built in to the new chart.
void	setReuseValues(boolean reuseValues) Sets whether, during the update, any new values should be merged with those present in the prior version of the release being updated.
void	setValuesYaml(String valuesYaml) Installs a YAML String representing the values to use to customize the update.
void	setValuesYamlUri(URI valuesYamlUri) Sets the URI identifying a YAML document containing the values to use to customize the installation.

Methods inherited from class org.microbean.helm.maven.AbstractForceableMutatingReleaseMojo

getForce, getRecreate, setForce, setRecreate

Methods inherited from class org.microbean.helm.maven.AbstractMutatingReleaseMojo

getDisableHooks, getDryRun, getTimeout, getWait, setDisableHooks, setDryRun, setTimeout, setWait

Methods inherited from class org.microbean.helm.maven.AbstractSingleReleaseMojo

getReleaseName, setReleaseName, validateReleaseName

Methods inherited from class org.microbean.helm.maven.AbstractReleaseMojo

createClient, createReleaseManager, createTiller, execute, getClientConfiguration, getSkip, getTillerLabels, getTillerNamespace, getTillerPort, setClientConfiguration, setSkip, setTillerLabels, setTillerNamespace, setTillerPort, validateNamespace

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateReleaseMojo

@Inject
public UpdateReleaseMojo(MavenProject project,
                                 MavenSession session)

Creates a new UpdateReleaseMojo.

Parameters:

project - the MavenProject in effect; must not be null

session - the MavenSession in effect; must not be null

Throws:

NullPointerException - if either project or session is null

Method Detail

execute

protected void execute(Callable<ReleaseManager> releaseManagerCallable)
                throws Exception

Performs a release-oriented task using a ReleaseManager available from the supplied Callable.

This implementation updates the release named by the supplied release name with a new chart residing at the indicated URL.

Specified by:

execute in class AbstractReleaseMojo

Parameters:

releaseManagerCallable - the Callable that will provide a ReleaseManager; must not be null

Throws:

Exception - if an error occurs

getChartUrl

public URL getChartUrl()

Returns a URL identifying a Helm chart that can be read by the AbstractChartLoader produced by the createChartLoader() method.

This method may return null.

Returns:

a URL to a Helm chart, or null

See Also:

setChartUrl(URL)

setChartUrl

public void setChartUrl(URL chartUrl)

Sets the URL identifying a Helm chart that can be read by the AbstractChartLoader produced by the createChartLoader() method.

Parameters:

chartUrl - the URL identifying a Helm chart that can be read by the AbstractChartLoader produced by the createChartLoader() method; may be null

getResetValues

public boolean getResetValues()

Returns true if, during the update, values should be reset to the values built in to the new chart.

Returns:

true if, during the update, values should be reset to the values built in to the new chart; false otherwise

See Also:

setResetValues(boolean)

setResetValues

public void setResetValues(boolean resetValues)

Sets whether, during the update, values should be reset to the values built in to the new chart.

Parameters:

resetValues - if true, during the update values will be reset to the values built in to the new chart

See Also:

getResetValues()

getReuseValues

public boolean getReuseValues()

Returns true if, during the update, any new values should be merged with those present in the prior version of the release being updated.

Returns:

true if, during the update, any new values should be merged with those present in the prior version of the release being updated; false otherwise

See Also:

setReuseValues(boolean)

setReuseValues

public void setReuseValues(boolean reuseValues)

Sets whether, during the update, any new values should be merged with those present in the prior version of the release being updated.

Parameters:

reuseValues - if true during the update any new values will be merged with those present in the prior version of the release being updated

See Also:

getReuseValues()

getValuesYaml

public String getValuesYaml()

Returns a YAML String representing the values to use to customize the update.

This method may return null.

Overrides of this method may return null.

Returns:

a YAML String representing the values to use to customize the update, or null

See Also:

setValuesYaml(String)

setValuesYaml

public void setValuesYaml(String valuesYaml)

Installs a YAML String representing the values to use to customize the update.

Parameters:

valuesYaml - the YAML String representing the values to use to customize the update; may be null

See Also:

getValuesYaml()

getValuesYamlUri

public URI getValuesYamlUri()

Returns a URI identifying a YAML document containing the values to use to customize the installation.

This method may return null.

Overrides of this method may return null.

Returns:

a URI identifying a YAML document containing the values to use to customize the installation, or null

See Also:

setValuesYamlUri(URI)

setValuesYamlUri

public void setValuesYamlUri(URI valuesYamlUri)

Sets the URI identifying a YAML document containing the values to use to customize the installation.

Parameters:

valuesYamlUri - the URI identifying a YAML document containing the values to use to customize the installation; may be null

See Also:

getValuesYamlUri()

createChartLoader

protected AbstractChartLoader<URL> createChartLoader()

Creates and returns an AbstractChartLoader capable of loading a Helm chart from a URL.

This method never returns null.

Overrides of this method must not return null.

This implementation returns a new URLChartLoader.

Returns:

a new AbstractChartLoader implementation; never null