mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-05-13 21:12:05 +00:00
Embedded docs clarifications and refinements. (#258)
* Another embedded docs clarifications in k8s_rollback * Embedded docs clarification in helm_pljugin_info * Embedded docs clarification in k8s * More embedded docs clarification in k8s inventory plugin * Fixed markdown formatting to RST in k8s_rollback
This commit is contained in:
@@ -14,8 +14,9 @@ DOCUMENTATION = '''
|
|||||||
short_description: Kubernetes (K8s) inventory source
|
short_description: Kubernetes (K8s) inventory source
|
||||||
|
|
||||||
description:
|
description:
|
||||||
- Fetch containers and services for one or more clusters
|
- Fetch containers and services for one or more clusters.
|
||||||
- Groups by cluster name, namespace, namespace_services, namespace_pods, and labels
|
- Groups by cluster name, namespace, namespace_services, namespace_pods, and labels.
|
||||||
|
- Uses the kubectl connection plugin to access the Kubernetes cluster.
|
||||||
- Uses k8s.(yml|yaml) YAML configuration file to set parameter values.
|
- Uses k8s.(yml|yaml) YAML configuration file to set parameter values.
|
||||||
|
|
||||||
options:
|
options:
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ EXAMPLES = r'''
|
|||||||
- name: Gather Helm plugin info
|
- name: Gather Helm plugin info
|
||||||
community.kubernetes.helm_plugin_info:
|
community.kubernetes.helm_plugin_info:
|
||||||
|
|
||||||
- name: Gather Helm plugin info
|
- name: Gather Helm env plugin info
|
||||||
community.kubernetes.helm_plugin_info:
|
community.kubernetes.helm_plugin_info:
|
||||||
plugin_name: env
|
plugin_name: env
|
||||||
'''
|
'''
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ DOCUMENTATION = r'''
|
|||||||
---
|
---
|
||||||
module: helm_repository
|
module: helm_repository
|
||||||
|
|
||||||
short_description: Add and remove Helm repository
|
short_description: Manage Helm repositories.
|
||||||
|
|
||||||
version_added: "0.11.0"
|
version_added: "0.11.0"
|
||||||
|
|
||||||
@@ -59,7 +59,7 @@ options:
|
|||||||
repo_state:
|
repo_state:
|
||||||
choices: ['present', 'absent']
|
choices: ['present', 'absent']
|
||||||
description:
|
description:
|
||||||
- Desirated state of repository.
|
- Desired state of repository.
|
||||||
required: false
|
required: false
|
||||||
default: present
|
default: present
|
||||||
aliases: [ state ]
|
aliases: [ state ]
|
||||||
@@ -71,6 +71,11 @@ EXAMPLES = r'''
|
|||||||
community.kubernetes.helm_repository:
|
community.kubernetes.helm_repository:
|
||||||
name: stable
|
name: stable
|
||||||
repo_url: https://kubernetes-charts.storage.googleapis.com
|
repo_url: https://kubernetes-charts.storage.googleapis.com
|
||||||
|
|
||||||
|
- name: Add Red Hat Helm charts repository
|
||||||
|
community.kubernetes.helm_repository:
|
||||||
|
name: redhat-charts
|
||||||
|
repo_url: https://redhat-developer.github.com/redhat-helm-charts
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = r''' # '''
|
RETURN = r''' # '''
|
||||||
|
|||||||
@@ -179,17 +179,12 @@ EXAMPLES = r'''
|
|||||||
state: present
|
state: present
|
||||||
definition: "{{ lookup('file', '/testing/deployment.yml') | from_yaml }}"
|
definition: "{{ lookup('file', '/testing/deployment.yml') | from_yaml }}"
|
||||||
|
|
||||||
- name: Read definition file from the Ansible controller file system after Jinja templating
|
|
||||||
community.kubernetes.k8s:
|
|
||||||
state: present
|
|
||||||
definition: "{{ lookup('template', '/testing/deployment.yml') | from_yaml }}"
|
|
||||||
|
|
||||||
- name: Read definition template file from the Ansible controller file system
|
- name: Read definition template file from the Ansible controller file system
|
||||||
community.kubernetes.k8s:
|
community.kubernetes.k8s:
|
||||||
state: present
|
state: present
|
||||||
template: '/testing/deployment.j2'
|
template: '/testing/deployment.j2'
|
||||||
|
|
||||||
- name: Read definition template file from the Ansible controller file system
|
- name: Read definition template file from the Ansible controller file system that uses custom start/end strings
|
||||||
community.kubernetes.k8s:
|
community.kubernetes.k8s:
|
||||||
state: present
|
state: present
|
||||||
template:
|
template:
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ author:
|
|||||||
description:
|
description:
|
||||||
- Use the OpenShift Python client to perform the Rollback.
|
- Use the OpenShift Python client to perform the Rollback.
|
||||||
- Authenticate using either a config file, certificates, password or token.
|
- Authenticate using either a config file, certificates, password or token.
|
||||||
- Similar to the kubectl rollout undo command.
|
- Similar to the C(kubectl rollout undo) command.
|
||||||
options:
|
options:
|
||||||
label_selectors:
|
label_selectors:
|
||||||
description: List of label selectors to use to filter results.
|
description: List of label selectors to use to filter results.
|
||||||
|
|||||||
Reference in New Issue
Block a user