org.microbean.helm

Class ReleaseManager

java.lang.Object

org.microbean.helm.ReleaseManager

All Implemented Interfaces:

Closeable, AutoCloseable

public class ReleaseManager
extends Object
implements Closeable

A manager of Helm releases.

Author:

Laird Nelson

Field Summary

Fields

Modifier and Type	Field and Description
static int	DNS_LABEL_MAX_LENGTH The maximum number of characters a Kubernetes identifier of type DNS_LABEL is permitted to contain (63).
static Pattern	DNS_LABEL_PATTERN A Pattern specifying the constraints that a non-null, non-empty Kubernetes namespace should satisfy.
static int	DNS_SUBDOMAIN_MAX_LENGTH The maximum number of characters a Kubernetes identifier of type DNS_SUBDOMAIN is permitted to contain (253).
static Pattern	DNS_SUBDOMAIN_PATTERN A Pattern specifying the constraints that a non-null, non-empty Helm release name should satisfy.
static int	HELM_RELEASE_NAME_MAX_LENGTH The maximum number of characters a Helm release name is permitted to contain (53).
static Pattern	RFC_1123_PATTERN An alias for the DNS_SUBDOMAIN_PATTERN field.

Constructor Summary

Constructors

Constructor and Description
ReleaseManager(Tiller tiller) Creates a new ReleaseManager.

Method Summary

Modifier and Type	Method and Description
void	close() Calls close() on the Tiller instance supplied at construction time.
Future<Tiller.GetReleaseContentResponse>	getContent(Tiller.GetReleaseContentRequest request) Returns the content that made up a given Helm release.
Future<Tiller.GetHistoryResponse>	getHistory(Tiller.GetHistoryRequest request) Returns the history of a given Helm release.
Future<Tiller.GetReleaseStatusResponse>	getStatus(Tiller.GetReleaseStatusRequest request) Returns the status of a given Helm release.
protected Tiller	getTiller() Returns the Tiller instance used to communicate with Helm's back-end Tiller component.
Future<Tiller.InstallReleaseResponse>	install(Tiller.InstallReleaseRequest.Builder requestBuilder, ChartOuterClass.Chart.Builder chartBuilder) Installs a release.
Iterator<Tiller.ListReleasesResponse>	list(Tiller.ListReleasesRequest request) Returns information about Helm releases.
Future<Tiller.RollbackReleaseResponse>	rollback(Tiller.RollbackReleaseRequest request) Rolls back a previously installed release.
Iterator<Tiller.TestReleaseResponse>	test(Tiller.TestReleaseRequest request) Returns information about tests run on a given Helm release.
Future<Tiller.UninstallReleaseResponse>	uninstall(Tiller.UninstallReleaseRequest request) Uninstalls (deletes) a previously installed release.
Future<Tiller.UpdateReleaseResponse>	update(Tiller.UpdateReleaseRequest.Builder requestBuilder, ChartOuterClass.Chart.Builder chartBuilder) Updates a release.
protected void	validate(Tiller.GetHistoryRequestOrBuilder request) Validates the supplied Tiller.GetHistoryRequestOrBuilder.
protected void	validate(Tiller.GetReleaseContentRequestOrBuilder request) Validates the supplied Tiller.GetReleaseContentRequestOrBuilder.
protected void	validate(Tiller.GetReleaseStatusRequestOrBuilder request) Validates the supplied Tiller.GetReleaseStatusRequestOrBuilder.
protected void	validate(Tiller.InstallReleaseRequestOrBuilder request) Validates the supplied Tiller.InstallReleaseRequestOrBuilder.
protected void	validate(Tiller.ListReleasesRequestOrBuilder request) Validates the supplied Tiller.ListReleasesRequestOrBuilder.
protected void	validate(Tiller.RollbackReleaseRequestOrBuilder request) Validates the supplied Tiller.RollbackReleaseRequestOrBuilder.
protected void	validate(Tiller.TestReleaseRequestOrBuilder request) Validates the supplied Tiller.TestReleaseRequestOrBuilder.
protected void	validate(Tiller.UninstallReleaseRequestOrBuilder request) Validates the supplied Tiller.UninstallReleaseRequestOrBuilder.
protected void	validate(Tiller.UpdateReleaseRequestOrBuilder request) Validates the supplied Tiller.UpdateReleaseRequestOrBuilder.
protected void	validateNamespace(String namespace) Ensures that the supplied namespace is a valid namespace.
protected void	validateReleaseName(String name) Ensures that the supplied name is a valid Helm release name.

