Commit 13ddcb50 authored by Michael Hanselmann's avatar Michael Hanselmann

Document "--submit" in ganeti.7

Like “--priority” and “--dry-run”, the “--submit” option is available
for many commands and can be documented in a central place. This patch
also fixes a small number of style issues.
Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
Reviewed-by: default avatarIustin Pop <iustin@google.com>
parent 4faa4861
......@@ -225,7 +225,8 @@ Many Ganeti commands provide the following options. The
availability for a certain command can be checked by calling the
command using the ``--help`` option.
**gnt-...** *command* [\--dry-run] [\--priority {low | normal | high}]
| **gnt-...** *command* [\--dry-run] [\--priority {low | normal | high}]
| [\--submit]
The ``--dry-run`` option can be used to check whether an operation
would succeed.
......@@ -233,6 +234,10 @@ would succeed.
The option ``--priority`` sets the priority for opcodes submitted
by the command.
The ``--submit`` option is used to send the job to the master daemon but
not wait for its completion. The job ID will be shown so that it can be
examined using **gnt-job info**.
Defaults
~~~~~~~~
......
......@@ -661,9 +661,8 @@ master node to the other nodes in the cluster. This is normally not
needed, but can be run if the **verify** complains about
configuration mismatches.
The ``--submit`` option is used to send the job to the master
daemon but not wait for its completion. The job ID will be shown so
that it can be examined via **gnt-job info**.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
REMOVE-TAGS
~~~~~~~~~~~
......
......@@ -628,14 +628,12 @@ blktap
better performance. Especially if you use a network file system
(e.g. NFS) to store your instances this is the recommended choice.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Example::
# gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
......@@ -761,12 +759,11 @@ before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
kvm process for KVM, etc.). By default two minutes are given to each
instance to stop.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
The ``--force`` option is used to skip the interactive confirmation.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Example::
# gnt-instance remove instance1.example.com
......@@ -927,13 +924,12 @@ fails if the instance was not in the ``offline`` state, otherwise it
changes instance's state to ``down``. These modifications take effect
immediately.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Most of the changes take effect at the next restart. If the instance is
running, there is no effect on the instance.
......@@ -962,9 +958,8 @@ arguments or by using the ``--node``, ``--primary``, ``--secondary``
or ``--all`` options), the user must pass the ``--force-multiple``
options to skip the interactive confirmation.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
RENAME
^^^^^^
......@@ -985,9 +980,8 @@ that the resolved name matches the provided name. Since the name check
is used to compute the IP address, if you pass this option you must also
pass the ``--no-ip-check`` option.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Starting/stopping/connecting to console
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -1075,16 +1069,16 @@ and the instance instance2 with 2GB of RAM (this time only, unless
that is the actual instance memory size already). Note that the values
override the instance parameters (and not extend them): an instance
with "kernel\_args=ro" when started with -H kernel\_args=single will
result in "single", not "ro single". The ``--submit`` option is used
to send the job to the master daemon but not wait for its
completion. The job ID will be shown so that it can be examined via
**gnt-job info**.
result in "single", not "ro single".
The ``--paused`` option is only valid for Xen and kvm hypervisors. This
pauses the instance at the start of bootup, awaiting ``gnt-instance
console`` to unpause it, allowing the entire boot process to be
monitored for debugging.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Example::
# gnt-instance start instance1.example.com
......@@ -1118,10 +1112,6 @@ The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
``--sec-node-tags`` options are similar as for the **startup** command
and they influence the actual instances being shutdown.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
``--ignore-offline`` can be used to ignore offline primary nodes and
force the instance to be marked as stopped. This option should be used
with care as it can lead to an inconsistent cluster state.
......@@ -1135,6 +1125,9 @@ you just need to disable the watcher, shutdown all instances with
``--no-remember``, and when the watcher is activated again it will
restore the correct runtime state for all instances.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Example::
# gnt-instance shutdown instance1.example.com
......@@ -1177,6 +1170,9 @@ to stop.
The ``--force-multiple`` will skip the interactive confirmation in the
case the more than one instance will be affected.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Example::
# gnt-instance reboot instance1.example.com
......@@ -1242,16 +1238,15 @@ selected automatically by the specified allocator plugin, otherwise
the new secondary node will be the one chosen manually via the
``--new-secondary`` option.
Note that it is not possible to select an offline or drained node as a
new secondary.
The fourth form (when using ``--auto``) will automatically determine
which disks of an instance are faulty and replace them within the same
node. The ``--auto`` option works only when an instance has only
faulty disks on either the primary or secondary node; it doesn't work
when both sides have faulty disks.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
The ``--early-release`` changes the code so that the old storage on
secondary node(s) is removed early (before the resync is completed)
and the internal Ganeti locks for the current (and new, if any)
......@@ -1265,8 +1260,8 @@ The ``--ignore-ipolicy`` let the command ignore instance policy
violations if replace-disks changes groups and the instance would
violate the new groups instance policy.
Note that it is not possible to select an offline or drained node as a
new secondary.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
ACTIVATE-DISKS
^^^^^^^^^^^^^^
......@@ -1284,10 +1279,7 @@ In this example, *node1.example.com* is the name of the node on which
the devices have been activated. The *disk/0* and *disk/1* are the
Ganeti-names of the instance disks; how they are visible inside the
instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
actual block devices as visible on the node. The ``--submit`` option
is used to send the job to the master daemon but not wait for its
completion. The job ID will be shown so that it can be examined via
**gnt-job info**.
actual block devices as visible on the node.
The ``--ignore-size`` option can be used to activate disks ignoring
the currently configured size in Ganeti. This can be used in cases
......@@ -1299,6 +1291,9 @@ when activate-disks fails without it.
Note that it is safe to run this command while the instance is already
running.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
DEACTIVATE-DISKS
^^^^^^^^^^^^^^^^
......@@ -1317,15 +1312,14 @@ option passed it will skip this check and directly try to deactivate
the disks. This can still fail due to the instance actually running or
other issues.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
GROW-DISK
^^^^^^^^^
**grow-disk** [\--no-wait-for-sync] [\--submit] {*instance*} {*disk*}
{*amount*}
| **grow-disk** [\--no-wait-for-sync] [\--submit] {*instance*} {*disk*}
| {*amount*}
Grows an instance's disk. This is only possible for instances having a
plain, drbd or rbd disk template.
......@@ -1356,9 +1350,8 @@ create problems (except for unused space).
If you do not want gnt-instance to wait for the new disk region to be
synced, use the ``--no-wait-for-sync`` option.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Example (increase the first disk for instance1 by 16GiB)::
......@@ -1398,9 +1391,8 @@ passed must equal the number of nodes that the instance currently
has. Note that changing nodes is only allowed when all disks are
replaced, e.g. when no ``--disk`` option is passed.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Recovery
~~~~~~~~
......@@ -1440,13 +1432,12 @@ before forcing the shutdown (xm destroy in xen, killing the kvm
process, for kvm). By default two minutes are given to each instance
to stop.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Example::
# gnt-instance failover instance1.example.com
......@@ -1537,9 +1528,9 @@ Example (and expected output)::
MOVE
^^^^
**move** [-f] [\--ignore-consistency]
[-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
{*instance*}
| **move** [-f] [\--ignore-consistency]
| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
| {*instance*}
Move will move the instance to an arbitrary node in the cluster. This
works only for instances having a plain or file disk template.
......@@ -1557,13 +1548,12 @@ The ``--ignore-consistency`` option will make Ganeti ignore any errors
in trying to shutdown the instance on its node; useful if the
hypervisor is broken and you want to recuperate the data.
The ``--submit`` option is used to send the job to the master daemon
but not wait for its completion. The job ID will be shown so that it
can be examined via **gnt-job info**.
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Example::
# gnt-instance move -n node3.example.com instance1.example.com
......
......@@ -286,7 +286,7 @@ MODIFY
This command changes the role of the node. Each options takes
either a literal yes or no, and only one option should be given as
yes. The meaning of the roles and flags are described in the
manpage **ganeti**(7).
manpage **ganeti(7)**.
The option ``--node-powered`` can be used to modify state-of-record if
it doesn't reflect the reality anymore.
......@@ -309,6 +309,9 @@ The ``-s (--secondary-ip)`` option can be used to change the node's
secondary ip. No drbd instances can be running on the node, while this
operation is taking place.
See **ganeti(7)** for a description of ``--submit`` and other common
options.
Example (setting the node back to online and master candidate)::
# gnt-node modify --offline=no --master-candidate=yes node1.example.com
......
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