summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc/manage_node
blob: b651ea4e799f26aee860dc8e62f0b3910d0063f1 (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
81
82
83
84
85
86
87
88
# flake8: noqa
# pylint: skip-file

DOCUMENTATION = '''
---
module: oc_adm_manage_node
short_description: Module to manage openshift nodes
description:
  - Manage openshift nodes programmatically.
options:
  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: []
  node:
    description:
    - A list of the nodes being managed
    required: false
    default: None
    aliases: []
  selector:
    description:
    - The selector when filtering on node labels
    required: false
    default: None
    aliases: []
  pod_selector:
    description:
    - A selector when filtering on pod labels.
    required: false
    default: None
    aliases: []
  evacuate:
    description:
    - Remove all pods from a node.
    required: false
    default: False
    aliases: []
  schedulable:
    description:
    - whether or not openshift can schedule pods on this node
    required: False
    default: None
    aliases: []
  dry_run:
    description:
    - This shows the pods that would be migrated if evacuate were called
    required: False
    default: False
    aliases: []
  grace_period:
    description:
    - Grace period (seconds) for pods being deleted.
    required: false
    default: None
    aliases: []
  force:
    description:
    - Whether or not to attempt to force this action in openshift
    required: false
    default: None
    aliases: []
author:
- "Kenny Woodson <kwoodson@redhat.com>"
extends_documentation_fragment: []
'''

EXAMPLES = '''
- name: oadm manage-node --schedulable=true --selector=ops_node=new
  oc_adm_manage_node:
    selector: ops_node=new
    schedulable: True
  register: schedout

- name: oadm manage-node my-k8s-node-5 --evacuate
  oc_adm_manage_node:
    node:  my-k8s-node-5
    evacuate: True
    force: True
'''