Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

helm: Improve documentation style and readability. #44876

Merged
merged 1 commit into from
Aug 30, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 7 additions & 13 deletions lib/ansible/modules/cloud/misc/helm.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,48 +18,42 @@
version_added: "2.4"
author: "Flavio Percoco (flaper87)"
description:
- Install, upgrade, delete and list packages with the Helm package manage
- Install, upgrade, delete and list packages with the Helm package manager.
requirements:
- "pyhelm"
- "grpcio"
options:
host:
description:
- Tiller's server host
- Tiller's server host.
default: "localhost"
port:
description:
- Tiller's server port
- Tiller's server port.
default: 44134
namespace:
description:
- Kubernetes namespace where the chart should be installed
- Kubernetes namespace where the chart should be installed.
default: "default"
name:
description:
- Release name to manage
- Release name to manage.
state:
description:
- Whether to install C(present), remove C(absent), or purge C(purged) a package.
choices: ['absent', 'purged', 'present']
default: "present"
chart:
description: |
A map describing the chart to install. For example:
chart:
name: memcached
version: 0.4.0
source:
type: repo
location: https://kubernetes-charts.storage.googleapis.com
A map describing the chart to install. See examples for available options.
default: {}
values:
description:
- A map of value options for the chart.
default: {}
disable_hooks:
description:
- Whether to disable hooks during the uninstall process
- Whether to disable hooks during the uninstall process.
type: bool
default: 'no'
'''
Expand Down