summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc/version
blob: c0fdd53e7f931f7f7a8045bf442d540d0cafe968 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
'''