Skip to content

Latest commit

 

History

History
2037 lines (853 loc) · 23.8 KB

REFERENCE.md

File metadata and controls

2037 lines (853 loc) · 23.8 KB

Reference

Table of Contents

Classes

  • helm: Class: helm =========================== A module to install Helm, the Kubernetes package manager. Parameters ---------- [*canary_image] Us
  • helm::account_config: == Class: helm::account_config
  • helm::binary: == Class: helm::binary
  • helm::config: == Class: helm::config
  • helm::params: == Class: helm::params

Defined types

Functions

Classes

helm

Class: helm

A module to install Helm, the Kubernetes package manager.

Parameters

[*canary_image] Use the helm canary image for the default init of helm. Defaults to false

[*client_only] Make the default init install the client only. Defaults to false

[debug] Set output logging to debug for the default init. Defaults to false

[dry_run] Make the default init run in dry-run mode. Defaults to false

[env] Environment variables to specify the location of configruation files, or any other custom variables required for helm to run. Defaults to [ 'HOME=/root', 'KUBECONFIG=/root/admin.conf']

[home] Set the HELM_HOME variable for the default init. Defaults to undef

[host] Specify the HELM_HOST for the default init. Defaults to undef

[init] Determines the behaviour of the config function. Setting to true will init the cluster and install tiller. False will install Helm in client only mode. Defaults to true

[install_path] The path to extract helm binary to. Defaults to '/usr/bin'

[kube_context] Specify the kube_context for the default init. Defaults to undef

[local_repo_url] Specify the local_repo_url for the default init. Defaults to undef

[net_host] Enable net_host mode for the default init. Defaults to false

[node_selectors] Specify node selectors for the helm init on the default init. Defaults to undef

[overrides] Specify override parameters for the default init. Defaults to undef

[path] The PATH variable used for exec types. Defaults to ['/bin','/usr/bin']

[proxy] Specify an internet proxy if necessary. Defaults to undef

[service_account] The service account for tiller Defaults to 'tiller'

[skip_refresh] Enable skip refresh mode for the default init. Defaults to false

[stable_repo_url] Specify the stable repo url for the default init. Defaults to undef

[tiller_image] Specify the image for the tiller install in the default init. Defaults to undef

[tiller_image_pull_secrets] Optionnaly put imagePullSecret(s) in tiller's serviceaccount.

[tiller_namespaces] Array of namespaces in which to install tiller Defaults to ['kube-system']

[tiller_tls] Enable TLS for tiller in the default init. Defaults to false

[tiller_tls_cert] Specify a TLS cert for tiller in the default init. Defaults to undef

[tiller_tls_key] Specify a TLS key for tiller in the default init. Defaults to undef

[tiller_tls_verify] Enable TLS verification for tiller in the default init. Defaults to undef

[tls_ca_cert] Specify a TLS CA certificate for tiller in the default init. Defaults to undef

[upgrade] Whether to upgrade tiller in the default init. Defaults to false

[version] The version of helm to install. Defaults to 2.5.1

[archive_baseurl] The base URL for downloading the helm archive, must contain file helm-v${version}-linux-${arch}.tar.gz Defaults to https://kubernetes-helm.storage.googleapis.com URLs supported by puppet/archive module will work, e.g. puppet:///modules/helm_files

Parameters

The following parameters are available in the helm class.

canary_image

Data type: Boolean

Default value: $helm::params::canary_image

client_only

Data type: Boolean

Default value: $helm::params::client_only

debug

Data type: Boolean

Default value: $helm::params::debug

dry_run

Data type: Boolean

Default value: $helm::params::dry_run

env

Data type: Array

Default value: $helm::params::env

home

Data type: Optional[String]

Default value: $helm::params::home

host

Data type: Optional[String]

Default value: $helm::params::host

init

Data type: Boolean

Default value: $helm::params::init

install_path

Data type: String

Default value: $helm::params::install_path

kube_context

Data type: Optional[String]

Default value: $helm::params::kube_context

local_repo_url

Data type: Optional[String]

Default value: $helm::params::local_repo_url

proxy

Data type: Optional[String]

Default value: $helm::params::proxy

net_host

Data type: Optional[Boolean]

Default value: $helm::params::net_host

node_selectors

Data type: Optional[String]

Default value: $helm::params::node_selectors

overrides

Data type: Optional[Array]

Default value: $helm::params::overrides

path

Data type: Array

Default value: $helm::params::path

service_account

Data type: String

Default value: $helm::params::service_account

skip_refresh

Data type: Boolean

Default value: $helm::params::skip_refresh

stable_repo_url

Data type: Optional[String]

Default value: $helm::params::stable_repo_url

tiller_image

Data type: Optional[String]

Default value: $helm::params::tiller_image

tiller_image_pull_secrets

Data type: Optional[Array[String]]

Default value: $helm::params::tiller_image_pull_secrets

tiller_namespaces

Data type: Array[String]

Default value: $helm::params::tiller_namespaces

tiller_tls

Data type: Boolean

Default value: $helm::params::tiller_tls

tiller_tls_cert

Data type: Optional[String]

Default value: $helm::params::tiller_tls_cert

tiller_tls_key

Data type: Optional[String]

Default value: $helm::params::tiller_tls_key

tiller_tls_verify

Data type: Boolean

Default value: $helm::params::tiller_tls_verify

tls_ca_cert

Data type: Optional[String]

Default value: $helm::params::tls_ca_cert

upgrade

Data type: Boolean

Default value: $helm::params::upgrade

version

Data type: String

Default value: $helm::params::version

archive_baseurl

Data type: String

Default value: $helm::params::archive_baseurl

helm::account_config

== Class: helm::account_config

Parameters

The following parameters are available in the helm::account_config class.

env

Data type: Array

Default value: $helm::env

path

Data type: Array

Default value: $helm::path

service_account

Data type: String

Default value: $helm::service_account

tiller_image_pull_secrets

Data type: Optional[Array[String]]

Default value: $helm::tiller_image_pull_secrets

tiller_namespaces

Data type: Array[String]

Default value: $helm::tiller_namespaces

helm::binary

== Class: helm::binary

Parameters

The following parameters are available in the helm::binary class.

version

Data type: String

Default value: $helm::version

install_path

Data type: String

Default value: $helm::install_path

proxy

Data type: Optional[String]

Default value: $helm::proxy

archive_baseurl

Data type: String

Default value: $helm::archive_baseurl

helm::config

== Class: helm::config

Parameters

The following parameters are available in the helm::config class.

canary_image

Data type: Boolean

Default value: $helm::canary_image

client_only

Data type: Boolean

Default value: $helm::client_only

debug

Data type: Boolean

Default value: $helm::debug

dry_run

Data type: Boolean

Default value: $helm::dry_run

env

Data type: Array

Default value: $helm::env

home

Data type: Optional[String]

Default value: $helm::home

host

Data type: Optional[String]

Default value: $helm::host

init

Data type: Boolean

Default value: $helm::init

kube_context

Data type: Optional[String]

Default value: $helm::kube_context

local_repo_url

Data type: Optional[String]

Default value: $helm::local_repo_url

net_host

Data type: Boolean

Default value: $helm::net_host

node_selectors

Data type: Optional[String]

Default value: $helm::node_selectors

overrides

Data type: Optional[Array]

Default value: $helm::overrides

path

Data type: Array

Default value: $helm::path

service_account

Data type: String

Default value: $helm::service_account

skip_refresh

Data type: Boolean

Default value: $helm::skip_refresh

stable_repo_url

Data type: Optional[String]

Default value: $helm::stable_repo_url

tiller_image

Data type: Optional[String]

Default value: $helm::tiller_image

tiller_namespaces

Data type: Array[String]

Default value: $helm::tiller_namespaces

tiller_tls

Data type: Boolean

Default value: $helm::tiller_tls

tiller_tls_cert

Data type: Optional[String]

Default value: $helm::tiller_tls_cert

tiller_tls_key

Data type: Optional[String]

Default value: $helm::tiller_tls_key

tiller_tls_verify

Data type: Boolean

Default value: $helm::tiller_tls_verify

tls_ca_cert

Data type: Optional[String]

Default value: $helm::tls_ca_cert

upgrade

Data type: Boolean

Default value: $helm::upgrade

helm::params

== Class: helm::params

Defined types

helm::chart

== helm::chart

Parameters

The following parameters are available in the helm::chart defined type.

ensure

Data type: String

Default value: present

ca_file

Data type: Optional[String]

Default value: undef

cert_file

Data type: Optional[String]

Default value: undef

chart

Data type: Optional[String]

Default value: undef

debug

Data type: Boolean

Default value: false

devel

Data type: Boolean

Default value: false

dry_run

Data type: Boolean

Default value: false

env

Data type: Optional[Array]

Default value: undef

key_file

Data type: Optional[String]

Default value: undef

key_ring

Data type: Optional[String]

Default value: undef

home

Data type: Optional[String]

