1OCF_HEARTBEAT_XEN(7) OCF resource agents OCF_HEARTBEAT_XEN(7)
2
6 ocf_heartbeat_Xen - Manages Xen unprivileged domains (DomUs)
7
9 Xen [start | stop | monitor | migrate_to | migrate_from | meta-data |
10 validate-all]
11
13 Resource Agent for the Xen Hypervisor. Manages Xen virtual machine
14 instances by mapping cluster resource start and stop, to Xen create and
15 shutdown, respectively.
16 A note on names
18 We will try to extract the name from the config file (the xmfile
20 attribute). If you use a simple assignment statement, then you should
21 be fine. Otherwise, if there's some python acrobacy involved such as
22 dynamically assigning names depending on other variables, and we will
23 try to detect this, then please set the name attribute. You should also
24 do that if there is any chance of a pathological situation where a
25 config file might be missing, for example if it resides on a shared
26 storage. If all fails, we finally fall back to the instance id to
27 preserve backward compatibility.
28 Para-virtualized guests can also be migrated by enabling the
30 meta_attribute allow-migrate.
31 This resource agent may be configured for native migration if available
33 in the cluster manager. For Pacemaker, the allow-migrate="true" meta
34 attribute enables native migration.
35
37 xmfile
38 Absolute path to the Xen control file, for this virtual machine.
39 (required, string, default "/etc/xen/vm/MyDomU")
41 name
43 Name of the virtual machine.
44 (optional, string, no default)
46 shutdown_timeout
48 The Xen agent will first try an orderly shutdown using xl shutdown.
49 Should this not succeed within this timeout, the agent will
50 escalate to xl destroy, forcibly killing the node.
51 If this is not set, it will default to two-third of the stop action
53 timeout.
54 Setting this value to 0 forces an immediate destroy.
56 (optional, string, no default)
58 shutdown_acpi
60 Handle shutdown by simulating an ACPI power button event. Enable
61 this to allow graceful shutdown for HVM domains without installed
62 PV drivers.
63 (optional, boolean, default 0)
65 allow_mem_management
67 This parameter enables dynamic adjustment of memory for start and
68 stop actions used for Dom0 and the DomUs. The default is to not
69 adjust memory dynamically.
70 (optional, boolean, default 0)
72 node_ip_attribute
74 In case of a live migration, the system will default to using the
75 IP address associated with the hostname via DNS or /etc/hosts.
76 This parameter allows you to specify a node attribute that will be
78 queried instead for the target node, overriding the IP address.
79 This allows you to use a dedicated network for live migration
80 traffic to a specific node.
81 Warning: make very sure the IP address does point to the right
83 node. Or else the live migration will end up somewhere else,
84 greatly confusing the cluster and causing havoc.
85 (optional, string, no default)
87 reserved_Dom0_memory
89 In case memory management is used, this parameter defines the
90 minimum amount of memory to be reserved for the dom0. The default
91 minimum memory is 512MB.
92 (optional, string, default "512")
94 autoset_utilization_cpu
96 If set true, the agent will detect the number of domain's vCPUs
97 from Xen, and put it into the CPU utilization of the resource when
98 the monitor is executed. Before enabling make sure node utilization
99 is also set (using NodeUtilization agent or manually) or the
100 resource might not be able to start anywhere.
101 (optional, boolean, default false)
103 autoset_utilization_hv_memory
105 If set true, the agent will detect the number of memory from Xen,
106 and put it into the hv_memory utilization of the resource when the
107 monitor is executed. Before enabling make sure node utilization is
108 also set (using NodeUtilization agent or manually) or the resource
109 might not be able to start anywhere.
110 (optional, boolean, default false)
112 monitor_scripts
114 To additionally monitor services within the unprivileged domain,
115 add this parameter with a list of scripts to monitor.
116 (optional, string, no default)
118
120 This resource agent supports the following actions (operations):
121 start
123 Starts the resource. Suggested minimum timeout: 60s.
124 stop
126 Stops the resource. Suggested minimum timeout: 40s.
127 migrate_from
129 Executes steps necessary for migrating the resource away from the
130 node. Suggested minimum timeout: 120s.
131 migrate_to
133 Executes steps necessary for migrating the resource to the node.
134 Suggested minimum timeout: 120s.
135 monitor
137 Performs a detailed status check. Suggested minimum timeout: 30s.
138 Suggested interval: 10s.
139 meta-data
141 Retrieves resource agent metadata (internal use only). Suggested
142 minimum timeout: 5s.
143 validate-all
145 Performs a validation of the resource configuration. Suggested
146 minimum timeout: 5s.
147
149 The following is an example configuration for a Xen resource using the
150 crm(8) shell:
151 primitive p_Xen ocf:heartbeat:Xen \
153 params \
154 xmfile="/etc/xen/vm/MyDomU" \
155 meta allow-migrate="true" \
156 op monitor depth="0" timeout="30s" interval="10s"
157
159 The following is an example configuration for a Xen resource using
160 pcs(8)
161 pcs resource create p_Xen ocf:heartbeat:Xen \
163 xmfile="/etc/xen/vm/MyDomU" \
164 op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s"
165
167 http://clusterlabs.org/
168
170 ClusterLabs contributors (see the resource agent source for information
171 about individual authors)
172resource-agents UNKNOWN 01/25/2023 OCF_HEARTBEAT_XEN(7)