From effb49b4f6a6bf67c8443d3dbdd1252a4de74642 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9=20Nussbaumer?= <rn@google.com>
Date: Tue, 15 Feb 2011 11:16:19 +0100
Subject: [PATCH] Update the DD of OOB with gnt-cluster epo
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This command came up in a local discussion about how much logic we
should put into gnt-node power off. We decided to go with a separate
convenience command which takes care of all the steps through the
procedures to turn down the cluster into a state suitable for a shutdown
of the underlying machine.

Signed-off-by: RenΓ© Nussbaumer <rn@google.com>
Reviewed-by: Iustin Pop <iustin@google.com>
---
 doc/design-oob.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/doc/design-oob.rst b/doc/design-oob.rst
index 1e78c1ad9..51e8e8aa7 100644
--- a/doc/design-oob.rst
+++ b/doc/design-oob.rst
@@ -52,6 +52,32 @@ New ``gnt-cluster`` Parameter
 | Parameters: ``--oob-program``
 | Options: ``--oob-program``: executable OOB program (absolute path)
 
+New ``gnt-cluster epo`` Command
++++++++++++++++++++++++++++++++
+
+| Program: ``gnt-cluster``
+| Command: ``epo``
+| Parameter: ``--on`` ``--force`` ``--groups`` ``--all``
+| Options: ``--on``: By default epo turns off, with ``--on`` it tries to get the
+|                    cluster back online
+|          ``--force``: To force the operation without asking for confirmation
+|          ``--groups``: To operate on groups instead of nodes
+|          ``--all``: To operate on the whole cluster
+
+This is a convenience command to allow easy emergency power off of a whole
+cluster or part of it. It takes care of all steps needed to get the cluster into
+a sane state to turn off the nodes.
+
+With ``--on`` it does the reverse and tries to bring the rest of the cluster back
+to life.
+
+.. note::
+  The master node is not able to shut itself cleanly down. Therefore, this
+  command will not do all the work on single node clusters. On multi node
+  clusters the command tries to find another master or if that is not possible
+  prepares everything to the point where the user has to shutdown the master
+  node itself alone this applies also to the single node cluster configuration.
+
 New ``gnt-node`` Property
 +++++++++++++++++++++++++
 
-- 
GitLab