Default value: undef

host

Data type: Optional[String]

Default value: undef

kube_context

Data type: Optional[String]

Default value: undef

name_template

Data type: Optional[String]

Default value: undef

namespace

Data type: Optional[String]

Default value: undef

no_hooks

Data type: Boolean

Default value: false

path

Data type: Optional[Array]

Default value: undef

purge

Data type: Boolean

Default value: true

replace

Data type: Boolean

Default value: false

repo

Data type: Optional[String]

Default value: undef

release_name

Data type: Optional[String]

Default value: undef

set

Data type: Optional[Array]

Default value: []

timeout

Data type: Optional[Integer]

Default value: undef

tiller_namespace

Data type: Optional[String]

Default value: 'kube-system'

tls

Data type: Boolean

Default value: false

tls_ca_cert

Data type: Optional[String]

Default value: undef

tls_cert

Data type: Optional[String]

Default value: undef

tls_key

Data type: Optional[String]

Default value: undef

tls_verify

Data type: Boolean

Default value: false

values

Data type: Optional[Array]

Default value: []

verify

Data type: Boolean

Default value: false

version

Data type: Optional[String]

Default value: undef

wait

Data type: Boolean

Default value: false

helm::chart_update

The helm::chart_update class.

Parameters

The following parameters are available in the helm::chart_update defined type.

ensure

Data type: String

Default value: present

ca_file

Data type: Optional[String]

Default value: undef

cert_file

Data type: Optional[String]

Default value: undef

chart

Data type: Optional[String]

Default value: undef

debug

Data type: Boolean

Default value: false

devel

Data type: Boolean

Default value: false

dry_run

Data type: Boolean

Default value: false

env

Data type: Optional[Array]

Default value: undef

key_file

Data type: Optional[String]

Default value: undef

keyring

Data type: Optional[String]

Default value: undef

home

Data type: Optional[String]

Default value: undef

host

Data type: Optional[String]

Default value: undef

install

Data type: Boolean

Default value: true

kube_context

Data type: Optional[String]

Default value: undef

namespace

Data type: Optional[String]

Default value: undef

no_hooks

Data type: Boolean

Default value: false

path

Data type: Array

Default value: undef

purge

Data type: Boolean

Default value: true

repo

Data type: Optional[String]

Default value: undef

release_name

Data type: Optional[String]

Default value: undef

recreate_pods

Data type: Optional[String]

Default value: undef

reset_values

Data type: Optional[String]

Default value: undef

reuse_values

Data type: Optional[String]

Default value: undef

set

Data type: Optional[Array]

Default value: []

timeout

Data type: Optional[Integer]

Default value: undef

tiller_namespace

Data type: String

Default value: 'kube-system'

tls

Data type: Boolean

Default value: false

tls_ca_cert

Data type: Optional[String]

Default value: undef

tls_cert

Data type: Optional[String]

Default value: undef

tls_key

Data type: Optional[String]

Default value: undef

tls_verify

Data type: Boolean

Default value: false

values

Data type: Optional[Array]

Default value: []

verify

Data type: Boolean

Default value: false

version

Data type: Optional[String]

Default value: undef

wait

Data type: Boolean

Default value: false

helm::create

== helm::create

Parameters

The following parameters are available in the helm::create defined type.

chart_name

Data type: Optional[String]

Default value: undef

chart_path

Data type: Optional[String]

Default value: undef

debug

Data type: Boolean

Default value: false

env

Data type: Optional[Array]

Default value: undef

home

Data type: Optional[String]

Default value: undef

host

Data type: Optional[String]

Default value: undef

kube_context

Data type: Optional[String]

Default value: undef

path

Data type: Optional[Array]

Default value: undef

starter

Data type: Optional[String]

Default value: undef

tiller_namespace

Data type: Optional[String]

Default value: undef

helm::helm_init

== helm::helm_init

Parameters

The following parameters are available in the helm::helm_init defined type.

init

Data type: Boolean

Default value: true

canary_image

Data type: Boolean

Default value: false

client_only

Data type: Boolean

Default value: false

debug

Data type: Boolean

Default value: false

dry_run

Data type: Boolean

Default value: false

env

Data type: Optional[Array]

Default value: undef

home

Data type: Optional[String]

Default value: undef

host

Data type: Optional[String]

Default value: undef

kube_context

Data type: Optional[String]

Default value: undef

local_repo_url

Data type: Optional[String]

Default value: undef

net_host

Data type: Boolean

Default value: false

path

Data type: Optional[Array]

