Merge pull request #11060 from openshift-cherrypick-robot/cherry-pick-11030-to-devel-40

[devel-40] Fix documentation for oc - modules

Author: sdodson

roles/lib_openshift/library/oc_adm_csr.py

@@ -63,11 +63,13 @@
 options:
   state:
     description:
-    - approve|deny|list Approve, deny, and list are the only supported states for certificates
+    - State controls the action that will be taken with resource
+    - approve - create the certificate
+    - deny - remove the certificate
+    - list - return the current representation of a certificate
     required: false
-    default: present
-    choices:
-    - present
+    default: approve
+    choices: ["approve", "deny", "list"]
     aliases: []
   kubeconfig:
     description:

roles/lib_openshift/library/oc_adm_policy_group.py

@@ -61,6 +61,13 @@
 description:
   - Manage openshift policy for groups.
 options:
+  state:
+    description:
+    - State controls the action that will be taken with resource
+    required: true
+    default: present
+    choices: ["present", "absent"]
+    aliases: []
   kubeconfig:
     description:
     - The path for the kubeconfig file to use for authentication
@@ -104,13 +111,6 @@
     required: true
     default: None
     aliases: []
-  state:
-    description:
-    - Desired state of the policy
-    required: true
-    default: present
-    choices: ["present", "absent"]
-    aliases: []
 author:
 - "Kenny Woodson <[email protected]>"
 extends_documentation_fragment: []

roles/lib_openshift/library/oc_adm_policy_user.py

@@ -61,6 +61,13 @@
 description:
   - Manage openshift policy for users.
 options:
+  state:
+    description:
+    - State controls the action that will be taken with resource
+    required: true
+    default: present
+    choices: ["present", "absent"]
+    aliases: []
   kubeconfig:
     description:
     - The path for the kubeconfig file to use for authentication
@@ -110,13 +117,6 @@
     required: true
     default: None
     aliases: []
-  state:
-    description:
-    - Desired state of the policy
-    required: true
-    default: present
-    choices: ["present", "absent"]
-    aliases: []
 author:
 - "Kenny Woodson <[email protected]>"
 extends_documentation_fragment: []

roles/lib_openshift/library/oc_adm_registry.py

@@ -63,12 +63,13 @@
 options:
   state:
     description:
-    - The desired action when managing openshift registry
+    - State controls the action that will be taken with resource
     - present - update or create the registry
     - absent - tear down the registry service and deploymentconfig
     - list - returns the current representiation of a registry
     required: false
     default: False
+    choices: ["present", 'absent', 'list']
     aliases: []
   kubeconfig:
     description:

roles/lib_openshift/library/oc_adm_router.py

@@ -63,15 +63,13 @@
 options:
   state:
     description:
-    - Whether to create or delete the router
+    - State controls the action that will be taken with resource
     - present - create the router
     - absent - remove the router
     - list - return the current representation of a router
     required: false
     default: present
-    choices:
-    - present
-    - absent
+    choices: ["present", "absent", "list"]
     aliases: []
   kubeconfig:
     description:

roles/lib_openshift/library/oc_clusterrole.py

@@ -63,7 +63,7 @@
 options:
   state:
     description:
-    - Supported states, present, absent, list
+    - State controls the action that will be taken with resource
     - present - will ensure object is created or updated to the value specified
     - list - will return a clusterrole
     - absent - will remove a clusterrole

roles/lib_openshift/library/oc_configmap.py

@@ -63,7 +63,7 @@
 options:
   state:
     description:
-    - Supported states, present, absent, list
+    - State controls the action that will be taken with resource
     - present - will ensure object is created or updated to the value specified
     - list - will return a configmap
     - absent - will remove the configmap

roles/lib_openshift/library/oc_env.py

@@ -63,7 +63,7 @@
 options:
   state:
     description:
-    - Supported states, present, absent, list
+    - State controls the action that will be taken with resource
     - present - will ensure object is created or updated to the value specified
     - list - will return a list of environment variables
     - absent - will remove the environment varibale from the object

roles/lib_openshift/library/oc_group.py

@@ -63,7 +63,7 @@
 options:
   state:
     description:
-    - Supported states, present, absent, list
+    - State controls the action that will be taken with resource
     - present - will ensure object is created or updated to the value specified
     - list - will return a group
     - absent - will remove the group

roles/lib_openshift/library/oc_image.py

