From ea33e223e34bb2b8efae6b165f3ac9729357cb46 Mon Sep 17 00:00:00 2001
From: Kenny Woodson <kwoodson@redhat.com>
Date: Fri, 13 Jan 2017 14:29:48 -0500
Subject: Adding oc_edit module to lib_openshift.

---
 roles/lib_openshift/src/doc/edit  | 116 ++++++++++++++++++++++++++++++++++++++
 roles/lib_openshift/src/doc/route |   6 +-
 2 files changed, 119 insertions(+), 3 deletions(-)
 create mode 100644 roles/lib_openshift/src/doc/edit

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

diff --git a/roles/lib_openshift/src/doc/edit b/roles/lib_openshift/src/doc/edit
new file mode 100644
index 000000000..212d88f65
--- /dev/null
+++ b/roles/lib_openshift/src/doc/edit
@@ -0,0 +1,116 @@
+# flake8: noqa
+# pylint: skip-file
+
+DOCUMENTATION = '''
+---
+module: oc_edit
+short_description: Modify, and idempotently manage openshift objects.
+description:
+  - Modify openshift objects programmatically.
+options:
+  state:
+    description:
+    - Currently present is only supported state.
+    required: true
+    default: present
+    choices: ["present"]
+    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: []
+  kind:
+    description:
+    - The kind attribute of the object.
+    required: True
+    default: None
+    choices:
+    - bc
+    - buildconfig
+    - configmaps
+    - dc
+    - deploymentconfig
+    - imagestream
+    - imagestreamtag
+    - is
+    - istag
+    - namespace
+    - project
+    - projects
+    - node
+    - ns
+    - persistentvolume
+    - pv
+    - rc
+    - replicationcontroller
+    - routes
+    - scc
+    - secret
+    - securitycontextconstraints
+    - service
+    - svc
+    aliases: []
+  file_name:
+    description:
+    - The file name in which to edit
+    required: false
+    default: None
+    aliases: []
+  file_format:
+    description:
+    - The format of the file being edited.
+    required: false
+    default: yaml
+    aliases: []
+  content:
+    description:
+    - Content of the file
+    required: false
+    default: None
+    aliases: []
+  force:
+    description:
+    - Whether or not to force the operation
+    required: false
+    default: None
+    aliases: []
+  separator:
+    description:
+    - The separator format for the edit.
+    required: false
+    default: '.'
+    aliases: []
+author:
+- "Kenny Woodson <kwoodson@redhat.com>"
+extends_documentation_fragment: []
+'''
+
+EXAMPLES = '''
+oc_edit:
+  kind: rc
+  name: hawkular-cassandra-rc
+  namespace: openshift-infra
+  content:
+    spec.template.spec.containers[0].resources.limits.memory: 512
+    spec.template.spec.containers[0].resources.requests.memory: 256
+'''
diff --git a/roles/lib_openshift/src/doc/route b/roles/lib_openshift/src/doc/route
index 256f6b8f3..1797d4d33 100644
--- a/roles/lib_openshift/src/doc/route
+++ b/roles/lib_openshift/src/doc/route
@@ -3,10 +3,10 @@
 
 DOCUMENTATION = '''
 ---
-module: yedit
-short_description: Create, modify, and idempotently manage yaml files.
+module: oc_route
+short_description: Create, modify, and idempotently manage openshift routes.
 description:
-  - Modify yaml files programmatically.
+  - Manage openshift route objects programmatically.
 options:
   state:
     description:
-- 
cgit v1.2.3