Fix confd procotol design description

[ganeti-local] / doc / hooks.rst

diff --git a/doc/hooks.rst b/doc/hooks.rst
index 03de7b9..4b46009 100644 (file)
--- a/doc/hooks.rst
+++ b/doc/hooks.rst
@@ -128,8 +128,9 @@ Adds a node to the cluster.
 OP_REMOVE_NODE
 ++++++++++++++
 
-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.
+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
@@ -206,7 +207,6 @@ OP_BACKUP_EXPORT
 
 Exports the instance.
 
-
 :directory: instance-export
 :env. vars: EXPORT_NODE, EXPORT_DO_SHUTDOWN
 :pre-execution: master node, primary and secondary nodes
@@ -218,7 +218,7 @@ OP_INSTANCE_START
 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
 
@@ -228,7 +228,7 @@ OP_INSTANCE_SHUTDOWN
 Stops an instance.
 
 :directory: instance-stop
-:env. vars: INSTANCE_NAME, INSTANCE_PRIMARY, INSTANCE_SECONDARIES
+:env. vars: only the standard instance vars
 :pre-execution: master node, primary and secondary nodes
 :post-execution: master node, primary and secondary nodes
 
@@ -248,14 +248,16 @@ OP_INSTANCE_MODIFY
 Modifies the instance parameters.
 
 :directory: instance-modify
-:env. vars: INSTANCE_NAME, MEM_SIZE, VCPUS, INSTANCE_IP
+: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_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
@@ -265,10 +267,12 @@ Failovers an instance.
 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-migrate
-:env. vars: INSTANCE_MIGRATE_LIVE, INSTANCE_MIGRATE_CLEANUP
+:env. vars: MIGRATE_LIVE, MIGRATE_CLEANUP
 :pre-execution: master node, secondary node
 :post-execution: master node, secondary node
 
@@ -279,7 +283,7 @@ OP_INSTANCE_REMOVE
 Remove an instance.
 
 :directory: instance-remove
-:env. vars: INSTANCE_NAME, INSTANCE_PRIMARY, INSTANCE_SECONDARIES
+:env. vars: only the standard instance vars
 :pre-execution: master node
 :post-execution: master node
 
@@ -350,7 +354,8 @@ Cluster operations
 OP_POST_INIT_CLUSTER
 ++++++++++++++++++++
 
-This hook is called via a special "empty" LU right after cluster initialization.
+This hook is called via a special "empty" LU right after cluster
+initialization.
 
 :directory: cluster-init
 :env. vars: none
@@ -360,8 +365,8 @@ This hook is called via a special "empty" LU right after cluster initialization.
 OP_DESTROY_CLUSTER
 ++++++++++++++++++
 
-The post phase of this hook is called during the execution of destroy operation
-and not after its completion.
+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