@@ -57,15 +57,15 @@
 DOCUMENTATION = '''
 ---
 module: oc_image
-short_description: Create, modify, and idempotently manage openshift labels.
+short_description: Create, modify, and idempotently manage openshift images.
 description:
-  - Modify openshift labels programmatically.
+  - Modify openshift images programmatically.
 options:
   state:
     description:
     - State controls the action that will be taken with resource
-    - 'present' will create.  Does _not_ support update.
-    - 'list' will read the labels
+    - present - will create the image. Does _not_ support update.
+    - list - will read the images
     default: present
     choices: ["present", "list"]
     aliases: []

roles/lib_openshift/library/oc_label.py

@@ -64,10 +64,10 @@
   state:
     description:
     - State controls the action that will be taken with resource
-    - 'present' will create or update and object to the desired state
-    - 'absent' will ensure certain labels are removed
-    - 'list' will read the labels
-    - 'add' will insert labels to the already existing labels
+    - present - will create or update and object to the desired state
+    - absent - will ensure certain labels are removed
+    - list - will read the labels
+    - add - will insert labels to the already existing labels
     default: present
     choices: ["present", "absent", "list", "add"]
     aliases: []

roles/lib_openshift/library/oc_obj.py

@@ -63,10 +63,11 @@
 options:
   state:
     description:
+    - State controls the action that will be taken with resource
     - Currently present is only supported state.
     required: true
     default: present
-    choices: ["present", "absent", "list"]
+    choices: ["present"]
     aliases: []
   kubeconfig:
     description:

roles/lib_openshift/library/oc_process.py

@@ -64,10 +64,10 @@
   state:
     description:
     - State has a few different meanings when it comes to process.
-    - state: present - This state runs an `oc process <template>`.  When used in
+    - present - This state runs an `oc process <template>`.  When used in
     - conjunction with 'create: True' the process will be piped to | oc create -f
-    - state: absent - will remove a template
-    - state: list - will perform an `oc get template <template_name>`
+    - absent - will remove a template
+    - list - will perform an `oc get template <template_name>`
     default: present
     choices: ["present", "absent", "list"]
     aliases: []

roles/lib_openshift/library/oc_project.py

@@ -63,7 +63,10 @@
 options:
   state:
     description:
-    - If present, the project will be created if it doesn't exist or update if different. If absent, the project will be removed if present. If list, information about the project will be gathered and returned as part of the Ansible call results.
+    - State controls the action that will be taken with resource
+    - present - the project will be created if it doesn't exist or update if different.
+    - absent - the project will be removed if present.
+    - list -  information about the project will be gathered and returned as part of the Ansible call results.
     required: false
     default: present
     choices: ["present", "absent", "list"]

roles/lib_openshift/library/oc_pvc.py

@@ -63,7 +63,7 @@
 options:
   state:
     description:
-    - Supported states, present, absent, list
+    - State controls the action that will be taken with resource
     - present - will ensure object is created or updated to the value specified
     - list - will return a pvc
     - absent - will remove a pvc

roles/lib_openshift/library/oc_route.py

@@ -63,7 +63,10 @@
 options:
   state:
     description:
-    - State represents whether to create, modify, delete, or list
+    - State controls the action that will be taken with resource
+    - present - create the route
+    - absent - remove the route
+    - list - returns the current representiation of the route
     required: true
     default: present
     choices: ["present", "absent", "list"]

roles/lib_openshift/library/oc_secret.py

@@ -63,7 +63,10 @@
 options:
   state:
     description:
-    - If present, the secret will be created if it doesn't exist or updated if different. If absent, the secret will be removed if present. If list, information about the secret will be gathered and returned as part of the Ansible call results.
+    - State controls the action that will be taken with resource
+    - present - the secret will be created if it doesn't exist or updated if different.
+    - absent - the secret will be removed if present.
+    - list - information about the secret will be gathered and returned as part of the Ansible call results.
     required: false
     default: present
     choices: ["present", "absent", "list"]

roles/lib_openshift/library/oc_service.py

@@ -63,7 +63,10 @@
 options:
   state:
     description:
-    - State represents whether to create, modify, delete, or list
+    - State controls the action that will be taken with resource
+    - present - create the service
+    - absent - remove the service
+    - list - return the current representation of a service
     required: False
     default: present
     choices: ["present", "absent", "list"]

roles/lib_openshift/library/oc_serviceaccount.py

@@ -63,7 +63,10 @@
 options:
   state:
     description:
-    - If present, the service account will be created if it doesn't exist or updated if different. If absent, the service account will be removed if present. If list, information about the service account will be gathered and returned as part of the Ansible call results.
+    - State controls the action that will be taken with resource
+    - present - the service account will be created if it doesn't exist or updated if different.
+    - absent - the service account will be removed if present
+    - list - information about the service account will be gathered and returned as part of the Ansible call results.
     required: false
     default: present
     choices: ["present", "absent", "list"]

roles/lib_openshift/library/oc_serviceaccount_secret.py

@@ -63,7 +63,10 @@
 options:
   state:
     description:
-    - If present, the service account will be linked with the secret if it is not already. If absent, the service account will be unlinked from the secret if it is already linked. If list, information about the service account secrets will be gathered and returned as part of the Ansible call results.
+    - State controls the action that will be taken with resource
+    - present - the service account will be linked with the secret if it is not already.
+    - absent - the service account will be unlinked from the secret if it is already linked.
+    - list - gather and return information about the service account secrets.
     required: false
     default: present
     choices: ["present", "absent", "list"]

roles/lib_openshift/library/oc_storageclass.py

@@ -63,7 +63,10 @@
 options:
   state:
     description:
-    - State represents whether to create, modify, delete, or list
+    - State controls the action that will be taken with resource
+    - present - create the storageclass
+    - absent - remove the storageclass
+    - list - return the current representation of a storageclass
     required: False
     default: present
     choices: ["present", "absent", "list"]

roles/lib_openshift/library/oc_user.py

@@ -64,9 +64,9 @@
   state:
     description:
     - State controls the action that will be taken with resource
-    - 'present' will create or update a user to the desired state
-    - 'absent' will ensure user is removed
-    - 'list' will read and return a list of users
+    - present - will create or update a user to the desired state
+    - absent - will ensure user is removed
+    - list - will read and return a list of users
     default: present
     choices: ["present", "absent", "list"]
     aliases: []

roles/lib_openshift/library/oc_version.py

@@ -63,6 +63,7 @@
 options:
   state:
     description:
+    - State controls the action that will be taken with resource
     - Currently list is only supported state.
     required: true
     default: list

roles/lib_openshift/library/oc_volume.py

@@ -64,9 +64,9 @@
   state:
     description:
     - State controls the action that will be taken with resource
-    - 'present' will create or update and object to the desired state
-    - 'absent' will ensure volumes are removed
-    - 'list' will read the volumes
+    - present - create the volume
+    - absent - remove the volume
+    - list - return the current representation of a volume
     default: present
     choices: ["present", "absent", "list"]
     aliases: []

roles/lib_openshift/src/doc/clusterrole

@@ -10,7 +10,7 @@ description:
 options:
   state:
     description:
-    - Supported states, present, absent, list
+    - State controls the action that will be taken with resource
     - present - will ensure object is created or updated to the value specified
     - list - will return a clusterrole
     - absent - will remove a clusterrole

roles/lib_openshift/src/doc/configmap

@@ -10,7 +10,7 @@ description:
 options:
   state:
     description:
-    - Supported states, present, absent, list
+    - State controls the action that will be taken with resource
     - present - will ensure object is created or updated to the value specified
     - list - will return a configmap
     - absent - will remove the configmap

roles/lib_openshift/src/doc/csr

@@ -10,11 +10,13 @@ description:
 options:
   state:
     description:
-    - approve|deny|list Approve, deny, and list are the only supported states for certificates
+    - State controls the action that will be taken with resource
+    - approve - create the certificate
+    - deny - remove the certificate
+    - list - return the current representation of a certificate
     required: false
-    default: present
-    choices:
-    - present
+    default: approve
+    choices: ["approve", "deny", "list"]
     aliases: []
   kubeconfig:
     description:

roles/lib_openshift/src/doc/env

@@ -10,7 +10,7 @@ description:
 options:
   state:
     description:
-    - Supported states, present, absent, list
+    - State controls the action that will be taken with resource
     - present - will ensure object is created or updated to the value specified
     - list - will return a list of environment variables
     - absent - will remove the environment varibale from the object

roles/lib_openshift/src/doc/group

@@ -10,7 +10,7 @@ description:
 options:
   state:
     description:
-    - Supported states, present, absent, list
+    - State controls the action that will be taken with resource
     - present - will ensure object is created or updated to the value specified
     - list - will return a group
     - absent - will remove the group