installer

Documentation

Index

• Constants
• func Deployment(opts *Options) (*appsv1.Deployment, error)
• func Initialize(home helmpath.Home, out io.Writer, skipRefresh bool, ...) error
• func InitializeWithoutRepos(home helmpath.Home, out io.Writer) error
• func Install(client kubernetes.Interface, opts *Options) error
• func Secret(opts *Options) (*v1.Secret, error)
• func Service(namespace string) *v1.Service
• func TillerManifests(opts *Options) ([]string, error)
• func Uninstall(client kubernetes.Interface, opts *Options) error
• func Upgrade(client kubernetes.Interface, opts *Options) error
• type Options
  • func (opts *Options) SelectImage() string
• type OutputFormat
  • func (f *OutputFormat) Set(s string) error
  • func (f *OutputFormat) String() string
  • func (f *OutputFormat) Type() string

Constants

const (

	// LocalRepository is the standard name of the local repository
	LocalRepository = "local"

	// LocalRepositoryIndexFile is the standard name of the local repository index file
	LocalRepositoryIndexFile = "index.yaml"
)

Functions

func Deployment

func Deployment(opts *Options) (*appsv1.Deployment, error)

Deployment gets a deployment object that can be used to generate a manifest as a string. This object should not be submitted directly to the Kubernetes api

func Initialize

func Initialize(home helmpath.Home, out io.Writer, skipRefresh bool, settings helm_env.EnvSettings, stableRepositoryURL, localRepositoryURL string) error

Initialize initializes local config

Returns an error if the command failed.

func InitializeWithoutRepos

func InitializeWithoutRepos(home helmpath.Home, out io.Writer) error

InitializeWithoutRepos initializes local config without adding repos

Returns an error if the command failed.

func Install

func Install(client kubernetes.Interface, opts *Options) error

Install uses Kubernetes client to install Tiller.

Returns an error if the command failed.

func Secret

func Secret(opts *Options) (*v1.Secret, error)

Secret gets a secret object that can be used to generate a manifest as a string. This object should not be submitted directly to the Kubernetes api

func Service

func Service(namespace string) *v1.Service

Service gets a service object that can be used to generate a manifest as a string. This object should not be submitted directly to the Kubernetes api

func TillerManifests

func TillerManifests(opts *Options) ([]string, error)

TillerManifests gets the Deployment, Service, and Secret (if tls-enabled) manifests

func Uninstall

func Uninstall(client kubernetes.Interface, opts *Options) error

Uninstall uses Kubernetes client to uninstall Tiller.

func Upgrade

func Upgrade(client kubernetes.Interface, opts *Options) error

Upgrade uses Kubernetes client to upgrade Tiller to current version.

Returns an error if the command failed.

Types

type Options

type Options struct {
	// EnableTLS instructs Tiller to serve with TLS enabled.
	//
	// Implied by VerifyTLS. If set the TLSKey and TLSCert are required.
	EnableTLS bool

	// VerifyTLS instructs Tiller to serve with TLS enabled verify remote certificates.
	//
	// If set TLSKey, TLSCert, TLSCaCert are required.
	VerifyTLS bool

	// UseCanary indicates that Tiller should deploy using the latest Tiller image.
	UseCanary bool

	// Namespace is the Kubernetes namespace to use to deploy Tiller.
	Namespace string

	// ServiceAccount is the Kubernetes service account to add to Tiller.
	ServiceAccount string

	// AutoMountServiceAccountToken determines whether or not the service account should be added to Tiller.
	AutoMountServiceAccountToken bool

	// ForceUpgrade allows to force upgrading tiller if deployed version is greater than current version
	ForceUpgrade bool

	// ImageSpec identifies the image Tiller will use when deployed.
	//
	// Valid if and only if UseCanary is false.
	ImageSpec string

	// TLSKeyFile identifies the file containing the pem encoded TLS private
	// key Tiller should use.
	//
	// Required and valid if and only if EnableTLS or VerifyTLS is set.
	TLSKeyFile string

	// TLSCertFile identifies the file containing the pem encoded TLS
	// certificate Tiller should use.
	//
	// Required and valid if and only if EnableTLS or VerifyTLS is set.
	TLSCertFile string

	// TLSCaCertFile identifies the file containing the pem encoded TLS CA
	// certificate Tiller should use to verify remotes certificates.
	//
	// Required and valid if and only if VerifyTLS is set.
	TLSCaCertFile string

	// EnableHostNetwork installs Tiller with net=host.
	EnableHostNetwork bool

	// MaxHistory sets the maximum number of release versions stored per release.
	//
	// Less than or equal to zero means no limit.
	MaxHistory int

	// Replicas sets the amount of Tiller replicas to start
	//
	// Less than or equals to 1 means 1.
	Replicas int

	// NodeSelectors determine which nodes Tiller can land on.
	NodeSelectors string

	// Output dumps the Tiller manifest in the specified format (e.g. JSON) but skips Helm/Tiller installation.
	Output OutputFormat

	// Set merges additional values into the Tiller Deployment manifest.
	Values []string
}

Options control how to install Tiller into a cluster, upgrade, and uninstall Tiller from a cluster.

func (*Options) SelectImage

func (opts *Options) SelectImage() string

SelectImage returns the image according to whether UseCanary is true or not

type OutputFormat

type OutputFormat string

OutputFormat defines valid values for init output (json, yaml)

func (*OutputFormat) Set

func (f *OutputFormat) Set(s string) error

Set validates and sets the value of the OutputFormat

func (*OutputFormat) String

func (f *OutputFormat) String() string

String returns the string value of the OutputFormat

func (*OutputFormat) Type

func (f *OutputFormat) Type() string

Type returns the string value of the OutputFormat