c12s-kubespray/roles/helm-apps/meta/argument_specs.yml
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

93 lines
2.2 KiB
YAML

---
argument_specs:
main:
short_description: Install a list of Helm charts.
options:
releases:
type: list
elements: dict
required: true
description: |
List of dictionaries passed as arguments to kubernetes.core.helm.
Arguments passed here will override those in `helm_settings`. For
structure of the dictionary, see the documentation for
kubernetes.core.helm ansible module.
options:
chart_ref:
type: path
required: true
chart_version:
type: str
name:
type: str
required: true
namespace:
type: str
required: true
values:
type: dict
# Possibly general options
create_namespace:
type: bool
chart_repo_url:
type: str
disable_hook:
type: bool
history_max:
type: int
purge:
type: bool
replace:
type: bool
skip_crds:
type: bool
wait:
type: bool
default: true
wait_timeout:
type: str
repositories:
type: list
elements: dict
description: |
List of dictionaries passed as arguments to
kubernetes.core.helm_repository.
default: []
options:
name:
type: str
required: true
password:
type: str
username:
type: str
url:
type: str
release_common_opts:
type: dict
description: |
Common arguments for every helm invocation.
default: {}
options:
create_namespace:
type: bool
default: true
chart_repo_url:
type: str
disable_hook:
type: bool
history_max:
type: int
purge:
type: bool
replace:
type: bool
skip_crds:
type: bool
wait:
type: bool
default: true
wait_timeout:
type: str
default: "5m"