org.microbean.helm

Class Tiller

java.lang.Object

org.microbean.helm.Tiller

All Implemented Interfaces:

ConfigAware<Config>, Closeable, AutoCloseable

public class Tiller
extends Object
implements ConfigAware<Config>, Closeable

A convenience class for communicating with a Tiller server.

Author:

Laird Nelson

See Also:

ReleaseServiceGrpc

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,String>	DEFAULT_LABELS The Kubernetes labels with which most Tiller instances are annotated.
static String	DEFAULT_NAMESPACE The Kubernetes namespace into which Tiller server instances are most commonly installed.
static int	DEFAULT_PORT The port on which Tiller server instances most commonly listen.
static int	MAX_MESSAGE_SIZE The maximum size, in bytes, that messages destined for Tiller may be.
static String	VERSION The version of Tiller Tiller instances expect.

Constructor Summary

Constructors

Constructor and Description
Tiller(LocalPortForward portForward) Creates a new Tiller that will use information from the supplied LocalPortForward to establish a communications channel with the Tiller server.
Tiller(ManagedChannel channel) Creates a new Tiller that will use the supplied ManagedChannel for communication.
Tiller(T client) Creates a new Tiller that will forward a local port to port 44134 on a Pod housing Tiller in the kube-system namespace running in the Kubernetes cluster with which the supplied KubernetesClient is capable of communicating.
Tiller(T client, String namespaceHousingTiller) Creates a new Tiller that will forward a local port to port 44134 on a Pod housing Tiller in the supplied namespace running in the Kubernetes cluster with which the supplied KubernetesClient is capable of communicating.
Tiller(T client, String namespaceHousingTiller, int tillerPort, Map<String,String> tillerLabels) Creates a new Tiller that will forward a local port to the supplied (remote) port on a Pod housing Tiller in the supplied namespace running in the Kubernetes cluster with which the supplied KubernetesClient is capable of communicating.

Method Summary

Modifier and Type	Method and Description
protected @Issue(id="42",uri="https://github.com/microbean/microbean-helm/issues/42") ManagedChannel	buildChannel(LocalPortForward portForward) Creates a ManagedChannel for communication with Tiller from the information contained in the supplied LocalPortForward.
void	close() Closes this Tiller after use; any LocalPortForward or ManagedChannel used or created by or for this Tiller instance will be closed or shut down appropriately.
Config	getConfiguration() Returns any Config available at construction time.
io.grpc.health.v1.HealthGrpc.HealthBlockingStub	getHealthBlockingStub()
io.grpc.health.v1.HealthGrpc.HealthFutureStub	getHealthFutureStub()
io.grpc.health.v1.HealthGrpc.HealthStub	getHealthStub()
ReleaseServiceGrpc.ReleaseServiceBlockingStub	getReleaseServiceBlockingStub() Returns the gRPC-generated ReleaseServiceGrpc.ReleaseServiceBlockingStub object that represents the capabilities of the Tiller server.
ReleaseServiceGrpc.ReleaseServiceFutureStub	getReleaseServiceFutureStub() Returns the gRPC-generated ReleaseServiceGrpc.ReleaseServiceFutureStub object that represents the capabilities of the Tiller server.
ReleaseServiceGrpc.ReleaseServiceStub	getReleaseServiceStub() Returns the gRPC-generated ReleaseServiceGrpc.ReleaseServiceStub object that represents the capabilities of the Tiller server.
VersionOuterClass.VersionOrBuilder	getVersion()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

The version of Tiller Tiller instances expect.

This field is never null.

See Also:

Constant Field Values

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

The Kubernetes namespace into which Tiller server instances are most commonly installed.

This field is never null.

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The port on which Tiller server instances most commonly listen.

See Also:

Constant Field Values

DEFAULT_LABELS

public static final Map<String,String> DEFAULT_LABELS

The Kubernetes labels with which most Tiller instances are annotated.

This field is never null.

MAX_MESSAGE_SIZE

public static final int MAX_MESSAGE_SIZE

The maximum size, in bytes, that messages destined for Tiller may be.

See Also:

Constant Field Values

Constructor Detail

Tiller

public Tiller(ManagedChannel channel)

Creates a new Tiller that will use the supplied ManagedChannel for communication.

Parameters:

channel - the ManagedChannel over which communications will be conducted; must not be null

Throws:

NullPointerException - if channel is null

Tiller

public Tiller(LocalPortForward portForward)

Creates a new Tiller that will use information from the supplied LocalPortForward to establish a communications channel with the Tiller server.

Parameters:

portForward - the LocalPortForward to use; must not be null

Throws:

NullPointerException - if portForward is null

Tiller

public Tiller(T client)
       throws MalformedURLException

Creates a new Tiller that will forward a local port to port 44134 on a Pod housing Tiller in the kube-system namespace running in the Kubernetes cluster with which the supplied KubernetesClient is capable of communicating.

The first ready Pod with a name label whose value is tiller and with an app label whose value is helm is deemed to be the pod housing the Tiller instance to connect to. (This duplicates the default logic of the helm command line executable.)

Type Parameters:

T - a KubernetesClient implementation that is also an HttpClientAware implementation, such as DefaultKubernetesClient

Parameters:

client - the KubernetesClient-and-HttpClientAware implementation that can communicate with a Kubernetes cluster; must not be null

Throws:

MalformedURLException - if there was a problem identifying a Pod within the cluster that houses a Tiller instance

NullPointerException - if client is null

Tiller

public Tiller(T client,
              String namespaceHousingTiller)
       throws MalformedURLException

