be left
-All informations about the cluster is passed using environment
+All information about the cluster is passed using environment
variables. Different operations will have sligthly different
environments, but most of the variables are common.
Adds a node to the cluster.
:directory: node-add
-:env. vars: NODE_NAME, NODE_PIP, NODE_SIP
+:env. vars: NODE_NAME, NODE_PIP, NODE_SIP, MASTER_CAPABLE, VM_CAPABLE
:pre-execution: all existing nodes
:post-execution: all nodes plus the new node
OP_REMOVE_NODE
++++++++++++++
-Removes a node from the cluster.
+Removes a node from the cluster. On the removed node the hooks are
+called during the execution of the operation and not after its
+completion.
:directory: node-remove
:env. vars: NODE_NAME
:pre-execution: all existing nodes except the removed node
-:post-execution: all existing nodes except the removed node
+:post-execution: all existing nodes
OP_NODE_SET_PARAMS
++++++++++++++++++
Changes a node's parameters.
:directory: node-modify
-:env. vars: MASTER_CANDIDATE, OFFLINE, DRAINED
+:env. vars: MASTER_CANDIDATE, OFFLINE, DRAINED, MASTER_CAPABLE, VM_CAPABLE
:pre-execution: master node, the target node
:post-execution: master node, the target node
+OP_NODE_EVACUATE
+++++++++++++++++
+
+Relocate secondary instances from a node.
+
+:directory: node-evacuate
+:env. vars: NEW_SECONDARY, NODE_NAME
+:pre-execution: master node, target node
+:post-execution: master node, target node
+
+OP_NODE_MIGRATE
+++++++++++++++++
+
+Relocate secondary instances from a node.
+
+:directory: node-migrate
+:env. vars: NODE_NAME
+:pre-execution: master node
+:post-execution: master node
+
+
+Node group operations
+~~~~~~~~~~~~~~~~~~~~~
+
+OP_ADD_GROUP
+++++++++++++
+
+Adds a node group to the cluster.
+
+:directory: group-add
+:env. vars: GROUP_NAME
+:pre-execution: master node
+:post-execution: master node
+
+OP_GROUP_SET_PARAMS
++++++++++++++++++++
+
+Changes a node group's parameters.
+
+:directory: group-modify
+:env. vars: GROUP_NAME, NEW_ALLOC_POLICY
+:pre-execution: master node
+:post-execution: master node
+
+OP_REMOVE_GROUP
++++++++++++++++
+
+Removes a node group from the cluster. Since the node group must be
+empty for removal to succeed, the concept of "nodes in the group" does
+not exist, and the hook is only executed in the master node.
+
+:directory: group-remove
+:env. vars: GROUP_NAME
+:pre-execution: master node
+:post-execution: master node
+
+OP_RENAME_GROUP
++++++++++++++++
+
+Renames a node group.
+
+:directory: group-rename
+:env. vars: OLD_NAME, NEW_NAME
+:pre-execution: master node and all nodes in the group
+:post-execution: master node and all nodes in the group
+
Instance operations
~~~~~~~~~~~~~~~~~~~
Exports the instance.
-
:directory: instance-export
-:env. vars: EXPORT_NODE, EXPORT_DO_SHUTDOWN
+:env. vars: EXPORT_MODE, EXPORT_NODE, EXPORT_DO_SHUTDOWN, REMOVE_INSTANCE
:pre-execution: master node, primary and secondary nodes
:post-execution: master node, primary and secondary nodes
Starts an instance.
:directory: instance-start
-:env. vars: INSTANCE_NAME, INSTANCE_PRIMARY, INSTANCE_SECONDARIES, FORCE
+:env. vars: FORCE
:pre-execution: master node, primary and secondary nodes
:post-execution: master node, primary and secondary nodes
Stops an instance.
-:directory: instance-shutdown
-:env. vars: INSTANCE_NAME, INSTANCE_PRIMARY, INSTANCE_SECONDARIES
+:directory: instance-stop
+:env. vars: TIMEOUT
:pre-execution: master node, primary and secondary nodes
:post-execution: master node, primary and secondary nodes
Reboots an instance.
:directory: instance-reboot
-:env. vars: IGNORE_SECONDARIES, REBOOT_TYPE
+:env. vars: IGNORE_SECONDARIES, REBOOT_TYPE, SHUTDOWN_TIMEOUT
:pre-execution: master node, primary and secondary nodes
:post-execution: master node, primary and secondary nodes
Modifies the instance parameters.
:directory: instance-modify
-:env. vars: INSTANCE_NAME, MEM_SIZE, VCPUS, INSTANCE_IP
+:env. vars: NEW_DISK_TEMPLATE
:pre-execution: master node, primary and secondary nodes
:post-execution: master node, primary and secondary nodes
OP_INSTANCE_FAILOVER
++++++++++++++++++++
-Failovers an instance.
+Failovers an instance. In the post phase INSTANCE_PRIMARY and
+INSTANCE_SECONDARIES refer to the nodes that were repectively primary
+and secondary before failover.
:directory: instance-failover
-:env. vars: IGNORE_CONSISTENCY
+:env. vars: IGNORE_CONSISTENCY, SHUTDOWN_TIMEOUT, OLD_PRIMARY, OLD_SECONDARY, NEW_PRIMARY, NEW_SECONDARY
:pre-execution: master node, secondary node
-:post-execution: master node, secondary node
+:post-execution: master node, primary and secondary nodes
OP_INSTANCE_MIGRATE
++++++++++++++++++++
-Migrates an instance.
+Migrates an instance. In the post phase INSTANCE_PRIMARY and
+INSTANCE_SECONDARIES refer to the nodes that were repectively primary
+and secondary before migration.
-:directory: instance-failover
-:env. vars: INSTANCE_MIGRATE_LIVE, INSTANCE_MIGRATE_CLEANUP
+:directory: instance-migrate
+:env. vars: MIGRATE_LIVE, MIGRATE_CLEANUP, OLD_PRIMARY, OLD_SECONDARY, NEW_PRIMARY, NEW_SECONDARY
:pre-execution: master node, secondary node
-:post-execution: master node, secondary node
+:post-execution: master node, primary and secondary nodes
OP_INSTANCE_REMOVE
Remove an instance.
:directory: instance-remove
-:env. vars: INSTANCE_NAME, INSTANCE_PRIMARY, INSTANCE_SECONDARIES
+:env. vars: SHUTDOWN_TIMEOUT
:pre-execution: master node
-:post-execution: master node
+:post-execution: master node, primary and secondary nodes
OP_INSTANCE_REPLACE_DISKS
+++++++++++++++++++++++++
:directory: disk-grow
:env. vars: DISK, AMOUNT
-:pre-execution: master node, primary node
-:post-execution: master node, primary node
+:pre-execution: master node, primary and secondary nodes
+:post-execution: master node, primary and secondary nodes
OP_INSTANCE_RENAME
++++++++++++++++++
:pre-execution: master node, primary and secondary nodes
:post-execution: master node, primary and secondary nodes
+OP_INSTANCE_MOVE
+++++++++++++++++
+
+Move an instance by data-copying.
+
+:directory: instance-move
+:env. vars: TARGET_NODE, SHUTDOWN_TIMEOUT
+:pre-execution: master node, primary and target nodes
+:post-execution: master node, primary and target nodes
+
+OP_INSTANCE_RECREATE_DISKS
+++++++++++++++++++++++++++
+
+Recreate an instance's missing disks.
+
+:directory: instance-recreate-disks
+:env. vars: only the standard instance vars
+:pre-execution: master node, primary and secondary nodes
+:post-execution: master node, primary and secondary nodes
+
+OP_INSTANCE_REPLACE_DISKS
++++++++++++++++++++++++++
+
+Replace the disks of an instance.
+
+:directory: mirrors-replace
+:env. vars: MODE, NEW_SECONDARY, OLD_SECONDARY
+:pre-execution: master node, primary and new secondary nodes
+:post-execution: master node, primary and new secondary nodes
+
+
Cluster operations
~~~~~~~~~~~~~~~~~~
+OP_POST_INIT_CLUSTER
+++++++++++++++++++++
+
+This hook is called via a special "empty" LU right after cluster
+initialization.
+
+:directory: cluster-init
+:env. vars: none
+:pre-execution: none
+:post-execution: master node
+
+OP_DESTROY_CLUSTER
+++++++++++++++++++
+
+The post phase of this hook is called during the execution of destroy
+operation and not after its completion.
+
+:directory: cluster-destroy
+:env. vars: none
+:pre-execution: none
+:post-execution: master node
+
OP_CLUSTER_VERIFY
+++++++++++++++++
cluster verification procedure.
:directory: cluster-verify
-:env. vars: CLUSTER, MASTER
+:env. vars: CLUSTER, MASTER, CLUSTER_TAGS, NODE_TAGS_<name>
:pre-execution: none
:post-execution: all nodes
INSTANCE_NAME
The name of the instance which is the target of the operation.
+INSTANCE_BE_x,y,z,...
+ Instance BE params. There is one variable per BE param. For instance, GANETI_INSTANCE_BE_auto_balance
+
INSTANCE_DISK_TEMPLATE
The disk type for the instance.
+NEW_DISK_TEMPLATE
+ The new disk type for the instance.
+
INSTANCE_DISK_COUNT
The number of disks for the instance.
INSTANCE_DISKn_MODE
Either *rw* for a read-write disk or *ro* for a read-only one.
+INSTANCE_HV_x,y,z,...
+ Instance hypervisor options. There is one variable per option. For instance, GANETI_INSTANCE_HV_use_bootloader
+
+INSTANCE_HYPERVISOR
+ The instance hypervisor.
+
INSTANCE_NIC_COUNT
The number of NICs for the instance.
INSTANCE_NICn_MAC
The MAC address of the *n* -th NIC of the instance.
+INSTANCE_NICn_MODE
+ The mode of the *n* -th NIC of the instance.
+
INSTANCE_OS_TYPE
The name of the instance OS.
INSTANCE_PRIMARY
- The name of the node which is the primary for the instance.
+ The name of the node which is the primary for the instance. Note that
+ for migrations/failovers, you shouldn't rely on this variable since
+ the nodes change during the exectution, but on the
+ OLD_PRIMARY/NEW_PRIMARY values.
INSTANCE_SECONDARIES
- Space-separated list of secondary nodes for the instance.
+ Space-separated list of secondary nodes for the instance. Note that
+ for migrations/failovers, you shouldn't rely on this variable since
+ the nodes change during the exectution, but on the
+ OLD_SECONDARY/NEW_SECONDARY values.
INSTANCE_MEMORY
The memory size (in MiBs) of the instance.
INSTANCE_STATUS
The run status of the instance.
+MASTER_CAPABLE
+ Whether a node is capable of being promoted to master.
+
+VM_CAPABLE
+ Whether the node can host instances.
+
NODE_NAME
The target node of this operation (not the node on which the hook
runs).
NEW_SECONDARY
The name of the node on which the new mirror component is being
- added. This can be the name of the current secondary, if the new
- mirror is on the same secondary.
+ added (for replace disk). This can be the name of the current
+ secondary, if the new mirror is on the same secondary. For
+ migrations/failovers, this is the old primary node.
OLD_SECONDARY
- The name of the old secondary in the replace-disks command Note that
+ The name of the old secondary in the replace-disks command. Note that
this can be equal to the new secondary if the secondary node hasn't
- actually changed.
+ actually changed. For migrations/failovers, this is the new primary
+ node.
+
+OLD_PRIMARY, NEW_PRIMARY
+ For migrations/failovers, the old and respectively new primary
+ nodes. These two mirror the NEW_SECONDARY/OLD_SECONDARY variables
+
+EXPORT_MODE
+ The instance export mode. Either "remote" or "local".
EXPORT_NODE
The node on which the exported image of the instance was done.
the filesystem would need a check (journal replay or full fsck) in
order to guarantee consistency.
+REMOVE_INSTANCE
+ Whether the instance was removed from the node.
+
+SHUTDOWN_TIMEOUT
+ Amount of time to wait for the instance to shutdown.
+
+TIMEOUT
+ Amount of time to wait before aborting the op.
+
+OLD_NAME, NEW_NAME
+ Old/new name of the node group.
+
+GROUP_NAME
+ The name of the node group.
+
+NEW_ALLOC_POLICY
+ The new allocation policy for the node group.
+
+CLUSTER_TAGS
+ The list of cluster tags, space separated.
+
+NODE_TAGS_<name>
+ The list of tags for node *<name>*, space separated.
+
Examples
--------
GANETI_OBJECT_TYPE=INSTANCE
GANETI_OP_CODE=OP_INSTANCE_STARTUP
GANETI_OP_TARGET=instance2.example.com
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: