Minor doc fixes (#114)

* Spelling fixes
* Documentation update
* Example update to use FQCN

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde
2020-06-05 11:32:26 +05:30
committed by GitHub
parent 01399ea840
commit 3078131db5
11 changed files with 69 additions and 69 deletions

View File

@@ -10,7 +10,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
DOCUMENTATION = r'''
module: k8s_scale
@@ -36,9 +36,9 @@ requirements:
- "PyYAML >= 3.11"
'''
EXAMPLES = '''
EXAMPLES = r'''
- name: Scale deployment up, and extend timeout
k8s_scale:
community.kubernetes.k8s_scale:
api_version: v1
kind: Deployment
name: elastic
@@ -47,7 +47,7 @@ EXAMPLES = '''
wait_timeout: 60
- name: Scale deployment down when current replicas match
k8s_scale:
community.kubernetes.k8s_scale:
api_version: v1
kind: Deployment
name: elastic
@@ -56,7 +56,7 @@ EXAMPLES = '''
replicas: 2
- name: Increase job parallelism
k8s_scale:
community.kubernetes.k8s_scale:
api_version: batch/v1
kind: job
name: pi-with-timeout
@@ -66,25 +66,25 @@ EXAMPLES = '''
# Match object using local file or inline definition
- name: Scale deployment based on a file from the local filesystem
k8s_scale:
community.kubernetes.k8s_scale:
src: /myproject/elastic_deployment.yml
replicas: 3
wait: no
- name: Scale deployment based on a template output
k8s_scale:
community.kubernetes.k8s_scale:
resource_definition: "{{ lookup('template', '/myproject/elastic_deployment.yml') | from_yaml }}"
replicas: 3
wait: no
- name: Scale deployment based on a file from the Ansible controller filesystem
k8s_scale:
community.kubernetes.k8s_scale:
resource_definition: "{{ lookup('file', '/myproject/elastic_deployment.yml') | from_yaml }}"
replicas: 3
wait: no
'''
RETURN = '''
RETURN = r'''
result:
description:
- If a change was made, will return the patched object, otherwise returns the existing object.