k8s_info: Update documentation

* Used name_option doc_fragments * Updated doc formatting * Updated k8s_info example for custom resource Signed-off-by: Abhijeet Kasurde <[email protected]>
ansible-collections · Aug 24, 2020 · d7b145d · d7b145d
1 parent f38cae3
commit d7b145d
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 39 deletions.
diff --git a/changelogs/fragments/202_k8s_info.yml b/changelogs/fragments/202_k8s_info.yml
@@ -0,0 +1,2 @@
+minor_changes:
+- k8s_info - update custom resource example (https://github.com/ansible-collections/community.kubernetes/issues/202).
diff --git a/plugins/doc_fragments/k8s_name_options.py b/plugins/doc_fragments/k8s_name_options.py
@@ -15,9 +15,10 @@ class ModuleDocFragment(object):
 options:
   api_version:
     description:
-    - Use to specify the API version. Use to create, delete, or discover an object without providing a full
-      resource definition. Use in conjunction with I(kind), I(name), and I(namespace) to identify a
-      specific object. If I(resource definition) is provided, the I(apiVersion) from the I(resource_definition)
+    - Use to specify the API version.
+    - Use to create, delete, or discover an object without providing a full resource definition.
+    - Use in conjunction with I(kind), I(name), and I(namespace) to identify a specific object.
+    - If I(resource definition) is provided, the I(apiVersion) value from the I(resource_definition)
       will override this option.
     type: str
     default: v1
@@ -26,23 +27,26 @@ class ModuleDocFragment(object):
     - version
   kind:
     description:
-    - Use to specify an object model. Use to create, delete, or discover an object without providing a full
-      resource definition. Use in conjunction with I(api_version), I(name), and I(namespace) to identify a
-      specific object. If I(resource definition) is provided, the I(kind) from the I(resource_definition)
+    - Use to specify an object model.
+    - Use to create, delete, or discover an object without providing a full resource definition.
+    - Use in conjunction with I(api_version), I(name), and I(namespace) to identify a specific object.
+    - If I(resource definition) is provided, the I(kind) value from the I(resource_definition)
       will override this option.
     type: str
   name:
     description:
-    - Use to specify an object name. Use to create, delete, or discover an object without providing a full
-      resource definition. Use in conjunction with I(api_version), I(kind) and I(namespace) to identify a
-      specific object. If I(resource definition) is provided, the I(metadata.name) value from the
-      I(resource_definition) will override this option.
+    - Use to specify an object name.
+    - Use to create, delete, or discover an object without providing a full resource definition.
+    - Use in conjunction with I(api_version), I(kind) and I(namespace) to identify a specific object.
+    - If I(resource definition) is provided, the I(metadata.name) value from the I(resource_definition)
+      will override this option.
     type: str
   namespace:
     description:
-    - Use to specify an object namespace. Useful when creating, deleting, or discovering an object without
-      providing a full resource definition. Use in conjunction with I(api_version), I(kind), and I(name)
-      to identify a specific object. If I(resource definition) is provided, the I(metadata.namespace) value
-      from the I(resource_definition) will override this option.
+    - Use to specify an object namespace.
+    - Useful when creating, deleting, or discovering an object without providing a full resource definition.
+    - Use in conjunction with I(api_version), I(kind), and I(name) to identify a specific object.
+    - If I(resource definition) is provided, the I(metadata.namespace) value from the I(resource_definition)
+      will override this option.
     type: str
 '''
diff --git a/plugins/modules/k8s_info.py b/plugins/modules/k8s_info.py
@@ -25,31 +25,6 @@
   - This module was called C(k8s_facts) before Ansible 2.9. The usage did not change.
 
 options:
-  api_version:
-    description:
-    - Use to specify the API version. in conjunction with I(kind), I(name), and I(namespace) to identify a
-      specific object.
-    default: v1
-    aliases:
-    - api
-    - version
-    type: str
-  kind:
-    description:
-    - Use to specify an object model. Use in conjunction with I(api_version), I(name), and I(namespace) to identify a
-      specific object.
-    required: yes
-    type: str
-  name:
-    description:
-    - Use to specify an object name.  Use in conjunction with I(api_version), I(kind) and I(namespace) to identify a
-      specific object.
-    type: str
-  namespace:
-    description:
-    - Use to specify an object namespace. Use in conjunction with I(api_version), I(kind), and I(name)
-      to identify a specific object.
-    type: str
   label_selectors:
     description: List of label selectors to use to filter results
     type: list
@@ -61,6 +36,7 @@
 
 extends_documentation_fragment:
   - community.kubernetes.k8s_auth_options
+  - community.kubernetes.k8s_name_options
 
 requirements:
   - "python >= 2.7"
@@ -109,6 +85,11 @@
     kind: Pod
     field_selectors:
       - status.phase=Running
+
+- name: List custom objects created using CRD
+  community.kubernetes.k8s_info:
+    kind: MyCustomObject
+    api_version: "stable.example.com/v1"
 '''
 
 RETURN = r'''
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		minor_changes:
		- k8s_info - update custom resource example (https://github.com/ansible-collections/community.kubernetes/issues/202).