org.microbean.helm.maven

Class InstallReleaseMojo

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.InstallReleaseMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="install")
public class InstallReleaseMojo
extends AbstractMutatingReleaseMojo

Installs a chart and hence creates a release.

Author:

Laird Nelson

Field Summary

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

ROLE

Constructor Summary

Constructors

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

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.
String	getReleaseNamespace() Returns the namespace into which the release will be installed.
boolean	getReuseReleaseName() Returns true if the supplied release name should be reused across installations.
String	getValuesYaml() Returns a YAML String representing the values to use to customize the installation.
URI	getValuesYamlUri() Returns a URI identifying a YAML document containing the values to use to customize the installation.
boolean	isLenient() Returns true if this InstallReleaseMojo is lenient; if true, a missing or unresolvable chartUrl parameter will result in execution being skipped rather than a MojoExecutionException being thrown.
void	setChartUrl(URL chartUrl) Sets the URL identifying a Helm chart that can be read by the AbstractChartLoader produced by the createChartLoader() method.
void	setLenient(boolean lenient) Sets whether this InstallReleaseMojo is lenient; if true is supplied, a missing or unresolvable chartUrl parameter will result in execution being skipped rather than a MojoExecutionException being thrown.
void	setReleaseNamespace(String releaseNamespace) Sets the namespace into which the release will be installed.
void	setReuseReleaseName(boolean reuseReleaseName) Sets whether the supplied release name should be reused across installations.
void	setValuesYaml(String valuesYaml) Installs a YAML String representing the values to use to customize the installation.
void	setValuesYamlUri(URI valuesYamlUri) Sets the URI identifying a YAML document containing the values to use to customize the installation.
protected void	validateReleaseName(String name) Validates the supplied name as a Helm release name.

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

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

InstallReleaseMojo

@Inject
public InstallReleaseMojo(MavenProject project,
                                  MavenSession session)

Creates a new InstallReleaseMojo.

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 installs the chart residing at the indicated URL and thus creates a release.

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

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

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

isLenient

public boolean isLenient()

Returns true if this InstallReleaseMojo is lenient; if true, a missing or unresolvable chartUrl parameter will result in execution being skipped rather than a MojoExecutionException being thrown.

Returns:

true if this InstallReleaseMojo is lenient; false otherwise

setLenient

public void setLenient(boolean lenient)

Sets whether this InstallReleaseMojo is lenient; if true is supplied, a missing or unresolvable chartUrl parameter will result in execution being skipped rather than a MojoExecutionException being thrown.

Parameters:

lenient - whether this InstallReleaseMojo is lenient; if true, a missing or unresolvable chartUrl parameter will result in execution being skipped rather than a MojoExecutionException being thrown

getReleaseNamespace

public String getReleaseNamespace()

Returns the namespace into which the release will be installed.

This method may return null.

Returns:

the namespace into which the release will be installed, or null

See Also:

setReleaseNamespace(String)

setReleaseNamespace

public void setReleaseNamespace(String releaseNamespace)

Sets the namespace into which the release will be installed.

Parameters:

releaseNamespace - the namespace into which the release will be installed; may be null

See Also:

getReleaseNamespace()

getReuseReleaseName

public boolean getReuseReleaseName()

Returns true if the supplied release name should be reused across installations.

Returns:

true if the supplied release name should be reused across installations; false otherwise

See Also:

setReuseReleaseName(boolean)

setReuseReleaseName

public void setReuseReleaseName(boolean reuseReleaseName)

Sets whether the supplied release name should be reused across installations.

Parameters:

reuseReleaseName - whether the supplied release name should be reused across installations

See Also:

getReuseReleaseName()

getValuesYaml

public String getValuesYaml()

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

This method may return null.

Overrides of this method may return null.

Returns:

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

See Also:

setValuesYaml(String)

setValuesYaml

public void setValuesYaml(String valuesYaml)

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

Parameters:

valuesYaml - the YAML String representing the values to use to customize the installation; 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()

validateReleaseName

protected void validateReleaseName(String name)

Validates the supplied name as a Helm release name.

This implementation checks to see if the supplied name is non-null, not empty, and matches the value of the ReleaseManager.DNS_SUBDOMAIN_PATTERN field.

This implementation allows the supplied name to be null or empty.

Overrides:

validateReleaseName in class AbstractSingleReleaseMojo

Parameters:

name - the release name to validate; must not be null