diff options
author | Kenny Woodson <kwoodson@redhat.com> | 2017-01-19 12:24:52 -0500 |
---|---|---|
committer | Kenny Woodson <kwoodson@redhat.com> | 2017-01-20 11:52:10 -0500 |
commit | 6218b9938b523c545a7610a3c77d6a19aea81e1a (patch) | |
tree | b98fa3931aff326c10fec573c442e283d3d6f9bf /roles/lib_openshift/src/doc | |
parent | 836bd8115c7d9386b9f5d3d6cca41785853c16c7 (diff) | |
download | openshift-6218b9938b523c545a7610a3c77d6a19aea81e1a.tar.gz openshift-6218b9938b523c545a7610a3c77d6a19aea81e1a.tar.bz2 openshift-6218b9938b523c545a7610a3c77d6a19aea81e1a.tar.xz openshift-6218b9938b523c545a7610a3c77d6a19aea81e1a.zip |
Adding 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 +''' |