summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc/csr
blob: db72dbda38583b84854d6c66e48de74f4477f032 (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# flake8: noqa
# pylint: skip-file

DOCUMENTATION = '''
---
module: oc_adm_csr
short_description: Module to approve or deny openshift certificate signing requests
description:
  - Wrapper around the openshift `oc adm certificate approve|deny <csr>` command.
options:
  state:
    description:
    - approve|deny|list Approve, deny, and list are the only supported states for certificates
    required: false
    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: []
  nodes:
    description:
    - A list of the names of the nodes in which to accept the certificates
    required: false
    default: None
    aliases: []
  timeout:
    description:
    - This flag allows for a timeout value when approving nodes.
    required: false
    default: 30
    aliases: []
  timeout:
    description:
    - This flag allows for a timeout value when doing node approvals.
    - A zero value for the timeout will block until the nodes have been accepted
    required: false
    default: 30
    aliases: []
  approve_all:
    description:
    - This flag allows for the module to approve all CSRs that are found.
    - This facilitates testing.
    required: false
    default: False
    aliases: []
  service_account:
    description:
    - This parameter tells the approval process which service account is being used for the requests
    required: false
    default: node-bootstrapper
    aliases: []
author:
- "Kenny Woodson <kwoodson@redhat.com>"
extends_documentation_fragment: []
'''

EXAMPLES = '''
- name: Approve certificates for node xyz
  oc_adm_scr:
    nodes:
    - xyz
    timeout: 300

- name: Approve certificates for node xyz
  oc_adm_scr:
    nodes:
    - xyz
    timeout: 0
'''