helm: Improve documentation style and readability. (#44876)

This commit is contained in:
Jeff Geerling 2018-08-30 11:06:35 -05:00 committed by Alicia Cozine
parent 30e37d0926
commit c3e526bf2c

View file

@ -18,26 +18,26 @@ short_description: Manages Kubernetes packages with the Helm package manager
version_added: "2.4" version_added: "2.4"
author: "Flavio Percoco (flaper87)" author: "Flavio Percoco (flaper87)"
description: description:
- Install, upgrade, delete and list packages with the Helm package manage - Install, upgrade, delete and list packages with the Helm package manager.
requirements: requirements:
- "pyhelm" - "pyhelm"
- "grpcio" - "grpcio"
options: options:
host: host:
description: description:
- Tiller's server host - Tiller's server host.
default: "localhost" default: "localhost"
port: port:
description: description:
- Tiller's server port - Tiller's server port.
default: 44134 default: 44134
namespace: namespace:
description: description:
- Kubernetes namespace where the chart should be installed - Kubernetes namespace where the chart should be installed.
default: "default" default: "default"
name: name:
description: description:
- Release name to manage - Release name to manage.
state: state:
description: description:
- Whether to install C(present), remove C(absent), or purge C(purged) a package. - Whether to install C(present), remove C(absent), or purge C(purged) a package.
@ -45,13 +45,7 @@ options:
default: "present" default: "present"
chart: chart:
description: | description: |
A map describing the chart to install. For example: A map describing the chart to install. See examples for available options.
chart:
name: memcached
version: 0.4.0
source:
type: repo
location: https://kubernetes-charts.storage.googleapis.com
default: {} default: {}
values: values:
description: description:
@ -59,7 +53,7 @@ options:
default: {} default: {}
disable_hooks: disable_hooks:
description: description:
- Whether to disable hooks during the uninstall process - Whether to disable hooks during the uninstall process.
type: bool type: bool
default: 'no' default: 'no'
''' '''