Merge pull request #3758 from kwoodson/ocimage

Merged by openshift-bot

1 files changed, 75 insertions, 0 deletions

diff --git a/roles/lib_openshift/src/doc/image b/roles/lib_openshift/src/doc/image
new file mode 100644
index 000000000..18cf4e168
--- /dev/null
+++ b/roles/lib_openshift/src/doc/image
@@ -0,0 +1,75 @@
+# flake8: noqa
+# pylint: skip-file
+
+DOCUMENTATION = '''
+---
+module: oc_image
+short_description: Create, modify, and idempotently manage openshift labels.
+description:
+  - Modify openshift labels 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
+    default: present
+    choices: ["present", "list"]
+    aliases: []
+  kubeconfig:
+    description:
+    - The path for the kubeconfig file to use for authentication
+    required: false
+    default: /etc/origin/master/admin.kubeconfig
+    aliases: []
+  namespace:
+    description:
+    - The namespace where this object lives
+    required: false
+    default: default
+    aliases: []
+  debug:
+    description:
+    - Turn on debug output.
+    required: false
+    default: False
+    aliases: []
+  registry_url:
+    description:
+    - The url for the registry so that openshift can pull the image
+    required: false
+    default: None
+    aliases: []
+  image_name:
+    description:
+    - The name of the image being imported
+    required: false
+    default: False
+    aliases: []
+  image_tag:
+    description:
+    - The tag of the image being imported
+    required: false
+    default: None
+    aliases: []
+author:
+- "Ivan Horvath<ihorvath@redhat.com>"
+extends_documentation_fragment: []
+'''
+
+EXAMPLES = '''
+- name: Get an imagestream
+  oc_image:
+    name: php55
+    state: list
+  register: imageout
+
+- name: create an imagestream
+  oc_image:
+    state: present
+    image_name: php55
+    image_tag: int
+    registry_url: registry.example.com
+    namespace: default
+  register: imageout
+'''