Methods inherited from class java.lang.Object

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

Field Detail

DNS_SUBDOMAIN_MAX_LENGTH

public static final int DNS_SUBDOMAIN_MAX_LENGTH

The maximum number of characters a Kubernetes identifier of type DNS_SUBDOMAIN is permitted to contain (253).

See Also:

Kubernetes identifier definitions, Constant Field Values

DNS_SUBDOMAIN_PATTERN

public static final Pattern DNS_SUBDOMAIN_PATTERN

A Pattern specifying the constraints that a non-null, non-empty Helm release name should satisfy.

Because Helm release names are often used in hostnames, they should conform to RFC 1123. This Pattern reifies those constraints.

See Also:

validateReleaseName(String), RFC 1123, Kubernetes identifier definitions

DNS_LABEL_MAX_LENGTH

public static final int DNS_LABEL_MAX_LENGTH

The maximum number of characters a Kubernetes identifier of type DNS_LABEL is permitted to contain (63).

See Also:

Kubernetes identifier definitions, Constant Field Values

DNS_LABEL_PATTERN

public static final Pattern DNS_LABEL_PATTERN

A Pattern specifying the constraints that a non-null, non-empty Kubernetes namespace should satisfy.

See Also:

validateNamespace(String), RFC 1123, Kubernetes identifier definitions

HELM_RELEASE_NAME_MAX_LENGTH

public static final int HELM_RELEASE_NAME_MAX_LENGTH

The maximum number of characters a Helm release name is permitted to contain (53).

See Also:

Helm pull request #1560, Constant Field Values

RFC_1123_PATTERN

public static final Pattern RFC_1123_PATTERN

An alias for the DNS_SUBDOMAIN_PATTERN field.

See Also:

DNS_SUBDOMAIN_PATTERN

Constructor Detail

ReleaseManager

public ReleaseManager(Tiller tiller)

Creates a new ReleaseManager.

Parameters:

tiller - the Tiller instance representing a connection to the Tiller server; must not be null

Throws:

NullPointerException - if tiller is null

See Also:

Tiller

Method Detail

getTiller

protected final Tiller getTiller()

Returns the Tiller instance used to communicate with Helm's back-end Tiller component.

This method never returns null.

Returns:

a non-null Tiller

See Also:

ReleaseManager(Tiller), Tiller

close

public void close()
           throws IOException

Calls close() on the Tiller instance supplied at construction time.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an error occurs

getContent

public Future<Tiller.GetReleaseContentResponse> getContent(Tiller.GetReleaseContentRequest request)
                                                    throws IOException

Returns the content that made up a given Helm release.

This method never returns null.

Overrides of this method must not return null.

Parameters:

request - the Tiller.GetReleaseContentRequest describing the release; must not be null

Returns:

a Future containing a Tiller.GetReleaseContentResponse that has the information requested; never null

Throws:

NullPointerException - if request is null

IOException

getHistory

public Future<Tiller.GetHistoryResponse> getHistory(Tiller.GetHistoryRequest request)
                                             throws IOException

Returns the history of a given Helm release.

This method never returns null.

Overrides of this method must not return null.

Parameters:

request - the Tiller.GetHistoryRequest describing the release; must not be null

Returns:

a Future containing a Tiller.GetHistoryResponse that has the information requested; never null

Throws:

NullPointerException - if request is null

IOException

getStatus

public Future<Tiller.GetReleaseStatusResponse> getStatus(Tiller.GetReleaseStatusRequest request)
                                                  throws IOException

Returns the status of a given Helm release.

