org.microbean.helm.maven

Class AbstractReleaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.microbean.helm.maven.AbstractHelmMojo

org.microbean.helm.maven.AbstractReleaseMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

AbstractSingleReleaseMojo, ListReleasesMojo

public abstract class AbstractReleaseMojo
extends AbstractHelmMojo

An AbstractHelmMojo that provides other Helm-related mojo implementations the ability to work with a ReleaseManager.

Author:

Laird Nelson

See Also:

execute(Callable)

Field Summary

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractReleaseMojo() Creates a new AbstractReleaseMojo.

Method Summary

Modifier and Type	Method and Description
protected DefaultKubernetesClient	createClient() Creates a DefaultKubernetesClient for communicating with Kubernetes clusters.
protected ReleaseManager	createReleaseManager(Tiller tiller) Creates a ReleaseManager and returns it.
protected Tiller	createTiller(DefaultKubernetesClient client) Creates a Tiller and returns it.
void	execute() Skips execution if instructed, or calls the execute(Callable) method with a Callable containing the results of an invocation of the createReleaseManager(Tiller) method.
protected abstract void	execute(Callable<ReleaseManager> releaseManagerCallable) Performs a release-oriented task using a ReleaseManager available from the supplied Callable.
Config	getClientConfiguration() Returns the Config describing how a DefaultKubernetesClient is to connect to a Kubernetes cluster.
boolean	getSkip() Returns true if this AbstractReleaseMojo should not execute.
Map<String,String>	getTillerLabels() Returns the Kubernetes labels that Tiller Pods have.
String	getTillerNamespace() Returns the Kubernetes namespace in which Tiller may be found.
int	getTillerPort() Returns the port on which Tiller may be found.
void	setClientConfiguration(Config config) Installs the Config describing how a DefaultKubernetesClient is to connect to a Kubernetes cluster.
void	setSkip(boolean skip) Controls whether this AbstractReleaseMojo should execute.
void	setTillerLabels(Map<String,String> tillerLabels) Sets the Kubernetes labels that Tiller Pods have.
void	setTillerNamespace(String tillerNamespace) Sets the Kubernetes namespace in which Tiller may be found.
void	setTillerPort(int tillerPort) Sets the port on which Tiller may be found.
protected void	validateNamespace(String namespace) Validates a Kubernetes namespace for correctness.

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

AbstractReleaseMojo

protected AbstractReleaseMojo()

Creates a new AbstractReleaseMojo.

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Skips execution if instructed, or calls the execute(Callable) method with a Callable containing the results of an invocation of the createReleaseManager(Tiller) method.

Throws:

MojoExecutionException - if there was a problem executing this mojo

MojoFailureException - if the mojo executed properly, but the job it was to perform failed in some way

getClientConfiguration

public Config getClientConfiguration()

Returns the Config describing how a DefaultKubernetesClient is to connect to a Kubernetes cluster.

This method may return null.

Overrides of this method may return null.

Returns:

a Config, or null

See Also:

setClientConfiguration(Config)

setClientConfiguration

public void setClientConfiguration(Config config)

Installs the Config describing how a DefaultKubernetesClient is to connect to a Kubernetes cluster.

Parameters:

config - the Config to use; may be null

See Also:

getClientConfiguration()

getSkip

public boolean getSkip()

Returns true if this AbstractReleaseMojo should not execute.

Returns:

true if this AbstractReleaseMojo should not execute; false otherwise

See Also:

setSkip(boolean)

setSkip

public void setSkip(boolean skip)

Controls whether this AbstractReleaseMojo should execute.

Parameters:

skip - if true, this AbstractReleaseMojo will not execute

See Also:

getSkip()

getTillerNamespace

public String getTillerNamespace()

Returns the Kubernetes namespace in which Tiller may be found.

This method may return null.

Returns:

the Kubernetes namespace in which Tiller may be found, or null

setTillerNamespace

public void setTillerNamespace(String tillerNamespace)

Sets the Kubernetes namespace in which Tiller may be found.

Parameters:

tillerNamespace - the Kubernetes namespace in which Tiller may be found; may be null in which case kube-system will be used by the createTiller(DefaultKubernetesClient) method instead

getTillerPort

public int getTillerPort()

Returns the port on which Tiller may be found.

Returns:

the port on which Tiller may be found; normally 44134

setTillerPort

public void setTillerPort(int tillerPort)

Sets the port on which Tiller may be found.

Parameters:

tillerPort - the port on which Tiller may be found; normally 44134

getTillerLabels

public Map<String,String> getTillerLabels()

Returns the Kubernetes labels that Tiller Pods have.

This method may return null.

Returns:

the Kubernetes labels that Tiller Pods have, or null

setTillerLabels

public void setTillerLabels(Map<String,String> tillerLabels)

Sets the Kubernetes labels that Tiller Pods have.

Tiller Pods are normally labeled with app = helm and name = tiller.

Parameters:

tillerLabels - a Map containing the labels; may be null

execute

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

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

Parameters:

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

Throws:

Exception - if an error occurs

createClient

protected DefaultKubernetesClient createClient()
                                        throws IOException

Creates a DefaultKubernetesClient for communicating with Kubernetes clusters.

This method never returns null.

Overrides of this method must not return null.

The default implementation calls the getClientConfiguration() method and uses its return value, unless it is null, in which case a new DefaultKubernetesClient is created via its no-argument constructor.

Returns:

a new, non-null DefaultKubernetesClient

Throws:

IOException - if there was a problem creating the client

createTiller

protected Tiller createTiller(DefaultKubernetesClient client)
                       throws IOException

Creates a Tiller and returns it.

This method never returns null.

Overrides of this method must not return null.

This implementation passes the supplied DefaultKubernetesClient to the appropriate Tiller constructor.

Parameters:

client - the DefaultKubernetesClient to use to communicate with a Kubernetes cluster; must not be null

Returns:

a new Tiller; never null

Throws:

NullPointerException - if client is null

IOException - if there was a problem creating a Tiller

createReleaseManager

protected ReleaseManager createReleaseManager(Tiller tiller)
                                       throws IOException

Creates a ReleaseManager and returns it.

This method never returns null.

Overrides of this method must not return null.

This implementation passes the supplied Tiller to the appropriate ReleaseManager constructor.

Parameters:

tiller - the Tiller to use to communicate with a Tiller server; must not be null

Returns:

a new ReleaseManager; never null

Throws:

NullPointerException - if tiller is null

IOException - if there was a problem creating a ReleaseManager

validateNamespace

protected void validateNamespace(String namespace)

Validates a Kubernetes namespace for correctness.

The default implementation checks the supplied namespace to see if it is less than or equal to characters, and if it matches the value of the ReleaseManager.DNS_LABEL_PATTERN field.

Parameters:

namespace - the namespace to validate; may be null

Throws:

IllegalArgumentException - if namespace is invalid