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

@@ -9,7 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
DOCUMENTATION = r'''
module: k8s
@@ -147,16 +147,16 @@ requirements:
- "PyYAML >= 3.11"
'''
EXAMPLES = '''
EXAMPLES = r'''
- name: Create a k8s namespace
k8s:
community.kubernetes.k8s:
name: testing
api_version: v1
kind: Namespace
state: present
- name: Create a Service object from an inline definition
k8s:
community.kubernetes.k8s:
state: present
definition:
apiVersion: v1
@@ -178,7 +178,7 @@ EXAMPLES = '''
port: 8000
- name: Remove an existing Service object
k8s:
community.kubernetes.k8s:
state: absent
api_version: v1
kind: Service
@@ -188,31 +188,31 @@ EXAMPLES = '''
# Passing the object definition from a file
- name: Create a Deployment by reading the definition from a local file
k8s:
community.kubernetes.k8s:
state: present
src: /testing/deployment.yml
- name: >-
Read definition file from the Ansible controller file system.
If the definition file has been encrypted with Ansible Vault it will automatically be decrypted.
k8s:
community.kubernetes.k8s:
state: present
definition: "{{ lookup('file', '/testing/deployment.yml') | from_yaml }}"
- name: Read definition file from the Ansible controller file system after Jinja templating
k8s:
community.kubernetes.k8s:
state: present
definition: "{{ lookup('template', '/testing/deployment.yml') | from_yaml }}"
- name: fail on validation errors
k8s:
community.kubernetes.k8s:
state: present
definition: "{{ lookup('template', '/testing/deployment.yml') | from_yaml }}"
validate:
fail_on_error: yes
- name: warn on validation errors, check for unexpected properties
k8s:
community.kubernetes.k8s:
state: present
definition: "{{ lookup('template', '/testing/deployment.yml') | from_yaml }}"
validate:
@@ -220,7 +220,7 @@ EXAMPLES = '''
strict: yes
'''
RETURN = '''
RETURN = r'''
result:
description:
- The created, patched, or otherwise present object. Will be empty in the case of a deletion.