org.microbean.helm

Class TillerInstaller

java.lang.Object

org.microbean.helm.TillerInstaller

@Experimental
public class TillerInstaller
extends Object

A class that idiomatically but faithfully emulates the Tiller-installing behavior of the helm init command.

In general, this class follows the logic as expressed in the install.go source code from the Helm project, problematic or not. The intent is to have an installer, usable as an idiomatic Java library, that behaves just like helm init.

Note: This class is experimental and its API is subject to change without notice.

Author:

Laird Nelson

See Also:

init(), The {@code install.go} source code from the Helm project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TillerInstaller.ImagePullPolicy An enum representing valid values for a Kubernetes imagePullPolicy field.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION The version of Tiller to install.

Constructor Summary

Constructors

Constructor and Description
TillerInstaller() Creates a new TillerInstaller, using a new DefaultKubernetesClient.
TillerInstaller(KubernetesClient kubernetesClient) Creates a new TillerInstaller.

Method Summary

Modifier and Type	Method and Description
protected Container	createContainer(String imageName, TillerInstaller.ImagePullPolicy imagePullPolicy, String namespace, boolean tls, boolean verifyTls)
protected Deployment	createDeployment(String namespace, String deploymentName, Map<String,String> labels, String serviceAccountName, String imageName, TillerInstaller.ImagePullPolicy imagePullPolicy, boolean hostNetwork, boolean tls, boolean verifyTls)
protected DeploymentSpec	createDeploymentSpec(Map<String,String> labels, String serviceAccountName, String imageName, TillerInstaller.ImagePullPolicy imagePullPolicy, String namespace, boolean hostNetwork, boolean tls, boolean verifyTls)
protected Secret	createSecret(String namespace, URI tlsKeyUri, URI tlsCertUri, URI tlsCaCertUri, Map<String,String> labels)
protected Service	createService(String namespace, String serviceName, Map<String,String> labels)
protected ServiceSpec	createServiceSpec(Map<String,String> labels)
void	init()
void	init(boolean upgrade)
void	init(boolean upgrade, String namespace, String deploymentName, String serviceName, Map<String,String> labels, String serviceAccountName, String imageName, TillerInstaller.ImagePullPolicy imagePullPolicy, boolean hostNetwork, boolean tls, boolean verifyTls, URI tlsKeyUri, URI tlsCertUri, URI tlsCaCertUri) Attempts to install Tiller into the Kubernetes cluster, silently returning if Tiller is already installed and upgrade is false, or upgrading the Tiller installation if upgrade is true and a newer version of Tiller is available.
void	install()
void	install(String namespace, String deploymentName, String serviceName, Map<String,String> labels, String serviceAccountName, String imageName, TillerInstaller.ImagePullPolicy imagePullPolicy, boolean hostNetwork, boolean tls, boolean verifyTls, URI tlsKeyUri, URI tlsCertUri, URI tlsCaCertUri)
protected static String	normalizeDeploymentName(String deploymentName)
protected static String	normalizeImageName(String imageName)
protected static Map<String,String>	normalizeLabels(Map<String,String> labels)
protected String	normalizeNamespace(String namespace)
protected static String	normalizeServiceAccountName(String serviceAccountName)
protected static String	normalizeServiceName(String serviceName)
void	upgrade()
void	upgrade(String namespace, String deploymentName, String serviceName, String serviceAccountName, String imageName, TillerInstaller.ImagePullPolicy imagePullPolicy, Map<String,String> labels)

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 to install.

See Also:

Constant Field Values

Constructor Detail

TillerInstaller

public TillerInstaller()

Creates a new TillerInstaller, using a new DefaultKubernetesClient.

See Also:

TillerInstaller(KubernetesClient)

TillerInstaller

public TillerInstaller(KubernetesClient kubernetesClient)

Creates a new TillerInstaller.

Parameters:

kubernetesClient - the KubernetesClient to use to communicate with Kubernetes; must not be null

Throws:

NullPointerException - if kubernetesClient is null

Method Detail

init

public void init()

init

public void init(boolean upgrade)

init

public void init(boolean upgrade,
                 String namespace,
                 String deploymentName,
                 String serviceName,
                 Map<String,String> labels,
                 String serviceAccountName,
                 String imageName,
                 TillerInstaller.ImagePullPolicy imagePullPolicy,
                 boolean hostNetwork,
                 boolean tls,
                 boolean verifyTls,
                 URI tlsKeyUri,
                 URI tlsCertUri,
                 URI tlsCaCertUri)
          throws IOException

