oc process

1 files changed, 81 insertions, 0 deletions

diff --git a/roles/lib_openshift/src/doc/process b/roles/lib_openshift/src/doc/process
new file mode 100644
index 000000000..46986f8de
--- /dev/null
+++ b/roles/lib_openshift/src/doc/process
@@ -0,0 +1,81 @@
+# flake8: noqa
+# pylint: skip-file
+
+DOCUMENTATION = '''
+---
+module: oc_process
+short_description: Module to process openshift templates
+description:
+  - Process openshift templates programmatically.
+options:
+  state:
+    description:
+    - Currently present is only supported state.
+    required: true
+    default: present
+    choices: ["present", "absent", "list"]
+    aliases: []
+  kubeconfig:
+    description:
+    - The path for the kubeconfig file to use for authentication
+    required: false
+    default: /etc/origin/master/admin.kubeconfig
+    aliases: []
+  debug:
+    description:
+    - Turn on debug output.
+    required: false
+    default: False
+    aliases: []
+  template_name:
+    description:
+    - Name of the template that is being processed.
+    required: false
+    default: None
+    aliases: []
+  namespace:
+    description:
+    - The namespace where the object lives.
+    required: false
+    default: str
+    aliases: []
+  content:
+    description:
+    - Template content to be processed.
+    required: false
+    default: None
+    aliases: []
+  params:
+    description:
+    - A list of parameters that will be inserted into the template.
+    required: false
+    default: None
+    aliases: []
+  create:
+    description:
+    - Whether or not to create the template after being processed. e.q  oc process | oc create -f -
+    required: false
+    default: None
+    aliases: []
+  reconcile:
+    description:
+    - Whether or not to attempt to determine if there are updates or changes in the incoming template.
+    required: false
+    default: true
+    aliases: []
+author:
+- "Kenny Woodson <kwoodson@redhat.com>"
+extends_documentation_fragment: []
+'''
+EXAMPLES = '''
+- name: process the cloud volume provisioner template with variables
+  oc_process:
+    namespace: openshift-infra
+    template_name: online-volume-provisioner
+    create: True
+    params:
+      PLAT: rhel7
+  register: processout
+  run_once: true
+- debug: var=processout
+'''