Helm2Connector (Deprecated)

The Helm v2 connector can spawn complex, multi-container environments on a Kubernetes cluster. The deployment unit is the entire Helm release, while the binding unit is the single container in a Pod. StreamFlow requires each container in a Helm release to have a unique name attribute, allowing an unambiguous identification. Finally, the scheduling unit is the single instance of a potentially replicated container in a ReplicaSet.

Warning

Starting from November 2020, Helm v2 is discontinued even for security patches. Consequently, the Helm2Connector class is deprecated in favour of the Helm3Connector. The Helm2Connector class will no longer be available in StreamFlow 0.2.0 and later.

properties

chart (required)

A chart archive. This can be a chart reference, a path to a packaged chart, a path to an unpacked chart directory or a URL

type

string

atomic

If set, installation process purges chart on fail (also sets wait flag)

type

boolean

caFile

Verify certificates of HTTPS-enabled servers using this CA bundle

type

string

certFile

Identify HTTPS client using this SSL certificate file

type

string

chartVersion

Specify the exact chart version to install

type

string

default

latest

commandLineValues

Set values on the command line. Can separate values with commas: key1=val1,key2=val2

type

string

debug

Enable verbose output

type

boolean

depUp

Run helm dependency update before installing the chart

type

boolean

description

Specify a description for the release

type

string

devel

Use development versions, too (equivalent to version >0.0.0-0). If version is set, this is ignored

type

boolean

fileValues

Set values from respective files. Can separate values with commas: key1=path1,key2=path2

type

string

inCluster

If true, the Helm connector will use a ServiceAccount to connect to the Kubernetes cluster. This is useful when StreamFlow runs directly inside a Kubernetes Pod

type

boolean

default

False

home

Location of the Helm config

type

string

default

${HOME}/.helm

init

Runs command helm init –upgrade when true

type

boolean

default

False

keyFile

Identify HTTPS client using this SSL key file

type

string

keyring

Location of public keys used for verification

type

string

default

${HOME}/.gnupg/pubring.gpg

kubeContext

Name of the kubeconfig context to use

type

string

kubeconfig

Absolute path of the kubeconfig file to be used

type

string

maxConcurrentConnections

Maximum number of concurrent connections to open for a single Kubernetes client

type

integer

default

4096

namespace

Namespace to install the release into

type

string

default

Current kube config namespace

nameTemplate

Specify template used to name the release

type

string

noCrdHook

Prevent CRD hooks from running, but run other hooks

type

boolean

noHooks

Prevent hooks from running during install

type

boolean

password

Chart repository password where to locate the requested chart

type

string

purge

Remove the release from the store and make its name free for later use

type

boolean

default

True

releaseName

The release name. If unspecified, it will autogenerate one for you

type

string

renderSubchartNotes

Render subchart notes along with the parent

type

boolean

repo

Chart repository url where to locate the requested chart

type

string

resourcesCacheTTL

Available resources cache TTL (in seconds). When such cache expires, the connector performs a new request to check resources availability

type

integer

default

10

stringValues

Set string values. Can separate values with commas: key1=val1,key2=val2

type

string

tillerConnectionTimeout

The duration (in seconds) Helm will wait to establish a connection to Tiller

type

integer

default

300

tillerNamespace

Namespace of Tiller

type

string

default

kube-system

timeout

A value in seconds to wait for Kubernetes commands to complete

type

integer

default

300

tls

Use TLS (implied by –tlsverify)

type

boolean

tlscacert

Trust certs signed only by this CA

type

string

tlscert

Path to TLS certificate file

type

string

tlshostname

The server name used to verify the hostname on the returned certificates from the server

type

string

tlskey

Path to TLS key file

type

string

tlsverify

Use TLS and verify the remote

type

boolean

transferBufferSize

Buffer size allocated for local and remote data transfers

type

integer

default

32MiB - 1B

username

Chart repository username where to locate the requested chart

type

string

yamlValues

Specify values in a list of YAML files and/or URLs

type

string[]

default

verify

Verify the package before installing it

type

boolean

wait

If set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as timeout

type

boolean

default

True