Skip to content

Latest commit

 

History

History
1975 lines (1115 loc) · 39.6 KB

REFERENCE.md

File metadata and controls

1975 lines (1115 loc) · 39.6 KB

Reference

Table of Contents

Classes

Public Classes

  • helm: A module to install Helm, the Kubernetes package manager.
  • helm::params: This module installs Helm, the Kubernetes package manager.

Private Classes

  • helm::account_config: helm::account_config
  • helm::binary: helm::binary
  • helm::config: helm::config

Defined types

Functions

Plans

Classes

helm

A module to install Helm, the Kubernetes package manager.

Parameters

The following parameters are available in the helm class:

canary_image

Data type: Boolean

Use the helm canary image for the default init of helm. Defaults to false

Default value: $helm::params::canary_image

client_only

Data type: Boolean

Make the default init install the client only. Defaults to false

Default value: $helm::params::client_only

debug

Data type: Boolean

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

Default value: $helm::params::debug

dry_run

Data type: Boolean

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

Default value: $helm::params::dry_run

env

Data type: Array

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']

Default value: $helm::params::env

home

Data type: Optional[String]

Set the HELM_HOME variable for the default init. Defaults to undef

Default value: $helm::params::home

host

Data type: Optional[String]

Specify the HELM_HOST for the default init. Defaults to undef

Default value: $helm::params::host

init

Data type: Boolean

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

Default value: $helm::params::init

install_path

Data type: String

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

Default value: $helm::params::install_path

kube_context

Data type: Optional[String]

Specify the kube_context for the default init. Defaults to undef

Default value: $helm::params::kube_context

local_repo_url

Data type: Optional[String]

Specify the local_repo_url for the default init. Defaults to undef

Default value: $helm::params::local_repo_url

net_host

Data type: Optional[Boolean]

Enable net_host mode for the default init. Defaults to false

Default value: $helm::params::net_host

node_selectors

Data type: Optional[String]

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

Default value: $helm::params::node_selectors

overrides

Data type: Optional[Array]

Specify override parameters for the default init. Defaults to undef

Default value: $helm::params::overrides

path

Data type: Array

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

Default value: $helm::params::path

proxy

Data type: Optional[String]

Specify an internet proxy if necessary. Defaults to undef

Default value: $helm::params::proxy

service_account

Data type: String

The service account for tiller Defaults to 'tiller'

Default value: $helm::params::service_account

skip_refresh

Data type: Boolean

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

Default value: $helm::params::skip_refresh

stable_repo_url

Data type: Optional[String]

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

Default value: $helm::params::stable_repo_url

tiller_image

Data type: Optional[String]

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

Default value: $helm::params::tiller_image

tiller_image_pull_secrets

Data type: Optional[Array[String]]

Optionnaly put imagePullSecret(s) in tiller's serviceaccount.

Default value: $helm::params::tiller_image_pull_secrets

tiller_namespaces

Data type: Array[String]

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

Default value: $helm::params::tiller_namespaces

tiller_tls

Data type: Boolean

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

Default value: $helm::params::tiller_tls

tiller_tls_cert

Data type: Optional[String]

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

Default value: $helm::params::tiller_tls_cert

tiller_tls_key

Data type: Optional[String]

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

Default value: $helm::params::tiller_tls_key

tiller_tls_verify

Data type: Boolean

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

Default value: $helm::params::tiller_tls_verify

tls_ca_cert

Data type: Optional[String]

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

Default value: $helm::params::tls_ca_cert

upgrade

Data type: Boolean

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

Default value: $helm::params::upgrade

version

Data type: String

The version of helm to install. Defaults to 2.5.1

Default value: $helm::params::version

archive_baseurl

Data type: String

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

Default value: $helm::params::archive_baseurl

helm::params

This module installs Helm, the Kubernetes package manager.

Defined types

helm::chart

Defined Type helm::chart

Parameters

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

ensure

Data type: String

Specifies whether a chart is deployed.

Default value: present

ca_file

Data type: Optional[String]

Verifies the certificates of the HTTPS-enabled servers using the CA bundle.

Default value: undef

cert_file

Data type: Optional[String]

Identifies the HTTPS client using this SSL certificate file.

Default value: undef

debug

Data type: Boolean

Specifies whether to enable verbose output. Values true, false.

Default value: false

devel

Data type: Boolean

Specifies whether to use development versions. Values true, false.

Default value: false

dry_run

Data type: Boolean

Specifies whether to simulate an installation or delete a deployment. Values true, false.

Default value: false

env

Data type: Optional[Array]

Sets the environment variables for Helm to connect to the kubernetes cluster.

Default value: undef

key_file

Data type: Optional[String]

Identifies the HTTPS client using thie SSL key file.

Default value: undef

key_ring

Data type: Optional[String]

Location of the public keys that are used for verification.

Default value: undef

home

Data type: Optional[String]

Location of your Helm config. This value overrides $HELM_HOME.

Default value: undef

host

Data type: Optional[String]

Address of Tiller. This value overrides $HELM_HOST.

Default value: undef

kube_context

Data type: Optional[String]

Name of the kubeconfig context.

Default value: undef

name_template

Data type: Optional[String]

The template used to name the release.

Default value: undef

no_hooks

Data type: Boolean

Specifies whether to prevent hooks running during the installation. Values true, false.

Default value: false

path

Data type: Optional[Array]

The PATH variable used for exec types.

Default value: undef

purge

Data type: Boolean

Specifies whether to remove the release from the store, and make its name available for later use. Values true, false.

Default value: true

release_name

Data type: Optional[String]

Required. The release name.

Default value: undef

replace

Data type: Boolean

Reuse the release name.

Default value: false

repo

Data type: Optional[String]

The repository URL for a requested chart.

Default value: undef

set

Data type: Optional[Array]

The set array of values for the helm create command.

Default value: []

timeout

Data type: Optional[Integer]

The timeout in seconds to wait for a Kubernetes operation.

Default value: undef

`tiller_namespace``

The Tiller namespace.

tls

Data type: Boolean

Specifies whether to enable TLS. Values true, false.

Default value: false

tls_ca_cert

Data type: Optional[String]

The path to TLS CA certificate file.

Default value: undef

tls_cert

Data type: Optional[String]

The path to TLS certificate file.

Default value: undef

`tls_key``

The path to TLS key file.

tls_verify

Data type: Boolean

Enable TLS for request and verify remote.

Default value: false

values

Data type: Optional[Array]

Specify values from a YAML file. Multiple values in an array are accepted.

Default value: []

verify

Data type: Boolean

Specifies whether to verify the package before installing it. Values true, false.

Default value: false

version

Data type: Optional[String]

Specify the version of the chart to install. undef installs the latest version.

Default value: undef

wait

Data type: Boolean

Before marking the release as successful, specify whether to wait until all the pods, PVCs, services, and the minimum number of deployment pods are in a ready state. The timeout value determines the duration. Values true, false.

Default value: false

chart

Data type: Optional[String]

The file system location of the package.

Default value: undef

namespace

Data type: Optional[String]

Default value: undef

tiller_namespace

Data type: Optional[String]

Default value: 'kube-system'

tls_key

Data type: Optional[String]

Default value: undef

helm::chart_update

Defined Type helm::chart::update

Parameters

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

ensure

Data type: String

Specifies whether a chart must be updated. Valid values are 'present', 'absent'.

Default value: present

ca_file

Data type: Optional[String]

Verifies the certificates of the HTTPS-enabled servers using the CA bundle.

Default value: undef

cert_file

Data type: Optional[String]

Identifies the HTTPS client using this SSL certificate file.

Default value: undef

debug

Data type: Boolean

Specifies whether to enable verbose output. Values true, false.

Default value: false

devel

Data type: Boolean

Specifies whether to use development versions. Values true, false.

Default value: false

dry_run

Data type: Boolean

Specifies whether to simulate a chart update. Values true, false.

