c12s-kubespray/roles/helm-apps/README.md
Max Gautier 307d122a84
Helm-apps role for installing helm charts (#8347)
* Sketch of helm-apps role interface

* helm-apps: Early implementation and settings

* helm-apps: Fix README.md example playbook

* fixup! Sketch of helm-apps role interface

* Make the argument specs more explicit

* Remove exposed options from hardcoded default

* Simplify example playbook in README.md

- Define directly the roles parameters
- Add an example of option override for one chart only

* Use release instead of charts

Make explicit that the role is mananing releases, not charts.
Simplify parameters naming
2022-03-14 08:29:58 -07:00

40 lines
936 B
Markdown

Role Name
=========
This role is intended to be used to fetch and deploy Helm Charts as part of
cluster installation or upgrading with kubespray.
Requirements
------------
The role needs to be executed on a host with access to the Kubernetes API, and
with the helm binary in place.
Role Variables
--------------
See meta/argument_specs.yml
Playbook example:
```yaml
---
- hosts: kube_control_plane[0]
gather_facts: no
roles:
- name: helm-apps
releases:
- name: app
namespace: app
chart_ref: simple-app/simple-app
- name: app2
namespace: app
chart_ref: simple-app/simple-app
wait_timeout: "10m" # override the same option in `release_common_opts`
repositories: "{{ repos }}"
- repo_name: simple-app
repo_url: "https://blog.leiwang.info/simple-app"
release_common_opts: "{{ helm_params }}"
wait_timeout: "5m"
```