ocf_heartbeat_NodeUtilization(7)

1OCF_HEARTBEAT_NODEUT(7)       OCF resource agents      OCF_HEARTBEAT_NODEUT(7)
2
3
4

NAME

6       ocf_heartbeat_NodeUtilization - Node Utilization
7

SYNOPSIS

9       NodeUtilization [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

12       The Node Utilization agent detects system parameters like available
13       CPU, host memory and hypervisor memory availability, and adds them into
14       the CIB for each node using crm_attribute. Run the agent as a clone
15       resource to have it populate these parameters on each node. Note:
16       Setting hv_memory only works with Xen at the moment, using the xl or xm
17       command line tools.
18

SUPPORTED PARAMETERS

20       dynamic
21           If set, parameters will be updated if there are differences between
22           the HA parameters and the system values when running the monitor
23           action. If not set, the parameters will be set once when the
24           resource instance starts.
25
26           (optional, boolean, default true)
27
28       utilization_cpu
29           Enable setting node CPU utilization limit.
30
31           (optional, boolean, default true)
32
33       utilization_cpu_reservation
34           Subtract this value when setting the CPU utilization parameter.
35
36           (optional, integer, default 1)
37
38       utilization_host_memory
39           Enable setting available host memory.
40
41           (optional, boolean, default true)
42
43       utilization_host_memory_reservation
44           Subtract this value when setting host memory utilization, in MB.
45
46           (optional, integer, default 512)
47
48       utilization_hv_memory
49           Enable setting available hypervisor memory.
50
51           (optional, boolean, default true)
52
53       utilization_hv_memory_reservation
54           Subtract this value when setting hypervisor memory utilization, in
55           MB.
56
57           (optional, integer, default 512)
58

SUPPORTED ACTIONS

60       This resource agent supports the following actions (operations):
61
62       start
63           Starts the resource. Suggested minimum timeout: 90s.
64
65       stop
66           Stops the resource. Suggested minimum timeout: 100s.
67
68       monitor
69           Performs a detailed status check. Suggested minimum timeout: 20s.
70           Suggested interval: 60s.
71
72       meta-data
73           Retrieves resource agent metadata (internal use only). Suggested
74           minimum timeout: 5s.
75
76       validate-all
77           Performs a validation of the resource configuration. Suggested
78           minimum timeout: 30s.
79

EXAMPLE CRM SHELL

81       The following is an example configuration for a NodeUtilization
82       resource using the crm(8) shell:
83
84           primitive p_NodeUtilization ocf:heartbeat:NodeUtilization \
85             op monitor timeout="20s" interval="60s"
86

EXAMPLE PCS

88       The following is an example configuration for a NodeUtilization
89       resource using pcs(8)
90
91           pcs resource create p_NodeUtilization ocf:heartbeat:NodeUtilization \
92             op monitor timeout="20s" interval="60s"
93

AUTHOR

98       ClusterLabs contributors (see the resource agent source for information
99       about individual authors)
100
101
102
103resource-agents UNKNOWN           01/25/2023           OCF_HEARTBEAT_NODEUT(7)