This method never returns null.

Overrides of this method must not return null.

Parameters:

request - the Tiller.GetReleaseStatusRequest describing the release; must not be null

Returns:

a Future containing a Tiller.GetReleaseStatusResponse that has the information requested; never null

Throws:

NullPointerException - if request is null

IOException

install

public Future<Tiller.InstallReleaseResponse> install(Tiller.InstallReleaseRequest.Builder requestBuilder,
                                                     ChartOuterClass.Chart.Builder chartBuilder)
                                              throws IOException

Installs a release.

This method never returns null.

Overrides of this method must not return null.

Parameters:

requestBuilder - the Tiller.InstallReleaseRequest.Builder representing the installation request; must not be null and must pass validation; its Tiller.InstallReleaseRequest.Builder.setChart(hapi.chart.ChartOuterClass.Chart.Builder) method will be called with the supplied chartBuilder as its argument value

chartBuilder - a ChartOuterClass.Chart.Builder representing the Helm chart to install; must not be null

Returns:

a Future containing a Tiller.InstallReleaseResponse that has the information requested; never null

Throws:

MissingDependenciesException - if the supplied chartBuilder has a requirements.yaml resource in it that mentions subcharts that it does not contain

NullPointerException - if request is null

IOException

See Also:

AbstractChartLoader

list

public Iterator<Tiller.ListReleasesResponse> list(Tiller.ListReleasesRequest request)

Returns information about Helm releases.

This method never returns null.

Overrides of this method must not return null.

Parameters:

request - the Tiller.ListReleasesRequest describing the releases to be returned; must not be null

Returns:

an Iterator of Tiller.ListReleasesResponse objects comprising the information requested; never null

Throws:

NullPointerException - if request is null

PatternSyntaxException - if the Tiller.ListReleasesRequestOrBuilder.getFilter() return value is non-null, non-empty but not a valid regular expression

rollback

public Future<Tiller.RollbackReleaseResponse> rollback(Tiller.RollbackReleaseRequest request)
                                                throws IOException

Rolls back a previously installed release.

This method never returns null.

Overrides of this method must not return null.

Parameters:

request - the Tiller.RollbackReleaseRequest describing the release; must not be null

Returns:

a Future containing a Tiller.RollbackReleaseResponse that has the information requested; never null

Throws:

NullPointerException - if request is null

IOException

test

public Iterator<Tiller.TestReleaseResponse> test(Tiller.TestReleaseRequest request)

Returns information about tests run on a given Helm release.

This method never returns null.

Overrides of this method must not return null.

Parameters:

request - the Tiller.TestReleaseRequest describing the release to be tested; must not be null

Returns:

an Iterator of Tiller.TestReleaseResponse objects comprising the information requested; never null

Throws:

NullPointerException - if request is null

uninstall

public Future<Tiller.UninstallReleaseResponse> uninstall(Tiller.UninstallReleaseRequest request)
                                                  throws IOException

Uninstalls (deletes) a previously installed release.

This method never returns null.

Overrides of this method must not return null.

Parameters:

request - the Tiller.UninstallReleaseRequest describing the release; must not be null

Returns:

a Future containing a Tiller.UninstallReleaseResponse that has the information requested; never null

Throws:

NullPointerException - if request is null

IOException

update

public Future<Tiller.UpdateReleaseResponse> update(Tiller.UpdateReleaseRequest.Builder requestBuilder,
                                                   ChartOuterClass.Chart.Builder chartBuilder)
                                            throws IOException

Updates a release.

This method never returns null.

Overrides of this method must not return null.

Parameters:

requestBuilder - the Tiller.UpdateReleaseRequest.Builder representing the installation request; must not be null and must pass validation; its Tiller.UpdateReleaseRequest.Builder.setChart(hapi.chart.ChartOuterClass.Chart.Builder) method will be called with the supplied chartBuilder as its argument value

chartBuilder - a ChartOuterClass.Chart.Builder representing the Helm chart with which to update the release; must not be null

Returns:

a Future containing a Tiller.UpdateReleaseResponse that has the information requested; never null