Default value: false

env

Data type: Optional[Array]

Sets the environment variables for Helm to connect to the kubernetes cluster.

Default value: undef

install

Data type: Boolean

If a release by this name doesn't already exist, run an install

Default value: true

key_file

Data type: Optional[String]

Identifies the HTTPS client using the SSL key file.

Default value: undef

keyring

Data type: Optional[String]

Location of the public keys that are used for verification.

Default value: undef

home

Data type: Optional[String]

Location of your Helm config. This value overrides $HELM_HOME.

Default value: undef

host

Data type: Optional[String]

Address of Tiller. This value overrides $HELM_HOST.

Default value: undef

kube_context

Data type: Optional[String]

Name of the kubeconfig context.

Default value: undef

recreate_pods

Data type: Optional[String]

Performs pods restart for the resource if applicable

Default value: undef

reset_values

Data type: Optional[String]

When upgrading, reset the values to the ones built into the chart

Default value: undef

reuse_values

Data type: Optional[String]

when upgrading, reuse the last release's values, and merge in any new values. If '--reset-values' is specified, this is ignored.

Default value: undef

no_hooks#

@param Specifies whether to prevent hooks running during the installation. Values true, false.

path

Data type: Array

The PATH variable used for exec types.

Default value: undef

purge

Data type: Boolean

Specifies whether to remove the release from the store, and make its name available for later use. Values true, false.

Default value: true

release_name

Data type: Optional[String]

Required. The release name.

Default value: undef

repo

Data type: Optional[String]

The repository URL for a requested chart.

Default value: undef

set

Data type: Optional[Array]

The set array of values for the helm create command.

Default value: []

timeout

Data type: Optional[Integer]

The timeout in seconds to wait for a Kubernetes operation.

Default value: undef

tiller_namespace

Data type: String

The Tiller namespace.

Default value: 'kube-system'

tls

Data type: Boolean

Specifies whether to enable TLS. Values true, false.

Default value: false

tls_ca_cert

Data type: Optional[String]

The path to TLS CA certificate file.

Default value: undef

tls_cert

Data type: Optional[String]

The path to TLS certificate file.

Default value: undef

tls_key

Data type: Optional[String]

The path to TLS key file.

Default value: undef

tls_verify

Data type: Boolean

Enable TLS for request and verify remote.

Default value: false

values

Data type: Optional[Array]

Specify values from a YAML file. Multiple values in an array are accepted.

Default value: []

verify

Data type: Boolean

Specifies whether to verify the package before installing it. Values true, false.

Default value: false

version

Data type: Optional[String]

Specify the version of the chart to install. undef installs the latest version.

Default value: undef

wait

Data type: Boolean

Before marking the release as successful, specify whether to wait until all the pods, PVCs, services, and the minimum number of deployment pods are in a ready state. The timeout value determines the duration. Values true, false.

Default value: false

chart

Data type: Optional[String]

The file system location of the package.

Default value: undef

namespace

Data type: Optional[String]

Default value: undef

no_hooks

Data type: Boolean

Default value: false

helm::create

Defined Type helm::chart::create

Parameters

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

chart_name

Data type: Optional[String]

The name of the Helm chart. Defaults to undef.

Default value: undef

chart_path

Data type: Optional[String]

The location of the Helm chart. If the directory in the path does not exist, Helm attempts to create it. If the directory and the files already exist, only the conflicting files are overwritten.

Default value: undef

debug

Data type: Boolean

Specifies whether to enable verbose output. Values true, false.

Default value: false

env

Data type: Optional[Array]

Sets the environment variables for Helm to connect to the Kubernetes cluster.

Default value: undef

home

Data type: Optional[String]

The location of your Helm configuration. This value overrides $HELM_HOME.

Default value: undef

host

Data type: Optional[String]

Address of Tiller. This value overrides $HELM_HOST.

Default value: undef

kube_context

Data type: Optional[String]

The name of the kubeconfig context.

Default value: undef

path

Data type: Optional[Array]

