[PATCH master] Adding more details to gnt-node man-page

[René Nussbaumer]

This adds some recently added flags to the man-page of gnt-node command.
It also describes their purpose and handling.
---
man/gnt-node.rst | 18 +++++++++++++++++-
1 files changed, 17 insertions(+), 1 deletions(-)

diff --git a/man/gnt-node.rst b/man/gnt-node.rst
index 06ec955..a01a98f 100644
--- a/man/gnt-node.rst
+++ b/man/gnt-node.rst
@@ -601,12 +601,28 @@ node.
POWER
~~~~~

-**power** on|off|cycle|status {*node*}
+**power** [``--force``] [``--force-master``] [``--ignore-status``] [``--all``]
+on|off|cycle|status [*nodes*]

This commands calls out to out-of-band management to change the power
state of given node. With ``status`` you get the power status as reported
by the out-of-band managment script.

+Using ``--force`` you skip the confirmation to do the operation. Currently this
+only has effect on ``off`` and ``cycle``. On those two you might also use
+``--force-master`` to operate on the master too.
+
+Providing ``--ignore-status`` will ignore the offline=N state of a node and
+continue with power off.
+
+*nodes* are optional. If not provided it will call out for every node in the
+cluster. Except for the ``off`` and ``cycle`` command where you've to explicit
+use ``-all`` to select all.
+
+**Caution:** Be warned that using ``--force-master`` might cause problems with
+the master upon next startup depending on the handling within the out-of-band
+helper. Use with care.
+
HEALTH
~~~~~~

--
1.7.3.1

[René Nussbaumer]

This adds some recently added flags to the man-page of gnt-node command.
It also describes their purpose and handling.
---

man/gnt-node.rst | 16 +++++++++++++++-
1 files changed, 15 insertions(+), 1 deletions(-)

diff --git a/man/gnt-node.rst b/man/gnt-node.rst
index 06ec955..595e3f5 100644
--- a/man/gnt-node.rst
+++ b/man/gnt-node.rst
@@ -601,12 +601,26 @@ node.

POWER
~~~~~

-**power** on|off|cycle|status {*node*}

+**power** [``--force``] [``--ignore-status``] [``--all``]

+on|off|cycle|status [*nodes*]

This commands calls out to out-of-band management to change the power
state of given node. With ``status`` you get the power status as reported
by the out-of-band managment script.

+Using ``--force`` you skip the confirmation to do the operation. Currently this

+only has effect on ``off`` and ``cycle``. On those two you can *not* operate on
+the master. However, the command will provide you with the command to invoke to
+operate on the master nerver-mind. This is considered harmful and Ganeti does
+not support the use of it.

+
+Providing ``--ignore-status`` will ignore the offline=N state of a node and
+continue with power off.
+
+*nodes* are optional. If not provided it will call out for every node in the
+cluster. Except for the ``off`` and ``cycle`` command where you've to explicit
+use ``-all`` to select all.
+

HEALTH
~~~~~~

--
1.7.3.1

[Iustin Pop]

… where you have to explicitly use …

> +**Caution:** Be warned that using ``--force-master`` might cause problems with
> +the master upon next startup depending on the handling within the out-of-band
> +helper. Use with care.

I rather have this functionality removed and replaced with a good
message (per Michael's suggestion).

iustin

[Rene Nussbaumer]

ping on this if the other patch is alright :)

René

[Iustin Pop]

On Wed, Feb 16, 2011 at 11:24:50AM +0100, Rene Nussbaumer wrote:

> On Thu, Feb 3, 2011 at 2:15 PM, Ren� Nussbaumer <r...@google.com> wrote:
> > This adds some recently added flags to the man-page of gnt-node command.
> > It also describes their purpose and handling.
> > ---
> > �man/gnt-node.rst | � 16 +++++++++++++++-
> > �1 files changed, 15 insertions(+), 1 deletions(-)
> >
> > diff --git a/man/gnt-node.rst b/man/gnt-node.rst
> > index 06ec955..595e3f5 100644
> > --- a/man/gnt-node.rst
> > +++ b/man/gnt-node.rst
> > @@ -601,12 +601,26 @@ node.
> > �POWER
> > �~~~~~
> >
> > -**power** on|off|cycle|status {*node*}
> > +**power** [``--force``] [``--ignore-status``] [``--all``]
> > +on|off|cycle|status [*nodes*]
> >
> > �This commands calls out to out-of-band management to change the power
> > �state of given node. With ``status`` you get the power status as reported
> > �by the out-of-band managment script.

typo, management.

> > +Using ``--force`` you skip the confirmation to do the operation. Currently this
> > +only has effect on ``off`` and ``cycle``. On those two you can *not* operate on
> > +the master. However, the command will provide you with the command to invoke to
> > +operate on the master nerver-mind. This is considered harmful and Ganeti does
> > +not support the use of it.
> > +
> > +Providing ``--ignore-status`` will ignore the offline=N state of a node and
> > +continue with power off.
> > +
> > +*nodes* are optional. If not provided it will call out for every node in the
> > +cluster. Except for the ``off`` and ``cycle`` command where you've to explicit
> > +use ``-all`` to select all.
> > +
> > �HEALTH
> > �~~~~~~
> >
> > --
> > 1.7.3.1
>
> ping on this if the other patch is alright :)

LGTM, thanks.

iustin