Creates a new Tiller that will forward a local port to port 44134 on a Pod housing Tiller in the supplied namespace running in the Kubernetes cluster with which the supplied KubernetesClient is capable of communicating.

The first ready Pod with a name label whose value is tiller and with an app label whose value is helm is deemed to be the pod housing the Tiller instance to connect to. (This duplicates the default logic of the helm command line executable.)

Type Parameters:

T - a KubernetesClient implementation that is also an HttpClientAware implementation, such as DefaultKubernetesClient

Parameters:

client - the KubernetesClient-and-HttpClientAware implementation that can communicate with a Kubernetes cluster; must not be null; no reference to this object is retained by this Tiller instance

namespaceHousingTiller - the namespace within which a Tiller instance is hopefully running; if null, then the value of DEFAULT_NAMESPACE will be used instead

Throws:

MalformedURLException - if there was a problem identifying a Pod within the cluster that houses a Tiller instance

NullPointerException - if client is null

KubernetesClientException - if there was a problem connecting to Kubernetes

TillerException - if a ready Tiller pod could not be found and consequently a connection could not be established

Tiller

public Tiller(T client,
              String namespaceHousingTiller,
              int tillerPort,
              Map<String,String> tillerLabels)
       throws MalformedURLException

Creates a new Tiller that will forward a local port to the supplied (remote) port on a Pod housing Tiller in the supplied namespace running in the Kubernetes cluster with which the supplied KubernetesClient is capable of communicating.

The first ready Pod with labels matching the supplied tillerLabels is deemed to be the pod housing the Tiller instance to connect to.

Type Parameters:

T - a KubernetesClient implementation that is also an HttpClientAware implementation, such as DefaultKubernetesClient

Parameters:

client - the KubernetesClient-and-HttpClientAware implementation that can communicate with a Kubernetes cluster; must not be null; no reference to this object is retained by this Tiller instance

namespaceHousingTiller - the namespace within which a Tiller instance is hopefully running; if null, then the value of DEFAULT_NAMESPACE will be used instead

tillerPort - the remote port to attempt to forward a local port to; normally 44134

tillerLabels - a Map representing the Kubernetes labels (and their values) identifying a Pod housing a Tiller instance; if null then the value of DEFAULT_LABELS will be used instead

Throws:

MalformedURLException - if there was a problem identifying a Pod within the cluster that houses a Tiller instance

NullPointerException - if client is null

KubernetesClientException - if there was a problem connecting to Kubernetes

TillerException - if a ready Tiller pod could not be found and consequently a connection could not be established

Method Detail

getConfiguration

public Config getConfiguration()

Returns any Config available at construction time.

This method may return null.

Specified by:

getConfiguration in interface ConfigAware<Config>

Returns:

a Config, or null

buildChannel

@Issue(id="42",
       uri="https://github.com/microbean/microbean-helm/issues/42")
protected @Issue(id="42",uri="https://github.com/microbean/microbean-helm/issues/42") ManagedChannel buildChannel(LocalPortForward portForward)

Creates a ManagedChannel for communication with Tiller from the information contained in the supplied LocalPortForward.

Note: This method is (deliberately) called from constructors so must have stateless semantics.

This method never returns null.

Overrides of this method must not return null.

Parameters:

portForward - a LocalPortForward; must not be null

Returns:

a non-null ManagedChannel

Throws:

NullPointerException - if portForward is null

IllegalArgumentException - if portForward's LocalPortForward.getLocalAddress() method returns null

close

public void close()
           throws IOException

Closes this Tiller after use; any LocalPortForward or ManagedChannel used or created by or for this Tiller instance will be closed or shut down appropriately.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if there was a problem closing the underlying connection to a Tiller instance

See Also:

Closeable.close(), ManagedChannel.shutdown()

getReleaseServiceBlockingStub

public ReleaseServiceGrpc.ReleaseServiceBlockingStub getReleaseServiceBlockingStub()

Returns the gRPC-generated ReleaseServiceGrpc.ReleaseServiceBlockingStub object that represents the capabilities of the Tiller server.

This method will never return null.

Overrides of this method must never return null.

Returns:

a non-null ReleaseServiceGrpc.ReleaseServiceBlockingStub

See Also:

ReleaseServiceGrpc.ReleaseServiceBlockingStub

getReleaseServiceFutureStub

public ReleaseServiceGrpc.ReleaseServiceFutureStub getReleaseServiceFutureStub()

Returns the gRPC-generated ReleaseServiceGrpc.ReleaseServiceFutureStub object that represents the capabilities of the Tiller server.

This method will never return null.

Overrides of this method must never return null.

Returns:

a non-null ReleaseServiceGrpc.ReleaseServiceFutureStub

See Also:

ReleaseServiceGrpc.ReleaseServiceFutureStub

getReleaseServiceStub

public ReleaseServiceGrpc.ReleaseServiceStub getReleaseServiceStub()

Returns the gRPC-generated ReleaseServiceGrpc.ReleaseServiceStub object that represents the capabilities of the Tiller server.

This method will never return null.

Overrides of this method must never return null.

Returns:

a non-null ReleaseServiceGrpc.ReleaseServiceStub

See Also:

ReleaseServiceGrpc.ReleaseServiceStub

getHealthBlockingStub

public io.grpc.health.v1.HealthGrpc.HealthBlockingStub getHealthBlockingStub()

getHealthFutureStub

public io.grpc.health.v1.HealthGrpc.HealthFutureStub getHealthFutureStub()

getHealthStub

public io.grpc.health.v1.HealthGrpc.HealthStub getHealthStub()

getVersion

public VersionOuterClass.VersionOrBuilder getVersion()
                                              throws IOException

Throws:

IOException