From 4677a909e0cdae084c8b4fee0cd0a106c7b07eea Mon Sep 17 00:00:00 2001
From: Michael Hanselmann <hansmi@google.com>
Date: Wed, 7 Nov 2007 12:39:20 +0000
Subject: [PATCH] Update docs for the removed --secondary-node option.
Reviewed-by: ultrotter
---
doc/admin.sgml | 13 ++++++-------
doc/install.sgml | 9 ++++-----
man/gnt-backup.sgml | 17 +++++------------
man/gnt-instance.sgml | 24 ++++++++++--------------
4 files changed, 25 insertions(+), 38 deletions(-)
diff --git a/doc/admin.sgml b/doc/admin.sgml
index ec83f824c..932a4aff6 100644
--- a/doc/admin.sgml
+++ b/doc/admin.sgml
@@ -183,11 +183,10 @@
<simpara><emphasis role="strong">Note:</emphasis> This is
only valid for multi-node clusters.</simpara>
<simpara>
- A mirror is set between the local node and a remote
- one, which must be specified with the --secondary-node
- option. Use this option to obtain a highly available
- instance that can be failed over to a remote node
- should the primary one fail.
+ A mirror is set between the local node and a remote one, which
+ must be specified with the second value of the --node option. Use
+ this option to obtain a highly available instance that can be
+ failed over to a remote node should the primary one fail.
</simpara>
</listitem>
</varlistentry>
@@ -197,8 +196,8 @@
<para>
For example if you want to create an highly available instance
use the remote_raid1 disk template:
- <synopsis>gnt-instance add -n <replaceable>TARGET_NODE</replaceable> -o <replaceable>OS_TYPE</replaceable> -t remote_raid1 \
- --secondary-node=<replaceable>SECONDARY_NODE</replaceable> <replaceable>INSTANCE_NAME</replaceable></synopsis>
+ <synopsis>gnt-instance add -n <replaceable>TARGET_NODE</replaceable><optional>:<replaceable>SECONDARY_NODE</replaceable></optional> -o <replaceable>OS_TYPE</replaceable> -t remote_raid1 \
+ <replaceable>INSTANCE_NAME</replaceable></synopsis>
<para>
To know which operating systems your cluster supports you can use:
diff --git a/doc/install.sgml b/doc/install.sgml
index f0656af1c..5702535e4 100644
--- a/doc/install.sgml
+++ b/doc/install.sgml
@@ -810,13 +810,12 @@ creating os for instance inst1.example.com on node node1.example.com
To create a network mirrored instance, change the argument to
the <option>-t</option> option from <literal>plain</literal>
to <literal>remote_raid1</literal> and specify the node on
- which the mirror should reside with the
- <option>--secondary-node</option> option, like this:
+ which the mirror should reside with the second value of the
+ <option>--node</option> option, like this:
</para>
<screen>
-# gnt-instance add -t remote_raid1 --secondary-node node1 \
- -n node2 -o debian-etch instance2
+# gnt-instance add -t remote_raid1 -n node1:node2 -o debian-etch instance2
* creating instance disks...
adding instance instance2 to cluster config
Waiting for instance instance1 to sync disks.
@@ -827,7 +826,7 @@ Waiting for instance instance1 to sync disks.
- device sdb: 76.30% done, 72 estimated seconds remaining
- device sdb: 94.80% done, 18 estimated seconds remaining
Instance instance2's disks are in sync.
-creating os for instance instance2 on node node2.example.com
+creating os for instance instance2 on node node1.example.com
* running the instance OS create scripts...
* starting instance...
</screen>
diff --git a/man/gnt-backup.sgml b/man/gnt-backup.sgml
index 485a4edda..ed93f267a 100644
--- a/man/gnt-backup.sgml
+++ b/man/gnt-backup.sgml
@@ -91,7 +91,7 @@
<title>IMPORT</title>
<cmdsynopsis>
<command>import</command>
- <arg choice="req">-n <replaceable>node</replaceable></arg>
+ <arg choice="req">-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg>
<arg>-s <replaceable>disksize</replaceable></arg>
<arg>-o <replaceable>os-type</replaceable></arg>
<arg>-m <replaceable>memsize</replaceable></arg>
@@ -171,29 +171,22 @@
<term>remote_raid1</term>
<listitem>
<para>
- Disk devices will be md raid1 arrays with one
- component (so it's not actually raid1): a drbd device
- between the instance's primary node and the node given
- by the option <option>--secondary-node</option>.
+ Disk devices will be md raid1 arrays with one component (so
+ it's not actually raid1): a drbd device between the instance's
+ primary node and the node given by the second value of the
+ <option>--node</option> option.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
- <para>
- The <option>--secondary-node</option> option is used with
- the remote raid disk template type and specifies the remote
- node.
- </para>
-
<para>
If you do not want gnt-backup to wait for the disk mirror
to be synced, use the <option>--no-wait-for-sync</option>
option.
</para>
-
<para>
Example:
<screen>
diff --git a/man/gnt-instance.sgml b/man/gnt-instance.sgml
index ce9eb3040..b1d6ce978 100644
--- a/man/gnt-instance.sgml
+++ b/man/gnt-instance.sgml
@@ -77,7 +77,7 @@
</group>
</arg>
<sbr>
- <arg choice="req">-n <replaceable>node</replaceable></arg>
+ <arg choice="req">-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg>
<arg choice="req"><replaceable>instance</replaceable></arg>
</cmdsynopsis>
<para>
@@ -155,10 +155,10 @@
<term>remote_raid1</term>
<listitem>
<para>
- Disk devices will be md raid1 arrays with one
- component (so it's not actually raid1): a drbd device
- between the instance's primary node and the node given
- by the option <option>--secondary-node</option>.
+ Disk devices will be md raid1 arrays with one component (so
+ it's not actually raid1): a drbd device between the
+ instance's primary node and the node given by the second
+ value of the <option>--node</option> option.
</para>
</listitem>
</varlistentry>
@@ -166,9 +166,8 @@
</para>
<para>
- The <option>--secondary-node</option> option is used with
- the remote raid disk template type and specifies the remote
- node.
+ The optional second value of the <option>--node</option> is used for
+ the remote raid template type and specifies the remote node.
</para>
<para>
@@ -177,18 +176,15 @@
option.
</para>
-
<para>
Example:
<screen>
# gnt-instance add -t plain -s 30g -m 512 -o debian-etch \
-n node1.example.com instance1.example.com
-# gnt-instance add -t remote_raid1 --secondary-node node3.example.com \
- -s 30g -m 512 -o debian-etch \
- -n node1.example.com instance2.example.com
+# gnt-instance add -t remote_raid1 -s 30g -m 512 -o debian-etch \
+ -n node1.example.com:node2.example.com instance2.example.com
</screen>
</para>
-
</refsect3>
<refsect3>
@@ -275,7 +271,7 @@
<varlistentry>
<term>snodes</term>
<listitem>
- <simpara>comma-separated list of secondary-nodes for the
+ <simpara>comma-separated list of secondary nodes for the
instance; usually this will be just one node</simpara>
</listitem>
</varlistentry>
--
GitLab