Commit 2dd83bef authored by Jose A. Lopes's avatar Jose A. Lopes

Document '--user-shutdown' cluster parameter

... and fix a typo.
Signed-off-by: default avatarJose A. Lopes <jabolopes@google.com>
Reviewed-by: default avatarHelga Velroyen <helgav@google.com>
parent 44b5876a
...@@ -202,6 +202,7 @@ INIT ...@@ -202,6 +202,7 @@ INIT
| [\--hypervisor-state *hvstate*] | [\--hypervisor-state *hvstate*]
| [\--drbd-usermode-helper *helper*] | [\--drbd-usermode-helper *helper*]
| [\--enabled-disk-templates *template* [,*template*...]] | [\--enabled-disk-templates *template* [,*template*...]]
| [\--user-shutdown {yes \| no}]
| {*clustername*} | {*clustername*}
This commands is only run once initially on the first node of the This commands is only run once initially on the first node of the
...@@ -310,6 +311,13 @@ Either a single hypervisor name or a comma-separated list of ...@@ -310,6 +311,13 @@ Either a single hypervisor name or a comma-separated list of
hypervisor names can be specified. If this option is not specified, hypervisor names can be specified. If this option is not specified,
only the xen-pvm hypervisor is enabled by default. only the xen-pvm hypervisor is enabled by default.
The ``--user-shutdown`` option enables or disables user shutdown
detection at the cluster level. User shutdown detection allows users to
initiate instance poweroff from inside the instance, and Ganeti will
report the instance status as 'USER_down' (as opposed, to 'ERROR_down')
and the watcher will not restart these instances, thus preserving their
instance status.
The ``-H (--hypervisor-parameters)`` option allows you to set default The ``-H (--hypervisor-parameters)`` option allows you to set default
hypervisor specific parameters for the cluster. The format of this hypervisor specific parameters for the cluster. The format of this
option is the name of the hypervisor, followed by a colon and a option is the name of the hypervisor, followed by a colon and a
...@@ -660,6 +668,7 @@ MODIFY ...@@ -660,6 +668,7 @@ MODIFY
| [\--drbd-usermode-helper *helper*] | [\--drbd-usermode-helper *helper*]
| [\--file-storage-dir *dir*] | [\--file-storage-dir *dir*]
| [\--shared-file-storage-dir *dir*] | [\--shared-file-storage-dir *dir*]
| [\--user-shutdown {yes \| no}]
Modify the options for the cluster. Modify the options for the cluster.
...@@ -670,7 +679,8 @@ The ``--vg-name``, ``--enabled-hypervisors``, ``-H (--hypervisor-parameters)``, ...@@ -670,7 +679,8 @@ The ``--vg-name``, ``--enabled-hypervisors``, ``-H (--hypervisor-parameters)``,
``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``, ``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``,
``--master-netdev``, ``--master-netmask``, ``--use-external-mip-script``, ``--master-netdev``, ``--master-netmask``, ``--use-external-mip-script``,
``--drbd-usermode-helper``, ``--file-storage-dir``, ``--drbd-usermode-helper``, ``--file-storage-dir``,
``--shared-file-storage-dir``, and ``--enabled-disk-templates`` options are ``--shared-file-storage-dir``, ``--enabled-disk-templates``, and
``--user-shutdown`` options are
described in the **init** command. described in the **init** command.
The ``--hypervisor-state`` and ``--disk-state`` options are described in The ``--hypervisor-state`` and ``--disk-state`` options are described in
......
...@@ -822,9 +822,9 @@ vnet\_hdr ...@@ -822,9 +822,9 @@ vnet\_hdr
It is set to ``true`` by default. It is set to ``true`` by default.
The ``-O (--os-parameters)`` option allows customisation of the OS The ``-O (--os-parameters)`` option allows customisation of the OS
parameters. The actual parameter names and values depends on the OS parameters. The actual parameter names and values depend on the OS being
being used, but the syntax is the same key=value. For example, setting used, but the syntax is the same key=value. For example, setting a
a hypothetical ``dhcp`` parameter to yes can be achieved by:: hypothetical ``dhcp`` parameter to yes can be achieved by::
gnt-instance add -O dhcp=yes ... gnt-instance add -O dhcp=yes ...
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment