summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc/serviceaccount
blob: b2eafab51de5f81a88df68f24d62c8435ece958c (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
# flake8: noqa
# pylint: skip-file

DOCUMENTATION = '''
---
module: oc_serviceaccount
short_description: Module to manage openshift service accounts
description:
  - Manage openshift service accounts programmatically.
options:
  state:
    description:
    - If present, the service account will be created if it doesn't exist or updated if different. If absent, the service account will be removed if present. If list, information about the service account will be gathered and returned as part of the Ansible call results.
    required: false
    default: present
    choices: ["present", "absent", "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: []
  name:
    description:
    - Name of the service account.
    required: true
    default: None
    aliases: []
  namespace:
    description:
    - Namespace of the service account.
    required: true
    default: default
    aliases: []
  secrets:
    description:
    - A list of secrets that are associated with the service account.
    required: false
    default: None
    aliases: []
  image_pull_secrets:
    description:
    - A list of the image pull secrets that are associated with the service account.
    required: false
    default: None
    aliases: []
author:
- "Kenny Woodson <kwoodson@redhat.com>"
extends_documentation_fragment: []
'''

EXAMPLES = '''
- name: create registry serviceaccount
  oc_serviceaccount:
    name: registry
    namespace: default
    secrets:
    - docker-registry-config
    - registry-secret
  register: sa_out
'''