The PATH variable used for exec types.

Default value: undef

starter

Data type: Optional[String]

Value for the starter chart.

Default value: undef

tiller_namespace

Data type: Optional[String]

Namespace of Tiller.

Default value: undef

helm::helm_init

Defined Type helm::helm_init

Parameters

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

init

Data type: Boolean

Specifies whether to deploy the tiller pod and initialise the Helm client. Valid values are true, false.

Default value: true

canary_image

Data type: Boolean

Specifies whether to use the canary Tiller image. Valid values are true, false.

Default value: false

client_only

Data type: Boolean

Specifies whether to deploy Tiller. Valid values are true, false.

Default value: false

debug

Data type: Boolean

Specifies whether to enable the verbose output. Values true, false.

Default value: false

dry_run

Data type: Boolean

Specifies whether to simulate an installation or delete of a deployment. Values true, false.

Default value: false

env

Data type: Optional[Array]

Sets the environment variables required for Helm to connect to the kubernetes cluster.

Default value: undef

home

Data type: Optional[String]

The location for your Helm configuration. This value overrides $HELM_HOME.

Default value: undef

host

Data type: Optional[String]

The host address for Tiller. Overrides $HELM_HOST.

Default value: undef

kube_context

Data type: Optional[String]

The name for the kubeconfig context to use.

Default value: undef

local_repo_url

Data type: Optional[String]

The local repository URL.

Default value: undef

net_host

Data type: Boolean

Specifies whether to install Tiller with net=host. Valid values are true, false.

Default value: false

path

Data type: Optional[Array]

The PATH variable used for exec types.

Default value: undef

service_account

Data type: Optional[String]

The name for the service account used for deploying Tiller.

Default value: undef

skip_refresh

Data type: Boolean

Specifies whether to refresh or download the local repository cache. Valid values are true, false.

Default value: false

stable_repo_url

Data type: Optional[String]

The stable repository URL.

Default value: undef

tiller_image

Data type: Optional[String]

Override the Tiller image.

Default value: undef

tiller_namespace

Data type: String

Namespace for Tiller.

Default value: 'kube-system'

tiller_tls

Data type: Boolean

Specifies whether to install Tiller with TLS enabled. Valid values are true, false.

Default value: false

tiller_tls_cert

Data type: Optional[String]

The path to the TLS certificate file that is installed with Tiller.

Default value: undef

tiller_tls_key

Data type: Optional[String]

The path to the TLS key file that is installed with Tiller.

Default value: undef

tiller_tls_verify

Data type: Boolean

Specifies whether to install Tiller with TLS enabled and to verify remote certificates. Valid values are true, false.

Default value: false

tls_ca_cert

Data type: Optional[String]

Specifies whether to use the path to the CA root certificate. Valid values are true, false.

Default value: undef

upgrade

Data type: Boolean

Specifies whether to upgrade if Tiller is installed. Valid values are true, false.

Default value: false

overrides

Data type: Optional[Array]

Default value: undef

node_selectors

Data type: Optional[String]

Default value: undef

helm::package

Defined Type helm::package

Parameters

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

chart_name

Data type: Optional[String]

Defaults to undef. The name of the Helm chart.

Default value: undef

chart_path

Data type: Optional[String]

The file system location of the chart.

Default value: undef

debug

Data type: Boolean

Specifies whether to enable verbose output. Values true, false. Defaults to false.

Default value: false

home

Data type: Optional[String]

Location of your Helm config. This value overrides $HELM_HOME. Defaults to undef.

Default value: undef

host

The address for Tiller. This value overrides $HELM_HOST. Defaults to undef.

kube_context

Data type: Optional[String]

The name for the kubeconfig context. Defaults to undef.

Default value: undef

save

Data type: Boolean

Specifies whether to save the packaged chart to the local chart repository. Valid values are true, false. Defaults to true.

Default value: true

sign

Data type: Boolean

Specifies whether to use a PGP private key to sign the package. Valid values are true, false. Defaults to false.

