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

minor(doc): use the same style of version_added across repo #703

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions plugins/doc_fragments/helm_common_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,25 +36,25 @@ class ModuleDocFragment(object):
description:
- Provide a URL for accessing the API. Can also be specified via C(K8S_AUTH_HOST) environment variable.
type: str
version_added: "1.2.0"
version_added: 1.2.0
api_key:
description:
- Token used to authenticate with the API. Can also be specified via C(K8S_AUTH_API_KEY) environment variable.
type: str
version_added: "1.2.0"
version_added: 1.2.0
validate_certs:
description:
- Whether or not to verify the API server's SSL certificates. Can also be specified via C(K8S_AUTH_VERIFY_SSL)
environment variable.
type: bool
aliases: [ verify_ssl ]
default: True
version_added: "1.2.0"
version_added: 1.2.0
ca_cert:
description:
- Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to
avoid certificate validation errors. Can also be specified via C(K8S_AUTH_SSL_CA_CERT) environment variable.
type: path
aliases: [ ssl_ca_cert ]
version_added: "1.2.0"
version_added: 1.2.0
"""
2 changes: 1 addition & 1 deletion plugins/doc_fragments/k8s_delete_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class ModuleDocFragment(object):
options:
delete_options:
type: dict
version_added: '1.2.0'
version_added: 1.2.0
description:
- Configure behavior when deleting an object.
- Only used when I(state=absent).
Expand Down
2 changes: 1 addition & 1 deletion plugins/lookup/kustomize.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

short_description: Build a set of kubernetes resources using a 'kustomization.yaml' file.

version_added: "2.2.0"
version_added: 2.2.0

author:
- Aubin Bikouo (@abikouo)
Expand Down
24 changes: 12 additions & 12 deletions plugins/modules/helm.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

short_description: Manages Kubernetes packages with the Helm package manager

version_added: "0.11.0"
version_added: 0.11.0

author:
- Lucas Boisserie (@LucasBoisserie)
Expand Down Expand Up @@ -61,7 +61,7 @@
default: false
type: bool
aliases: [ dep_up ]
version_added: "2.4.0"
version_added: 2.4.0
release_name:
description:
- Release name to manage.
Expand Down Expand Up @@ -99,7 +99,7 @@
default: []
type: list
elements: str
version_added: '1.1.0'
version_added: 1.1.0
update_repo_cache:
description:
- Run C(helm repo update) before the operation. Can be run as part of the package installation or as a separate step (see Examples).
Expand Down Expand Up @@ -129,22 +129,22 @@
- string
- json
- file
version_added: '2.4.0'
version_added: 2.4.0
reuse_values:
description:
- When upgrading package, specifies wether to reuse the last release's values and merge in any overrides from parameters I(release_values),
I(values_files) or I(set_values).
- If I(reset_values) is set to C(True), this is ignored.
type: bool
required: false
version_added: '2.5.0'
version_added: 2.5.0
reset_values:
description:
- When upgrading package, reset the values to the ones built into the chart.
type: bool
required: false
default: True
version_added: '2.5.0'
version_added: 2.5.0

#Helm options
disable_hook:
Expand Down Expand Up @@ -181,7 +181,7 @@
- similar to C(wait_timeout) but does not required C(wait) to be activated.
- Mutually exclusive with C(wait_timeout).
type: str
version_added: "2.3.0"
version_added: 2.3.0
atomic:
description:
- If set, the installation process deletes the installation on failure.
Expand All @@ -192,32 +192,32 @@
- Create the release namespace if not present.
type: bool
default: False
version_added: "0.11.1"
version_added: 0.11.1
post_renderer:
description:
- Path to an executable to be used for post rendering.
type: str
version_added: "2.4.0"
version_added: 2.4.0
replace:
description:
- Reuse the given name, only if that name is a deleted release which remains in the history.
- This is unsafe in production environment.
- mutually exclusive with with C(history_max).
type: bool
default: False
version_added: "1.11.0"
version_added: 1.11.0
skip_crds:
description:
- Skip custom resource definitions when installing or upgrading.
type: bool
default: False
version_added: "1.2.0"
version_added: 1.2.0
history_max:
description:
- Limit the maximum number of revisions saved per release.
- mutually exclusive with with C(replace).
type: int
version_added: "2.2.0"
version_added: 2.2.0
extends_documentation_fragment:
- kubernetes.core.helm_common_options
"""
Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/helm_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

short_description: Get information from Helm package deployed inside the cluster

version_added: "0.11.0"
version_added: 0.11.0

author:
- Lucas Boisserie (@LucasBoisserie)
Expand Down Expand Up @@ -53,15 +53,15 @@
type: list
elements: str
default: []
version_added: "2.3.0"
version_added: 2.3.0
get_all_values:
description:
- Set to C(True) if you want to get all (computed) values of the release.
- When C(False) (default), only user supplied values are returned.
required: false
default: false
type: bool
version_added: "2.4.0"
version_added: 2.4.0
extends_documentation_fragment:
- kubernetes.core.helm_common_options
"""
Expand Down Expand Up @@ -123,18 +123,18 @@
elements: dict
description: Hooks of the release
returned: always
version_added: "2.4.0"
version_added: 2.4.0
notes:
type: str
description: Notes of the release
returned: always
version_added: "2.4.0"
version_added: 2.4.0
manifest:
type: list
elements: dict
description: Manifest of the release
returned: always
version_added: "2.4.0"
version_added: 2.4.0
"""