Default value: undef

service_account

Data type: Optional[String]

Default value: undef

skip_refresh

Data type: Boolean

Default value: false

stable_repo_url

Data type: Optional[String]

Default value: undef

overrides

Data type: Optional[Array]

Default value: undef

node_selectors

Data type: Optional[String]

Default value: undef

tiller_image

Data type: Optional[String]

Default value: undef

tiller_namespace

Data type: String

Default value: 'kube-system'

tiller_tls

Data type: Boolean

Default value: false

tiller_tls_cert

Data type: Optional[String]

Default value: undef

tiller_tls_key

Data type: Optional[String]

Default value: undef

tiller_tls_verify

Data type: Boolean

Default value: false

tls_ca_cert

Data type: Optional[String]

Default value: undef

upgrade

Data type: Boolean

Default value: false

helm::package

== helm::package

Parameters

The following parameters are available in the helm::package defined type.

chart_name

Data type: Optional[String]

Default value: undef

chart_path

Data type: Optional[String]

Default value: undef

debug

Data type: Boolean

Default value: false

dependency_update

Data type: Boolean

Default value: false

destination

Data type: Optional[String]

Default value: undef

env

Data type: Optional[Array]

Default value: undef

home

Data type: Optional[String]

Default value: undef

host

Data type: Optional[String]

Default value: undef

key

Data type: Optional[String]

Default value: undef

keystring

Data type: Optional[String]

Default value: undef

kube_context

Data type: Optional[String]

Default value: undef

path

Data type: Optional[Array]

Default value: undef

save

Data type: Boolean

Default value: true

sign

Data type: Boolean

Default value: false

tiller_namespace

Data type: Optional[String]

Default value: undef

version

Data type: Optional[String]

Default value: undef

helm::repo

== helm::repo

Parameters

The following parameters are available in the helm::repo defined type.

ensure

Data type: String

Default value: present

ca_file

Data type: Optional[String]

Default value: undef

cert_file

Data type: Optional[String]

Default value: undef

debug

Data type: Boolean

Default value: false

env

Data type: Optional[Array]

Default value: undef

key_file

Data type: Optional[String]

Default value: undef

no_update

Data type: Boolean

Default value: false

home

Data type: Optional[String]

Default value: undef

host

Data type: Optional[String]

Default value: undef

kube_context

Data type: Optional[String]

Default value: undef

path

Data type: Optional[Array]

Default value: undef

tiller_namespace

Data type: Optional[String]

Default value: undef

username

Data type: Optional[String]

Default value: undef

password

Data type: Optional[String]

Default value: undef

repo_name

Data type: Optional[String]

Default value: undef

url

Data type: Optional[String]

Default value: undef

helm::repo_update

== helm::repo_update

Parameters

The following parameters are available in the helm::repo_update defined type.

debug

Data type: Boolean

Default value: false

env

Data type: Optional[Array]

Default value: undef

home

Data type: Optional[String]

Default value: undef

host

Data type: Optional[String]

Default value: undef

kube_context

Data type: Optional[String]

Default value: undef

path

Data type: Optional[Array]

Default value: undef

tiller_namespace

Data type: Optional[String]

Default value: undef

update

Data type: Boolean

Default value: true

Functions

helm_chart_update_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm install chart flags

helm_chart_update_flags()

Transforms a hash into a string of helm install chart flags

Returns: Any

helm_create_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm create flags

helm_create_flags()

Transforms a hash into a string of helm create flags

Returns: Any

helm_delete_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm delete flags

helm_delete_flags()

Transforms a hash into a string of helm delete flags

Returns: Any

helm_init_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm init flags

helm_init_flags()

Transforms a hash into a string of helm init flags

Returns: Any

helm_install_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm install chart flags

helm_install_flags()

Transforms a hash into a string of helm install chart flags

Returns: Any

helm_ls_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm ls flags

helm_ls_flags()

Transforms a hash into a string of helm ls flags

Returns: Any

helm_package_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm package flags

helm_package_flags()

Transforms a hash into a string of helm package flags

Returns: Any

helm_repo_add_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm repo add flags

helm_repo_add_flags()

Transforms a hash into a string of helm repo add flags

Returns: Any

helm_repo_remove_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm repo remove flags

helm_repo_remove_flags()

Transforms a hash into a string of helm repo remove flags

Returns: Any

helm_repo_update_flags

Type: Ruby 3.x API

Transforms a hash into a string of helm repo update flags

helm_repo_update_flags()

Transforms a hash into a string of helm repo update flags

Returns: Any