diff options
author | Kenny Woodson <kwoodson@redhat.com> | 2017-01-20 14:02:56 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-01-20 14:02:56 -0500 |
commit | 30b1000c0f8a7347937eb9b02554e5126864a2b5 (patch) | |
tree | db8180b10e442e35804c1184bbc800169528f10a /roles/lib_openshift/src/doc | |
parent | 746ddd2d48c5fb738ccd80a16ca0a5a66676b6c2 (diff) | |
parent | 6218b9938b523c545a7610a3c77d6a19aea81e1a (diff) | |
download | openshift-30b1000c0f8a7347937eb9b02554e5126864a2b5.tar.gz openshift-30b1000c0f8a7347937eb9b02554e5126864a2b5.tar.bz2 openshift-30b1000c0f8a7347937eb9b02554e5126864a2b5.tar.xz openshift-30b1000c0f8a7347937eb9b02554e5126864a2b5.zip |
Merge pull request #3130 from kwoodson/lib_openshift_version
Adding oc_version to lib_openshift.
Diffstat (limited to 'roles/lib_openshift/src/doc')
-rw-r--r-- | roles/lib_openshift/src/doc/version | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/version b/roles/lib_openshift/src/doc/version new file mode 100644 index 000000000..c0fdd53e7 --- /dev/null +++ b/roles/lib_openshift/src/doc/version @@ -0,0 +1,40 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_version +short_description: Return the current openshift version +description: + - Return the openshift installed version. `oc version` +options: + state: + description: + - Currently list is only supported state. + required: true + default: list + choices: ["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: [] +author: +- "Kenny Woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +oc_version: +- name: get oc version + oc_version: + register: oc_version +''' |