https://github.com/puppetlabs/puppetlabs-helm
A puppet module to install, configure and deploy with Helm, the kubernetes package manager
https://github.com/puppetlabs/puppetlabs-helm
module unsupported
Last synced: 3 months ago
JSON representation
A puppet module to install, configure and deploy with Helm, the kubernetes package manager
- Host: GitHub
- URL: https://github.com/puppetlabs/puppetlabs-helm
- Owner: puppetlabs
- License: apache-2.0
- Created: 2017-08-01T09:17:34.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T02:35:16.000Z (5 months ago)
- Last Synced: 2025-03-29T04:05:58.937Z (3 months ago)
- Topics: module, unsupported
- Language: Ruby
- Homepage:
- Size: 563 KB
- Stars: 6
- Watchers: 80
- Forks: 33
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://travis-ci.org/puppetlabs/puppetlabs-helm)
[](https://forge.puppetlabs.com/puppetlabs/helm)
[](https://forge.puppetlabs.com/puppetlabs/helm)
# Helm
#### Table of Contents
- [Helm](#Helm)
- [Table of Contents](#Table-of-Contents)
- [Description](#Description)
- [Support](#support)
- [Setup](#Setup)
- [Usage](#Usage)
- [Reference](#Reference)
- [Limitations](#Limitations)
- [Development](#Development)
- [Contributing](#Contributing)
## 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. The Helm package manager installs and manages Kubernetes applications.
## Support
This module is not supported or maintained by Puppet and does not qualify for Puppet Support plans.
It's provided without guarantee or warranty and you can use it at your own risk.
All bugfixes, updates, and new feature development will come from community contributions.
[tier:community]
## 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](https://github.com/kubernetes/helm/issues/2224).
To install the helm module, include the `helm` class:
```puppet
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:
```puppet
class { 'helm':
version => '2.6.0',
service_account => 'my_account',
tiller_namespaces => ['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:
```puppet
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:
```puppet
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:
```puppet
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:
```puppet
helm::repo { 'myrepo':
ensure => present,
env => $env,
path => $path,
username => 'username',
password => 'password',
repo_name => 'myrepo',
url => 'http://myserver/charts'
}
```
To update a Helm chart repository, add the following code to the manifest file:
```puppet
helm::repo_update { 'update':
env => $env,
path => $path,
update => true
}
```
## Reference
[REFERENCE.md](https://github.com/puppetlabs/puppetlabs-helm/blob/main/REFERENCE.md).
## 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](https://github.com/puppetlabs/puppetlabs-helm/blob/main/CONTRIBUTING.md).
To run the acceptance tests you can use Puppet Litmus with the Vagrant provider by using the following commands:
bundle exec rake 'litmus:provision_list[all_supported]'
bundle exec rake 'litmus:install_agent[puppet5]'
bundle exec rake 'litmus:install_module'
bundle exec rake 'litmus:acceptance:parallel'
As currently Litmus does not allow memory size and cpu size parameters for the Vagrant provisioner task we recommend to manually update the Vagrantfile used by the provisioner and add at least the following specifications for the puppetlabs-kubernetes module acceptance tests:
**Update Vagrantfile in the file: spec/fixtures/modules/provision/tasks/vagrant.rb**
vf = <<-VF
Vagrant.configure(\"2\") do |config|
config.vm.box = '#{platform}'
config.vm.boot_timeout = 600
config.ssh.insert_key = false
config.vm.hostname = "testkube"
config.vm.provider "virtualbox" do |vb|
vb.memory = "2048"
vb.cpus = "2"
end
#{network}
#{synced_folder}
end
VF