Default value: false

tiller_namespace

Data type: Optional[String]

The namespace for Tiller. Defaults to undef.

Default value: undef

version

Data type: Optional[String]

The version of the chart. Defaults to undef.

Default value: undef

dependency_update

Data type: Boolean

Specifies whether to update dependencies. Valid values are true, false. Defaults to false.

Default value: false

destination

Data type: Optional[String]

The destination location to write to. Defaults to undef.

Default value: undef

env

Data type: Optional[Array]

Sets the environment variables required for Helm to connect to the kubernetes cluster. Defaults to undef.

Default value: undef

key

Data type: Optional[String]

Specify the key to use. Defaults to undef.

Default value: undef

keystring

Data type: Optional[String]

The location of the public keys that are used for verification. Defaults to undef.

Default value: undef

host

Data type: Optional[String]

Default value: undef

path

Data type: Optional[Array]

Default value: undef

helm::repo

Defined Type helm::repo

Parameters

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

ensure

Data type: String

Specifies whether a repo is added. Valid values are 'present', 'absent'.

Default value: present

ca_file

Data type: Optional[String]

Verify the certificates of HTTPS-enabled servers that are using the current CA bundle.

Default value: undef

cert_file

Data type: Optional[String]

Use the SSL certificate file to identify the HTTPS client.

Default value: undef

debug

Data type: Boolean

Specifies whether to enable verbose output. Values true, false.

Default value: false

env

Data type: Optional[Array]

Sets the environment variables required for Helm to connect to the kubernetes cluster.

Default value: undef

key_file

Data type: Optional[String]

Use the SSL key file to identify the HTTPS client.

Default value: undef

no_update

Data type: Boolean

Specifies whether to create an error when the repository is already registered. Values true, false.

Default value: false

home

Data type: Optional[String]

Location of your Helm config. This value overrrides $HELM_HOME.

Default value: undef

host

Data type: Optional[String]

The address for Tiller. This value overrides $HELM_HOST.

Default value: undef

kube_context

Data type: Optional[String]

The name for the kubeconfig context to use.

Default value: undef

path

Data type: Optional[Array]

The PATH variable used for exec types.

Default value: undef

tiller_namespace

Data type: Optional[String]

The namespace for Tiller.

Default value: undef

username

Data type: Optional[String]

The username for the remote repository

Default value: undef

password

Data type: Optional[String]

The password for the remote repository.

Default value: undef

repo_name

Data type: Optional[String]

The name for the remote repository.

Default value: undef

url

Data type: Optional[String]

The URL for the remote repository.

Default value: undef

helm::repo_update

Defined Type helm::repo_update

Parameters

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

debug

Data type: Boolean

Specifies whether to enable verbose output. Values true, false.

Default value: false

env

Data type: Optional[Array]

Sets the environment variables required for Helm to connect to the Kubernetes cluster.

Default value: undef

home

Data type: Optional[String]

The location of your Helm config. This value overrides $HELM_HOME.

Default value: undef

host

Data type: Optional[String]

The address for Tiller. This value overrides $HELM_HOST.

Default value: undef

kube_context

Data type: Optional[String]

The name for the kubeconfig context to use.

Default value: undef

path

Data type: Optional[Array]

The PATH variable used for exec types.

Default value: undef

tiller_namespace

Data type: Optional[String]

The namespace for Tiller.

Default value: undef

update

Data type: Boolean

Specifies whether the repository is updated. Values true, false.

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

Plans

helm::provision_cluster

Provisions machines for integration testing

Examples

helm::provision_cluster

Parameters

The following parameters are available in the helm::provision_cluster plan:

image_type

Data type: Optional[String]

Default value: 'centos-7'

provision_type

Data type: Optional[String]

Default value: 'provision_service'

helm::puppetserver_setup

Puppet Server Setup

Examples

helm::puppetserver_setup

Parameters

The following parameters are available in the helm::puppetserver_setup plan:

collection

Data type: Optional[String]

Default value: 'puppet7-nightly'