Attempts to install Tiller into the Kubernetes cluster, silently returning if Tiller is already installed and upgrade is false, or upgrading the Tiller installation if upgrade is true and a newer version of Tiller is available.

Parameters:

upgrade - whether or not to attempt an upgrade if Tiller is already installed

namespace - the Kubernetes namespace into which Tiller will be installed, if it is not already installed; may be null in which case a default will be used

deploymentName - the name that the Kubernetes Deployment representing Tiller will have; may be null; tiller-deploy by default

serviceName - the name that the Kubernetes Service representing Tiller will have; may be null; tiller-deploy (yes, tiller-deploy) by default

labels - the Kubernetes Labels that will be applied to various Kubernetes resources representing Tiller; may be null in which case a Map consisting of a label of app with a value of helm and a label of name with a value of tiller will be used instead

serviceAccountName - the name of the Kubernetes Service Account that Tiller should use; may be null in which case the default Service Account will be used instead

imageName - the name of the Docker image that contains the Tiller code; may be null in which case gcr.io/kubernetes-helm/tiller:v2.5.0 will be used instead

imagePullPolicy - an TillerInstaller.ImagePullPolicy specifying how the Tiller image should be pulled; may be null in which case TillerInstaller.ImagePullPolicy.IF_NOT_PRESENT will be used instead

hostNetwork - the value to be used for the hostNetwork property of the Tiller Pod's PodSpec

tls - whether Tiller's conversations with Kubernetes will be encrypted using TLS

verifyTls - whether, if and only if tls is true, additional TLS-related verification will be performed

tlsKeyUri - a URI to the public key used during TLS communication with Kubernetes; may be null if tls is false

tlsCertUri - a URI to the certificate used during TLS communication with Kubernetes; may be null if tls is false

tlsCaCertUri - a URI to the certificate authority used during TLS communication with Kubernetes; may be null if tls is false

Throws:

IOException - if a communication error occurs

See Also:

install(String, String, String, Map, String, String, ImagePullPolicy, boolean, boolean, boolean, URI, URI, URI), upgrade(String, String, String, String, String, ImagePullPolicy, Map)

install

public void install()

install

public void install(String namespace,
                    String deploymentName,
                    String serviceName,
                    Map<String,String> labels,
                    String serviceAccountName,
                    String imageName,
                    TillerInstaller.ImagePullPolicy imagePullPolicy,
                    boolean hostNetwork,
                    boolean tls,
                    boolean verifyTls,
                    URI tlsKeyUri,
                    URI tlsCertUri,
                    URI tlsCaCertUri)
             throws IOException

Throws:

IOException

upgrade

public void upgrade()

upgrade

public void upgrade(String namespace,
                    String deploymentName,
                    String serviceName,
                    String serviceAccountName,
                    String imageName,
                    TillerInstaller.ImagePullPolicy imagePullPolicy,
                    Map<String,String> labels)

createService

protected Service createService(String namespace,
                                String serviceName,
                                Map<String,String> labels)

createDeployment

protected Deployment createDeployment(String namespace,
                                      String deploymentName,
                                      Map<String,String> labels,
                                      String serviceAccountName,
                                      String imageName,
                                      TillerInstaller.ImagePullPolicy imagePullPolicy,
                                      boolean hostNetwork,
                                      boolean tls,
                                      boolean verifyTls)

createSecret

protected Secret createSecret(String namespace,
                              URI tlsKeyUri,
                              URI tlsCertUri,
                              URI tlsCaCertUri,
                              Map<String,String> labels)
                       throws IOException

Throws:

IOException

createDeploymentSpec

protected DeploymentSpec createDeploymentSpec(Map<String,String> labels,
                                              String serviceAccountName,
                                              String imageName,
                                              TillerInstaller.ImagePullPolicy imagePullPolicy,
                                              String namespace,
                                              boolean hostNetwork,
                                              boolean tls,
                                              boolean verifyTls)

createContainer

protected Container createContainer(String imageName,
                                    TillerInstaller.ImagePullPolicy imagePullPolicy,
                                    String namespace,
                                    boolean tls,
                                    boolean verifyTls)

createServiceSpec

protected ServiceSpec createServiceSpec(Map<String,String> labels)

normalizeNamespace

protected final String normalizeNamespace(String namespace)

normalizeLabels

protected static final Map<String,String> normalizeLabels(Map<String,String> labels)

normalizeDeploymentName

protected static final String normalizeDeploymentName(String deploymentName)

normalizeImageName

protected static final String normalizeImageName(String imageName)

normalizeServiceAccountName

protected static final String normalizeServiceAccountName(String serviceAccountName)

normalizeServiceName

protected static final String normalizeServiceName(String serviceName)