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

DOCUMENTATION = '''
---
module: oc_label
short_description: Create, modify, and idempotently manage openshift object labels.
description:
  - Modify openshift labels programmatically.
options:
  state:
    description:
    - State represents whether to create, modify, delete, or list
    required: true
    default: present
    choices: ["present", "absent", "list", "add"]
    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: []
  kind:
    description:
    - The kind of object that can be managed.
    required: false
    default: None
    choices:
    - node
    - pod
    aliases: []
  labels:
    description:
    - The labels to add to the resource.
    required: false
    default: None
    aliases: []
  selector:
    description:
    - The selector to apply to the query
    required: false
    default: None
    aliases: []
author:
- "Joel Diaz <jdiaz@redhat.com>"
extends_documentation_fragment: []
'''

EXAMPLES = '''
- name: Add label to node
  oc_label:
    name: ip-172-31-5-23.ec2.internal
    state: add
    kind: node
    labels:
      - key: logging-infra-fluentd
        value: 'true'
'''