import copy
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/helm_plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
---
module: helm_plugin
short_description: Manage Helm plugins
version_added: "1.0.0"
version_added: 1.0.0
author:
- Abhijeet Kasurde (@Akasurde)
requirements:
Expand Down Expand Up @@ -47,7 +47,7 @@
- Ignored when C(state=absent) or C(state=latest).
required: false
type: str
version_added: "2.3.0"
version_added: 2.3.0
extends_documentation_fragment:
- kubernetes.core.helm_common_options
"""
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/helm_plugin_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
---
module: helm_plugin_info
short_description: Gather information about Helm plugins
version_added: "1.0.0"
version_added: 1.0.0
author:
- Abhijeet Kasurde (@Akasurde)
requirements:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/helm_pull.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
---
module: helm_pull
short_description: download a chart from a repository and (optionally) unpack it in local directory.
version_added: "2.4.0"
version_added: 2.4.0
author:
- Aubin Bikouo (@abikouo)
description:
Expand Down
16 changes: 8 additions & 8 deletions plugins/modules/helm_repository.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

short_description: Manage Helm repositories.

version_added: "0.11.0"
version_added: 0.11.0

author:
- Lucas Boisserie (@LucasBoisserie)
Expand Down Expand Up @@ -76,49 +76,49 @@
description:
- Provide a URL for accessing the API. Can also be specified via C(K8S_AUTH_HOST) environment variable.
type: str
version_added: "2.3.0"
version_added: 2.3.0
api_key:
description:
- Token used to authenticate with the API. Can also be specified via C(K8S_AUTH_API_KEY) environment variable.
type: str
version_added: "2.3.0"
version_added: 2.3.0
validate_certs:
description:
- Whether or not to verify the API server's SSL certificates. Can also be specified via C(K8S_AUTH_VERIFY_SSL)
environment variable.
type: bool
aliases: [ verify_ssl ]
default: True
version_added: "2.3.0"
version_added: 2.3.0
ca_cert:
description:
- Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to
avoid certificate validation errors. Can also be specified via C(K8S_AUTH_SSL_CA_CERT) environment variable.
type: path
aliases: [ ssl_ca_cert ]
version_added: "2.3.0"
version_added: 2.3.0
context:
description:
- Helm option to specify which kubeconfig context to use.
- If the value is not specified in the task, the value of environment variable C(K8S_AUTH_CONTEXT) will be used instead.
type: str
aliases: [ kube_context ]
version_added: "2.4.0"
version_added: 2.4.0
kubeconfig:
description:
- Helm option to specify kubeconfig path to use.
- If the value is not specified in the task, the value of environment variable C(K8S_AUTH_KUBECONFIG) will be used instead.
- The configuration can be provided as dictionary.
type: raw
aliases: [ kubeconfig_path ]
version_added: "2.4.0"
version_added: 2.4.0
force_update:
description:
- Whether or not to replace (overwrite) the repo if it already exists.
type: bool
aliases: [ force ]
default: False
version_added: "2.4.0"
version_added: 2.4.0
"""

EXAMPLES = r"""
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/helm_template.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
default: false
type: bool
aliases: [ dep_up ]
version_added: "2.4.0"
version_added: 2.4.0
disable_hook:
description:
- Prevent hooks from running during install.
Expand Down Expand Up @@ -139,7 +139,7 @@
- string
- json
- file
version_added: '2.4.0'
version_added: 2.4.0
"""

EXAMPLES = r"""
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/k8s_cluster_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
DOCUMENTATION = r"""
module: k8s_cluster_info

version_added: "0.11.1"
version_added: 0.11.1

short_description: Describe Kubernetes (K8s) cluster, APIs available and their respective versions

Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/k8s_cp.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

short_description: Copy files and directories to and from pod.

version_added: "2.2.0"
version_added: 2.2.0

author:
- Aubin Bikouo (@abikouo)
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/k8s_drain.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

short_description: Drain, Cordon, or Uncordon node in k8s cluster

version_added: "2.2.0"
version_added: 2.2.0

author: Aubin Bikouo (@abikouo)

Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/k8s_exec.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

short_description: Execute command in Pod

version_added: "0.10.0"
version_added: 0.10.0

author: "Tristan de Cacqueray (@tristanC)"

Expand Down
10 changes: 5 additions & 5 deletions plugins/modules/k8s_log.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

short_description: Fetch logs from Kubernetes resources

version_added: "0.10.0"
version_added: 0.10.0

author:
- "Fabian von Feilitzsch (@fabianvf)"
Expand Down Expand Up @@ -61,26 +61,26 @@
- A relative time in seconds before the current time from which to show logs.
required: no
type: str
version_added: '2.2.0'
version_added: 2.2.0
previous:
description:
- If C(true), print the logs for the previous instance of the container in a pod if it exists.
required: no
type: bool
default: False
version_added: '2.4.0'
version_added: 2.4.0
tail_lines:
description:
- A number of lines from the end of the logs to retrieve.
required: no
type: int
version_added: '2.4.0'
version_added: 2.4.0
all_containers:
description:
- If set to C(true), retrieve all containers' logs in the pod(s).
- mutually exclusive with C(container).
type: bool
version_added: '2.4.0'
version_added: 2.4.0

requirements:
- "python >= 3.9"
Expand Down
Loading
Loading