Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.2.1 < 5.0.0
- RedHat,CentOS,Ubuntu
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-helm', '0.1.2'Learn more about managing modules with a PuppetfileDocumentation
helm
Table of Contents
- Description
- Setup - The basics of getting started with helm
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
The Helm package manager installs and manages Kubernetes applications.
Description
This module installs the the Helm package manager, which consists of the Helm client (Helm) and the Helm server (Tiller), and it also manages the Helm deployments.
Setup
Before installing the helm module, create a Kubernetes service account and install a Kubernetes cluster, including kubectl. For more information about Kubernetes and kubectl, see the Kubernetes docs.
To install the helm module, include the helm class:
include 'helm'
Usage
To customise options, such as the version, the service account, or the Tiller namespace, add the following code to the manifest file:
class { 'helm':
version => '2.6.0',
service_account => 'my_account',
tiller_namespace => 'my_namespace',
}
A Helm chart is a collection of files that describe a related set of Kubernetes resources. To create a Helm chart, add the following code to the manifest file:
helm::create { 'myapp':
env => $env,
chart_path => '/tmp',
chart_name => 'myapp',
path => $path,
}
To package a Helm chart, add the following code to the manifest file:
helm::package { 'myapp':
chart_path => '/tmp',
chart_name => 'myapp',
destination => '/root',
env => $env,
path => $path,
version => '0.1.0',
}
To deploy a Helm chart, add the following code to the manifest file:
helm::chart { 'mysql':
ensure => present,
chart => 'stable/mysql',
env => $env,
path => $path,
release_name => 'mysql',
}
To add a Helm chart repository, add the following code to the manifest file:
helm::repo { 'myrepo':
ensure => present,
env => $env,
path => $path,
repo_name => 'myrepo',
url => 'http://myserver/charts'
}
To update a Helm chart repository, add the following code to the manifest file:
helm::repo_update { 'update':
env => $env,
path => $path,
update => true
}
Reference
Classes
Public Classes
Private Classes
helm::account_config: Configures the service account and the cluster role that are required to deploy Helm.helm::binary: Downloads and extracts the Helm binary.helm::config: Calls thehelm::helm_initdefine to deploy Tiller to the Kubernetes cluster.
Defined Types
helm::create: Creates a new Helm chart.helm::chart: Manages the deployment of the Helm charts.helm::helm_init: Deploys the Tiller pod and initializes the Helm client.helm::package: Packages a chart directory into a chart archive.helm::repo: Adds a Helm repository.helm::repo_update: Updates all of the Helm repositories.
Class: helm
Manages the basic Helm installation and setup.
When the helm class is declared, Puppet does the following:
- Downloads and installs Helm onto your system.
- Creates the cluster role and service accounts required to run tiller.
- Deploys Tiller in the
kube-systemnamespace.
Parameters
env: Sets the environment variables for Helm to connect to the Kubernetes cluster. Default:[ 'HOME=/root', 'KUBECONFIG=/root/admin.conf']init: Specifies whether to initialize the Helm installation and deploy the Tiller pod to Kubernetes. Valid options:'true', 'false'. Default:true.install_path: Sets the path variable for the exec types. Default:'/usr/bin'.service_account: The service account name assigned to thetillerdeployment. Default:tiller.tiller_namespace: The namespace of where tiller is deployed to. Default:kube-system.version: The version of Helm to install. Default:2.5.1.
Defined type: helm::create
Creates a new Helm chart.
chart_name
The name of the Helm chart.
Default: undef.
chart_path
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: undef.
debug
Specifies whether to enable verbose output.
Values 'true','false'.
Default: false.
env
Sets the environment variables for Helm to connect to the Kubernetes cluster.
Default: undef.
home
The location of your Helm configuration. This value overrides $HELM_HOME.
Default: undef.
host
Address of Tiller. This value overrides $HELM_HOST.
Default: undef.
kube_context
The name of the kubeconfig context.
Default: undef.
path
The PATH environment variable.
Default: undef.
tiller_namespace
Namespace of Tiller.
Default: kube-system.
starter
Value for the starter chart.
Default: undef.
helm::chart
Manages the deployment of the Helm charts.
ensure
Specifies whether a chart is deployed.
Values: 'present','absent'.
Default: present.
ca_file
Verifies the certificates of the HTTPS-enabled servers using the CA bundle.
Default: undef.
cert_file
Identifies the HTTPS client using this SSL certificate file.
Default: undef.
debug
Specifies whether to enable verbose output.
Values 'true','false'.
Default: false.
devel
Specifies whether to use development versions.
Values 'true','false'.
Default: false.
dry_run
Specifies whether to simulate an installation or delete a deployment.
Values 'true','false'.
Default: false.
env
Sets the environment variables for Helm to connect to the kubernetes cluster.
Default: undef.
key_file
Identifies the HTTPS client using thie SSL key file.
Default: undef.
key_ring
Location of the public keys that are used for verification.
Default: undef.
home
Location of your Helm config. This value overrides $HELM_HOME.
Default: undef.
host
Address of Tiller. This value overrides $HELM_HOST.
Default: undef.
kube_context
Name of the kubeconfig context.
Default: undef.
name_template
The template used to name the release.
Default: undef.
no_hooks
Specifies whether to prevent hooks running during the installation.
Values 'true','false'.
Default: false.
path
Value for the PATH environment variable.
Default: undef.
purge
Specifies whether to remove the release from the store, and make its name available for later use.
Values 'true','false'.
Default: true.
release_name
Required. The release name.
Default: undef.
replace
Reuse the release name.
Default: false.
repo
The repository URL for a requested chart.
Default: undef.
set
The set array of values for the helm create command.
Default: [].
timeout
The timeout in seconds to wait for a Kubernetes operation.
Default: undef.
tiller_namespace
The Tiller namespace.
Default: kube-system.
tls
Specifies whether to enable TLS.
Values 'true','false'.
Default: false.
tls_ca_cert
The path to TLS CA certificate file.
Default: undef.
tls_cert
The path to TLS certificate file.
Default: undef.
tls_key
The path to TLS key file.
Default: undef.
tls_verify
Enable TLS for request and verify remote.
Default: undef.
values
Specify values from a YAML file. Multiple values in an array are accepted.
Default: [].
verify
Specifies whether to verify the package before installing it.
Values 'true','false'.
Default: false.
version
Specify the version of the chart to install. undef installs the latest version.
Default: undef.
wait
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: false.
chart
The file system location of the package.
Default: undef.
Defined type: helm::helm_init
Deploys the Tiller pod and initialize the Helm client.
init
Specifies whether to deploy the tiller pod and initialise the Helm client.
Values: 'true','false'.
Default: true.
canary_image
Specifies whether to use the canary Tiller image.
Values: 'true','false'.
Default: false.
client_only
Specifies whether to deploy Tiller.
Values: 'true','false'.
Default: false.
debug
Specifies whether to enable the verbose output.
Values 'true','false'.
Default: false.
dry_run
Specifies whether to simulate an installation or delete of a deployment.
Values 'true','false'.
Default: false.
env
Sets the environment variables required for Helm to connect to the kubernetes cluster.
Default: undef.
home
The location for your Helm configuration. This value overrides $HELM_HOME.
Default: undef.
host
The host address for Tiller. Overrides $HELM_HOST.
Default: undef.
kube_context
The name for the kubeconfig context to use.
Default: undef.
local_repo_url
The local repository URL.
Default: undef.
net_host
Specifies whether to install Tiller with net=host.
Values: 'true','false'.
Default: false.
path
The value for the PATH environment variable.
Default: undef.
service_account
The name for the service account used for deploying Tiller.
Default: undef.
skip_refresh
Specifies whether to refresh or download the local repository cache.
Values: 'true','false'.
Default: false.
stable_repo_url
The stable repository URL.
Default: undef.
tiller_image
Override the Tiller image.
Default: undef
tiller_namespace
Namespace for Tiller.
Default: kube-system.
tiller_tls
Specifies whether to install Tiller with TLS enabled.
Values: 'true','false'.
Default: false.
tiller_tls_cert
The path to the TLS certificate file that is installed with Tiller.
Default: undef.
tiller_tls_key
The path to the TLS key file that is installed with Tiller.
Default: undef.
tiller_tls_verify
Specifies whether to install Tiller with TLS enabled and to verify remote certificates.
Values: 'true','false'.
Default: false.
tls_ca_cert
Specifies whether to use the path to the CA root certificate.
Values: 'true','false'.
Default: false.
upgrade
Specifies whether to upgrade if Tiller is installed.
Values: 'true','false'.
Default: false.
Defined type: helm::package
Packages a chart directory into a chart archive.
chart_name
Default: undef.
The name of the Helm chart.
chart_path
The file system location of the chart.
debug
Specifies whether to enable verbose output.
Values 'true','false'.
Default: false.
home
Location of your Helm config. This value overrides $HELM_HOME.
Default: undef.
host
The address for Tiller. This value overrides $HELM_HOST.
Default: undef.
kube_context
The name for the kubeconfig context.
Default: undef.
save
Specifies whether to save the packaged chart to the local chart repository.
Values: 'true','false'.
Default: true.
sign
Specifies whether to use a PGP private key to sign the package.
Values: 'true','false'.
Default: false.
tiller_namespace
The namespace for Tiller.
Default: undef.
version
The version of the chart.
Default: undef.
dependency_update
Specifies whether to update dependencies.
Values: 'true','false'.
Default: false.
destination
The destination location to write to.
Default: undef.
env
Sets the environment variables required for Helm to connect to the kubernetes cluster.
Default: undef.
key
Specify the key to use.
Default: undef.
keystring
The location of the public keys that are used for verification.
Default: undef.
Defined type: helm::repo
Adds a Helm repository.
ensure
Specifies whether a repo is added.
Values: 'present','absent'.
Default: present.
ca_file
Verify the certificates of HTTPS-enabled servers that are using the current CA bundle.
Default: undef.
cert_file
Use the SSL certificate file to identify the HTTPS client.
Default: undef.
debug
Specifies whether to enable verbose output.
Values 'true','false'.
Default: false.
env
Sets the environment variables required for Helm to connect to the kubernetes cluster.
Default: undef.
key_file
Use the SSL key file to identify the HTTPS client.
Default: undef.
no_update
Specifies whether to create an error when the repository is already registered.
Values 'true','false'.
Default: false.
home
Location of your Helm config. This value overrrides $HELM_HOME.
Default: undef.
host
The address for Tiller. This value overrides $HELM_HOST.
Default: undef.
kube_context
The name for the kubeconfig context to use.
Default: undef.
path
The values for PATH environment variable.
Default: undef.
tiller_namespace
The namespace for Tiller.
Default: undef.
repo_name
The name for the remote repository.
Default: undef.
url
The URL for the remote repository.
Default: undef.
Defined type: helm::repo_update
Updates all of the Helm repositories.
debug
Specifies whether to enable verbose output.
Values 'true','false'.
Default: false.
env
Sets the environment variables required for Helm to connect to the Kubernetes cluster.
Default: undef.
home
The location of your Helm config. This value overrides $HELM_HOME.
Default: undef.
host
The address for Tiller. This value overrides $HELM_HOST.
Default: undef.
kube_context
The name for the kubeconfig context to use.
Default: undef.
path
The value for the PATH environment variable.
Default: undef.
tiller_namespace
The namespace for Tiller.
Default: undef.
update
Specifies whether the repository is updated.
Values 'true','false'.
Default: true.
Limitations
This module is compatible only with the Linux kernel.
Development
Contributing
If you would like to contribute to this module please follow the rules in the CONTRIBUTING.md.
Dependencies
- puppetlabs-stdlib (>= 4.19.0)
- puppet-archive (>= 2.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.