From 2d122d692bf14b939dcaefd4ca46d018a198eb56 Mon Sep 17 00:00:00 2001
From: Kenny Woodson <kwoodson@redhat.com>
Date: Wed, 18 Jan 2017 15:50:08 -0500
Subject: Adding oc_obj to the lib_openshift library

---
 roles/lib_openshift/src/doc/obj | 95 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 95 insertions(+)
 create mode 100644 roles/lib_openshift/src/doc/obj

(limited to 'roles/lib_openshift/src/doc')

diff --git a/roles/lib_openshift/src/doc/obj b/roles/lib_openshift/src/doc/obj
new file mode 100644
index 000000000..e44843eb3
--- /dev/null
+++ b/roles/lib_openshift/src/doc/obj
@@ -0,0 +1,95 @@
+# flake8: noqa
+# pylint: skip-file
+
+DOCUMENTATION = '''
+---
+module: oc_obj
+short_description: Generic interface to openshift objects
+description:
+  - Manage openshift objects 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: []
+  name:
+    description:
+    - Name of the object that is being queried.
+    required: false
+    default: None
+    aliases: []
+  namespace:
+    description:
+    - The namespace where the object lives.
+    required: false
+    default: str
+    aliases: []
+  all_namespace:
+    description:
+    - The namespace where the object lives.
+    required: false
+    default: false
+    aliases: []
+  kind:
+    description:
+    - The kind attribute of the object. e.g. dc, bc, svc, route
+    required: True
+    default: None
+    aliases: []
+  files:
+    description:
+    - A list of files provided for object
+    required: false
+    default: None
+    aliases: []
+  delete_after:
+    description:
+    - Whether or not to delete the files after processing them.
+    required: false
+    default: false
+    aliases: []
+  content:
+    description:
+    - Content of the object being managed.
+    required: false
+    default: None
+    aliases: []
+  force:
+    description:
+    - Whether or not to force the operation
+    required: false
+    default: None
+    aliases: []
+  selector:
+    description:
+    - Selector that gets added to the query.
+    required: false
+    default: None
+    aliases: []
+author:
+- "Kenny Woodson <kwoodson@redhat.com>"
+extends_documentation_fragment: []
+'''
+
+EXAMPLES = '''
+oc_obj:
+  kind: dc
+  name: router
+  namespace: default
+register: router_output
+'''
-- 
cgit v1.2.3