helm
: A module to install Helm, the Kubernetes package manager.helm::params
: This module installs Helm, the Kubernetes package manager.
helm::account_config
: helm::account_confighelm::binary
: helm::binaryhelm::config
: helm::config
helm::chart
: Manages the deployment of helm charts.helm::chart_update
: Update the deployed Helm charts.helm::create
: Creates a new Helm chart.helm::helm_init
: Deploys the Tiller pod and initializes the Helm client.helm::package
: Packages a chart directory ino a chart archive..helm::repo
: Adds a Helm repository.helm::repo_update
: Updates all of the Helm repositories.
helm_chart_update_flags
: Transforms a hash into a string of helm install chart flagshelm_create_flags
: Transforms a hash into a string of helm create flagshelm_delete_flags
: Transforms a hash into a string of helm delete flagshelm_init_flags
: Transforms a hash into a string of helm init flagshelm_install_flags
: Transforms a hash into a string of helm install chart flagshelm_ls_flags
: Transforms a hash into a string of helm ls flagshelm_package_flags
: Transforms a hash into a string of helm package flagshelm_repo_add_flags
: Transforms a hash into a string of helm repo add flagshelm_repo_remove_flags
: Transforms a hash into a string of helm repo remove flagshelm_repo_update_flags
: Transforms a hash into a string of helm repo update flags
helm::provision_cluster
: Provisions machineshelm::puppetserver_setup
: Provisions machines
A module to install Helm, the Kubernetes package manager.
The following parameters are available in the helm
class:
canary_image
client_only
debug
dry_run
env
home
host
init
install_path
kube_context
local_repo_url
net_host
node_selectors
overrides
path
proxy
service_account
skip_refresh
stable_repo_url
tiller_image
tiller_image_pull_secrets
tiller_namespaces
tiller_tls
tiller_tls_cert
tiller_tls_key
tiller_tls_verify
tls_ca_cert
upgrade
version
archive_baseurl
Data type: Boolean
Use the helm canary image for the default init of helm. Defaults to false
Default value: $helm::params::canary_image
Data type: Boolean
Make the default init install the client only. Defaults to false
Default value: $helm::params::client_only
Data type: Boolean
Set output logging to debug for the default init. Defaults to false
Default value: $helm::params::debug
Data type: Boolean
Make the default init run in dry-run mode. Defaults to false
Default value: $helm::params::dry_run
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
Data type: Optional[String]
Set the HELM_HOME variable for the default init. Defaults to undef
Default value: $helm::params::home
Data type: Optional[String]
Specify the HELM_HOST for the default init. Defaults to undef
Default value: $helm::params::host
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
Data type: String
The path to extract helm binary to. Defaults to '/usr/bin'
Default value: $helm::params::install_path
Data type: Optional[String]
Specify the kube_context for the default init. Defaults to undef
Default value: $helm::params::kube_context
Data type: Optional[String]
Specify the local_repo_url for the default init. Defaults to undef
Default value: $helm::params::local_repo_url
Data type: Optional[Boolean]
Enable net_host mode for the default init. Defaults to false
Default value: $helm::params::net_host
Data type: Optional[String]
Specify node selectors for the helm init on the default init. Defaults to undef
Default value: $helm::params::node_selectors
Data type: Optional[Array]
Specify override parameters for the default init. Defaults to undef
Default value: $helm::params::overrides
Data type: Array
The PATH variable used for exec types. Defaults to ['/bin','/usr/bin']
Default value: $helm::params::path
Data type: Optional[String]
Specify an internet proxy if necessary. Defaults to undef
Default value: $helm::params::proxy
Data type: String
The service account for tiller Defaults to 'tiller'
Default value: $helm::params::service_account
Data type: Boolean
Enable skip refresh mode for the default init. Defaults to false
Default value: $helm::params::skip_refresh
Data type: Optional[String]
Specify the stable repo url for the default init. Defaults to undef
Default value: $helm::params::stable_repo_url
Data type: Optional[String]
Specify the image for the tiller install in the default init. Defaults to undef
Default value: $helm::params::tiller_image
Data type: Optional[Array[String]]
Optionnaly put imagePullSecret(s) in tiller's serviceaccount.
Default value: $helm::params::tiller_image_pull_secrets
Data type: Array[String]
Array of namespaces in which to install tiller Defaults to ['kube-system']
Default value: $helm::params::tiller_namespaces
Data type: Boolean
Enable TLS for tiller in the default init. Defaults to false
Default value: $helm::params::tiller_tls
Data type: Optional[String]
Specify a TLS cert for tiller in the default init. Defaults to undef
Default value: $helm::params::tiller_tls_cert
Data type: Optional[String]
Specify a TLS key for tiller in the default init. Defaults to undef
Default value: $helm::params::tiller_tls_key
Data type: Boolean
Enable TLS verification for tiller in the default init. Defaults to undef
Default value: $helm::params::tiller_tls_verify
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
Data type: Boolean
Whether to upgrade tiller in the default init. Defaults to false
Default value: $helm::params::upgrade
Data type: String
The version of helm to install. Defaults to 2.5.1
Default value: $helm::params::version
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
This module installs Helm, the Kubernetes package manager.
Defined Type helm::chart
The following parameters are available in the helm::chart
defined type:
ensure
ca_file
cert_file
debug
devel
dry_run
env
key_file
key_ring
home
host
kube_context
name_template
no_hooks
path
purge
release_name
replace
repo
set
timeout
- [
tiller_namespace``](#tiller_namespace
) tls
tls_ca_cert
tls_cert
- [
tls_key``](#tls_key
) tls_verify
values
verify
version
wait
chart
namespace
tiller_namespace
tls_key
Data type: String
Specifies whether a chart is deployed.
Default value: present
Data type: Optional[String]
Verifies the certificates of the HTTPS-enabled servers using the CA bundle.
Default value: undef
Data type: Optional[String]
Identifies the HTTPS client using this SSL certificate file.
Default value: undef
Data type: Boolean
Specifies whether to enable verbose output.
Values true
, false
.
Default value: false
Data type: Boolean
Specifies whether to use development versions.
Values true
, false
.
Default value: false
Data type: Boolean
Specifies whether to simulate an installation or delete a deployment.
Values true
, false
.
Default value: false
Data type: Optional[Array]
Sets the environment variables for Helm to connect to the kubernetes cluster.
Default value: undef
Data type: Optional[String]
Identifies the HTTPS client using thie SSL key file.
Default value: undef
Data type: Optional[String]
Location of the public keys that are used for verification.
Default value: undef
Data type: Optional[String]
Location of your Helm config. This value overrides $HELM_HOME
.
Default value: undef
Data type: Optional[String]
Address of Tiller. This value overrides $HELM_HOST
.
Default value: undef
Data type: Optional[String]
Name of the kubeconfig context.
Default value: undef
Data type: Optional[String]
The template used to name the release.
Default value: undef
Data type: Boolean
Specifies whether to prevent hooks running during the installation.
Values true
, false
.
Default value: false
Data type: Optional[Array]
The PATH variable used for exec types.
Default value: undef
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
Data type: Optional[String]
Required. The release name.
Default value: undef
Data type: Boolean
Reuse the release name.
Default value: false
Data type: Optional[String]
The repository URL for a requested chart.
Default value: undef
Data type: Optional[Array]
The set array of values for the helm create
command.
Default value: []
Data type: Optional[Integer]
The timeout in seconds to wait for a Kubernetes operation.
Default value: undef
The Tiller namespace.
Data type: Boolean
Specifies whether to enable TLS.
Values true
, false
.
Default value: false
Data type: Optional[String]
The path to TLS CA certificate file.
Default value: undef
Data type: Optional[String]
The path to TLS certificate file.
Default value: undef
The path to TLS key file.
Data type: Boolean
Enable TLS for request and verify remote.
Default value: false
Data type: Optional[Array]
Specify values from a YAML file. Multiple values in an array are accepted.
Default value: []
Data type: Boolean
Specifies whether to verify the package before installing it.
Values true
, false
.
Default value: false
Data type: Optional[String]
Specify the version of the chart to install. undef
installs the latest version.
Default value: undef
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
Data type: Optional[String]
The file system location of the package.
Default value: undef
Data type: Optional[String]
Default value: undef
Data type: Optional[String]
Default value: 'kube-system'
Data type: Optional[String]
Default value: undef
Defined Type helm::chart::update
The following parameters are available in the helm::chart_update
defined type:
ensure
ca_file
cert_file
debug
devel
dry_run
env
install
key_file
keyring
home
host
kube_context
recreate_pods
reset_values
reuse_values
no_hooks#
path
purge
release_name
repo
set
timeout
tiller_namespace
tls
tls_ca_cert
tls_cert
tls_key
tls_verify
values
verify
version
wait
chart
namespace
no_hooks
Data type: String
Specifies whether a chart must be updated. Valid values are 'present', 'absent'.
Default value: present
Data type: Optional[String]
Verifies the certificates of the HTTPS-enabled servers using the CA bundle.
Default value: undef
Data type: Optional[String]
Identifies the HTTPS client using this SSL certificate file.
Default value: undef
Data type: Boolean
Specifies whether to enable verbose output.
Values true
, false
.
Default value: false
Data type: Boolean
Specifies whether to use development versions.
Values true
, false
.
Default value: false
Data type: Boolean
Specifies whether to simulate a chart update.
Values true
, false
.
Default value: false
Data type: Optional[Array]
Sets the environment variables for Helm to connect to the kubernetes cluster.
Default value: undef
Data type: Boolean
If a release by this name doesn't already exist, run an install
Default value: true
Data type: Optional[String]
Identifies the HTTPS client using the SSL key file.
Default value: undef
Data type: Optional[String]
Location of the public keys that are used for verification.
Default value: undef
Data type: Optional[String]
Location of your Helm config. This value overrides $HELM_HOME
.
Default value: undef
Data type: Optional[String]
Address of Tiller. This value overrides $HELM_HOST
.
Default value: undef
Data type: Optional[String]
Name of the kubeconfig context.
Default value: undef
Data type: Optional[String]
Performs pods restart for the resource if applicable
Default value: undef
Data type: Optional[String]
When upgrading, reset the values to the ones built into the chart
Default value: undef
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
@param
Specifies whether to prevent hooks running during the installation.
Values true
, false
.
Data type: Array
The PATH variable used for exec types.
Default value: undef
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
Data type: Optional[String]
Required. The release name.
Default value: undef
Data type: Optional[String]
The repository URL for a requested chart.
Default value: undef
Data type: Optional[Array]
The set array of values for the helm create
command.
Default value: []
Data type: Optional[Integer]
The timeout in seconds to wait for a Kubernetes operation.
Default value: undef
Data type: String
The Tiller namespace.
Default value: 'kube-system'
Data type: Boolean
Specifies whether to enable TLS.
Values true
, false
.
Default value: false
Data type: Optional[String]
The path to TLS CA certificate file.
Default value: undef
Data type: Optional[String]
The path to TLS certificate file.
Default value: undef
Data type: Optional[String]
The path to TLS key file.
Default value: undef
Data type: Boolean
Enable TLS for request and verify remote.
Default value: false
Data type: Optional[Array]
Specify values from a YAML file. Multiple values in an array are accepted.
Default value: []
Data type: Boolean
Specifies whether to verify the package before installing it.
Values true
, false
.
Default value: false
Data type: Optional[String]
Specify the version of the chart to install. undef
installs the latest version.
Default value: undef
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
Data type: Optional[String]
The file system location of the package.
Default value: undef
Data type: Optional[String]
Default value: undef
Data type: Boolean
Default value: false
Defined Type helm::chart::create
The following parameters are available in the helm::create
defined type:
Data type: Optional[String]
The name of the Helm chart.
Defaults to undef
.
Default value: undef
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
Data type: Boolean
Specifies whether to enable verbose output.
Values true
, false
.
Default value: false
Data type: Optional[Array]
Sets the environment variables for Helm to connect to the Kubernetes cluster.
Default value: undef
Data type: Optional[String]
The location of your Helm configuration. This value overrides $HELM_HOME
.
Default value: undef
Data type: Optional[String]
Address of Tiller. This value overrides $HELM_HOST
.
Default value: undef
Data type: Optional[String]
The name of the kubeconfig context.
Default value: undef
Data type: Optional[Array]
The PATH variable used for exec types.
Default value: undef
Data type: Optional[String]
Value for the starter chart.
Default value: undef
Data type: Optional[String]
Namespace of Tiller.
Default value: undef
Defined Type helm::helm_init
The following parameters are available in the helm::helm_init
defined type:
init
canary_image
client_only
debug
dry_run
env
home
host
kube_context
local_repo_url
net_host
path
service_account
skip_refresh
stable_repo_url
tiller_image
tiller_namespace
tiller_tls
tiller_tls_cert
tiller_tls_key
tiller_tls_verify
tls_ca_cert
upgrade
overrides
node_selectors
Data type: Boolean
Specifies whether to deploy the tiller pod and initialise the Helm client.
Valid values are true
, false
.
Default value: true
Data type: Boolean
Specifies whether to use the canary Tiller image.
Valid values are true
, false
.
Default value: false
Data type: Boolean
Specifies whether to deploy Tiller.
Valid values are true
, false
.
Default value: false
Data type: Boolean
Specifies whether to enable the verbose output.
Values true
, false
.
Default value: false
Data type: Boolean
Specifies whether to simulate an installation or delete of a deployment.
Values true
, false
.
Default value: false
Data type: Optional[Array]
Sets the environment variables required for Helm to connect to the kubernetes cluster.
Default value: undef
Data type: Optional[String]
The location for your Helm configuration. This value overrides $HELM_HOME
.
Default value: undef
Data type: Optional[String]
The host address for Tiller. Overrides $HELM_HOST
.
Default value: undef
Data type: Optional[String]
The name for the kubeconfig context to use.
Default value: undef
Data type: Optional[String]
The local repository URL.
Default value: undef
Data type: Boolean
Specifies whether to install Tiller with net=host
.
Valid values are true
, false
.
Default value: false
Data type: Optional[Array]
The PATH variable used for exec types.
Default value: undef
Data type: Optional[String]
The name for the service account used for deploying Tiller.
Default value: undef
Data type: Boolean
Specifies whether to refresh or download the local repository cache.
Valid values are true
, false
.
Default value: false
Data type: Optional[String]
The stable repository URL.
Default value: undef
Data type: Optional[String]
Override the Tiller image.
Default value: undef
Data type: String
Namespace for Tiller.
Default value: 'kube-system'
Data type: Boolean
Specifies whether to install Tiller with TLS enabled.
Valid values are true
, false
.
Default value: false
Data type: Optional[String]
The path to the TLS certificate file that is installed with Tiller.
Default value: undef
Data type: Optional[String]
The path to the TLS key file that is installed with Tiller.
Default value: undef
Data type: Boolean
Specifies whether to install Tiller with TLS enabled and to verify remote certificates.
Valid values are true
, false
.
Default value: false
Data type: Optional[String]
Specifies whether to use the path to the CA root certificate.
Valid values are true
, false
.
Default value: undef
Data type: Boolean
Specifies whether to upgrade if Tiller is installed.
Valid values are true
, false
.
Default value: false
Data type: Optional[Array]
Default value: undef
Data type: Optional[String]
Default value: undef
Defined Type helm::package
The following parameters are available in the helm::package
defined type:
chart_name
chart_path
debug
home
host
kube_context
save
sign
tiller_namespace
version
dependency_update
destination
env
key
keystring
host
path
Data type: Optional[String]
Defaults to undef
.
The name of the Helm chart.
Default value: undef
Data type: Optional[String]
The file system location of the chart.
Default value: undef
Data type: Boolean
Specifies whether to enable verbose output.
Values true
, false
.
Defaults to false
.
Default value: false
Data type: Optional[String]
Location of your Helm config. This value overrides $HELM_HOME
.
Defaults to undef
.
Default value: undef
The address for Tiller. This value overrides $HELM_HOST
.
Defaults to undef
.
Data type: Optional[String]
The name for the kubeconfig context.
Defaults to undef
.
Default value: undef
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
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
Data type: Optional[String]
The namespace for Tiller.
Defaults to undef
.
Default value: undef
Data type: Optional[String]
The version of the chart.
Defaults to undef
.
Default value: undef
Data type: Boolean
Specifies whether to update dependencies.
Valid values are true
, false
.
Defaults to false
.
Default value: false
Data type: Optional[String]
The destination location to write to.
Defaults to undef
.
Default value: undef
Data type: Optional[Array]
Sets the environment variables required for Helm to connect to the kubernetes cluster.
Defaults to undef
.
Default value: undef
Data type: Optional[String]
Specify the key to use.
Defaults to undef
.
Default value: undef
Data type: Optional[String]
The location of the public keys that are used for verification.
Defaults to undef
.
Default value: undef
Data type: Optional[String]
Default value: undef
Data type: Optional[Array]
Default value: undef
Defined Type helm::repo
The following parameters are available in the helm::repo
defined type:
ensure
ca_file
cert_file
debug
env
key_file
no_update
home
host
kube_context
path
tiller_namespace
username
password
repo_name
url
Data type: String
Specifies whether a repo is added. Valid values are 'present', 'absent'.
Default value: present
Data type: Optional[String]
Verify the certificates of HTTPS-enabled servers that are using the current CA bundle.
Default value: undef
Data type: Optional[String]
Use the SSL certificate file to identify the HTTPS client.
Default value: undef
Data type: Boolean
Specifies whether to enable verbose output. Values true, false.
Default value: false
Data type: Optional[Array]
Sets the environment variables required for Helm to connect to the kubernetes cluster.
Default value: undef
Data type: Optional[String]
Use the SSL key file to identify the HTTPS client.
Default value: undef
Data type: Boolean
Specifies whether to create an error when the repository is already registered. Values true, false.
Default value: false
Data type: Optional[String]
Location of your Helm config. This value overrrides $HELM_HOME.
Default value: undef
Data type: Optional[String]
The address for Tiller. This value overrides $HELM_HOST.
Default value: undef
Data type: Optional[String]
The name for the kubeconfig context to use.
Default value: undef
Data type: Optional[Array]
The PATH variable used for exec types.
Default value: undef
Data type: Optional[String]
The namespace for Tiller.
Default value: undef
Data type: Optional[String]
The username for the remote repository
Default value: undef
Data type: Optional[String]
The password for the remote repository.
Default value: undef
Data type: Optional[String]
The name for the remote repository.
Default value: undef
Data type: Optional[String]
The URL for the remote repository.
Default value: undef
Defined Type helm::repo_update
The following parameters are available in the helm::repo_update
defined type:
Data type: Boolean
Specifies whether to enable verbose output. Values true, false.
Default value: false
Data type: Optional[Array]
Sets the environment variables required for Helm to connect to the Kubernetes cluster.
Default value: undef
Data type: Optional[String]
The location of your Helm config. This value overrides $HELM_HOME.
Default value: undef
Data type: Optional[String]
The address for Tiller. This value overrides $HELM_HOST.
Default value: undef
Data type: Optional[String]
The name for the kubeconfig context to use.
Default value: undef
Data type: Optional[Array]
The PATH variable used for exec types.
Default value: undef
Data type: Optional[String]
The namespace for Tiller.
Default value: undef
Data type: Boolean
Specifies whether the repository is updated. Values true, false.
Default value: true
Type: Ruby 3.x API
Transforms a hash into a string of helm install chart flags
Transforms a hash into a string of helm install chart flags
Returns: Any
Type: Ruby 3.x API
Transforms a hash into a string of helm create flags
Transforms a hash into a string of helm create flags
Returns: Any
Type: Ruby 3.x API
Transforms a hash into a string of helm delete flags
Transforms a hash into a string of helm delete flags
Returns: Any
Type: Ruby 3.x API
Transforms a hash into a string of helm init flags
Transforms a hash into a string of helm init flags
Returns: Any
Type: Ruby 3.x API
Transforms a hash into a string of helm install chart flags
Transforms a hash into a string of helm install chart flags
Returns: Any
Type: Ruby 3.x API
Transforms a hash into a string of helm ls flags
Transforms a hash into a string of helm ls flags
Returns: Any
Type: Ruby 3.x API
Transforms a hash into a string of helm package flags
Transforms a hash into a string of helm package flags
Returns: Any
Type: Ruby 3.x API
Transforms a hash into a string of helm repo add flags
Transforms a hash into a string of helm repo add flags
Returns: Any
Type: Ruby 3.x API
Transforms a hash into a string of helm repo remove flags
Transforms a hash into a string of helm repo remove flags
Returns: Any
Type: Ruby 3.x API
Transforms a hash into a string of helm repo update flags
Transforms a hash into a string of helm repo update flags
Returns: Any
Provisions machines for integration testing
helm::provision_cluster
The following parameters are available in the helm::provision_cluster
plan:
Data type: Optional[String]
Default value: 'centos-7'
Data type: Optional[String]
Default value: 'provision_service'
Puppet Server Setup
helm::puppetserver_setup
The following parameters are available in the helm::puppetserver_setup
plan:
Data type: Optional[String]
Default value: 'puppet7-nightly'