Throws:

NullPointerException - if request is null

IOException

See Also:

AbstractChartLoader

validate

protected void validate(Tiller.GetReleaseContentRequestOrBuilder request)

Validates the supplied Tiller.GetReleaseContentRequestOrBuilder.

Parameters:

request - the request to validate

Throws:

NullPointerException - if request is null

IllegalArgumentException - if request is invalid

See Also:

validateReleaseName(String)

validate

protected void validate(Tiller.GetHistoryRequestOrBuilder request)

Validates the supplied Tiller.GetHistoryRequestOrBuilder.

Parameters:

request - the request to validate

Throws:

NullPointerException - if request is null

IllegalArgumentException - if request is invalid

See Also:

validateReleaseName(String)

validate

protected void validate(Tiller.GetReleaseStatusRequestOrBuilder request)

Validates the supplied Tiller.GetReleaseStatusRequestOrBuilder.

Parameters:

request - the request to validate

Throws:

NullPointerException - if request is null

IllegalArgumentException - if request is invalid

See Also:

validateReleaseName(String)

validate

protected void validate(Tiller.InstallReleaseRequestOrBuilder request)

Validates the supplied Tiller.InstallReleaseRequestOrBuilder.

Parameters:

request - the request to validate

Throws:

NullPointerException - if request is null

IllegalArgumentException - if request is invalid

See Also:

validateReleaseName(String)

validate

protected void validate(Tiller.ListReleasesRequestOrBuilder request)

Validates the supplied Tiller.ListReleasesRequestOrBuilder.

Parameters:

request - the request to validate

Throws:

NullPointerException - if request is null

IllegalArgumentException - if request is invalid

See Also:

validateReleaseName(String)

validate

protected void validate(Tiller.RollbackReleaseRequestOrBuilder request)

Validates the supplied Tiller.RollbackReleaseRequestOrBuilder.

Parameters:

request - the request to validate

Throws:

NullPointerException - if request is null

IllegalArgumentException - if request is invalid

See Also:

validateReleaseName(String)

validate

protected void validate(Tiller.TestReleaseRequestOrBuilder request)

Validates the supplied Tiller.TestReleaseRequestOrBuilder.

Parameters:

request - the request to validate

Throws:

NullPointerException - if request is null

IllegalArgumentException - if request is invalid

See Also:

validateReleaseName(String)

validate

protected void validate(Tiller.UninstallReleaseRequestOrBuilder request)

Validates the supplied Tiller.UninstallReleaseRequestOrBuilder.

Parameters:

request - the request to validate

Throws:

NullPointerException - if request is null

IllegalArgumentException - if request is invalid

See Also:

validateReleaseName(String)

validate

protected void validate(Tiller.UpdateReleaseRequestOrBuilder request)

Validates the supplied Tiller.UpdateReleaseRequestOrBuilder.

Parameters:

request - the request to validate

Throws:

NullPointerException - if request is null

IllegalArgumentException - if request is invalid

See Also:

validateReleaseName(String)

validateReleaseName

protected void validateReleaseName(String name)

Ensures that the supplied name is a valid Helm release name.

Because frequently Helm releases are not required to be named by the end user, a null or empty name is valid.

Because Helm release names are often used in hostnames, they should conform to RFC 1123. This method performs that validation by default, using the DNS_SUBDOMAIN_PATTERN field.

Parameters:

name - the name to validate; may be null or String.isEmpty() since Tiller will generate a valid name in such a case using the moniker project; if non-null must match the pattern represented by the value of the DNS_SUBDOMAIN_PATTERN field

See Also:

DNS_SUBDOMAIN_PATTERN, RFC 1123

validateNamespace

protected void validateNamespace(String namespace)

Ensures that the supplied namespace is a valid namespace.

Namespaces must conform to RFC 1123. This method performs that validation by default, using the DNS_SUBDOMAIN_PATTERN field.

Parameters:

namespace - the namespace to validate; may be null or String.isEmpty()

See Also:

DNS_LABEL_PATTERN, RFC 1123