[lxc-devel] [lxd/master] Fix some typos and wording.

dhenrich on Github lxc-bot at linuxcontainers.org
Fri Mar 30 21:26:36 UTC 2018


A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 358 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20180330/ee0edf5d/attachment.bin>
-------------- next part --------------
From 6b012af5bfc1ee5b127f591ebebe393689af1c4c Mon Sep 17 00:00:00 2001
From: Dean Henrichsmeyer <dean at beret.net>
Date: Fri, 30 Mar 2018 16:23:31 -0500
Subject: [PATCH] Fix some typos and wording.

---
 doc/clustering.md | 47 ++++++++++++++++++++++++-----------------------
 1 file changed, 24 insertions(+), 23 deletions(-)

diff --git a/doc/clustering.md b/doc/clustering.md
index e9c4f210d..a77f9bb73 100644
--- a/doc/clustering.md
+++ b/doc/clustering.md
@@ -1,10 +1,11 @@
 # Clustering
 
-LXD can be run in clustering mode, where any number of LXD instance
+LXD can be run in clustering mode, where any number of LXD instances
 share the same distributed database and can be managed uniformly using
 the lxc client or the REST API.
 
-Note that this feature was introduced as part of API extension "clustering".
+Note that this feature was introduced as part of the API extension 
+"clustering".
 
 ## Forming a cluster
 
@@ -19,9 +20,9 @@ networks. The only configuration that can be node-specific are the
 `source` and `size` keys for storage pools and the
 `bridge.external_interfaces` key for networks.
 
-It is recommended that the number of nodes in the cluster is at least
+It is recommended that the number of nodes in the cluster be at least
 three, so the cluster can survive the loss of at least one node and
-still be able to have a quorum for its distributed state (which is
+still be able to establish quorum for its distributed state (which is
 kept in a SQLite database replicated using the Raft algorithm).
 
 ### Interactively
@@ -36,15 +37,15 @@ available on your network.
 
 You can now join further nodes to the cluster. Note however that these
 nodes should be brand new LXD instances, or alternatively you should
-clear them up before joining, since any existing data on them will be
-lost.
-
-Run `lxd init` and answer `yes` to the question about whether to use
-clustering. Pick a new node name which must be different from the one
-of the bootstrap node or any other nodes you joined so far. Then pick
-an IP or DNS address for the node and answer `yes` to the question
-about whether you're joining an existing cluster. Pick an address of
-an existing node in the cluster and check the fingerprint that gets
+clear their contents them up before joining, since any existing data 
+on them will be lost.
+
+To add an additional node, run `lxd init` and answer `yes` to the question
+about whether to use clustering. Choose a node name that is different from
+the one chosen for the bootstrap node or any other nodes you have joined so
+far. Then pick an IP or DNS address for the node and answer `yes` to the
+question about whether you're joining an existing cluster. Pick an address
+of an existing node in the cluster and check the fingerprint that gets
 printed.
 
 ### Preseed
@@ -151,7 +152,7 @@ To cleanly delete a node from the cluster use `lxc cluster remove <node name>`.
 At each time there will be an elected cluster leader that will monitor
 the health of the other nodes. If a node is down for more than 20
 seconds, its status will be marked as OFFLINE and no operation will be
-possible on it, as well as operations that require a state changes
+possible on it, as well as operations that require a state change
 across all nodes.
 
 If the node that goes offline is the leader itself, the other nodes
@@ -165,8 +166,8 @@ delete it from the cluster using `lxc cluster remove --force <node name>`.
 
 ### Upgrading nodes
 
-To upgrade a cluster you need to upgrade all its nodes, making sure
-that they all upgrade to the very same LXD version.
+To upgrade a cluster you need to upgrade all of its nodes, making sure
+that they all upgrade to the same version of LXD.
 
 To upgrade a single node, simply upgrade the lxd/lxc binaries on the
 host (via snap or other packaging systems) and restart the lxd daemon.
@@ -174,8 +175,8 @@ host (via snap or other packaging systems) and restart the lxd daemon.
 If the new version of the daemon has database schema or API changes,
 the restarted node might transition into a Blocked state. That happens
 if there are still nodes in the cluster that have not been upgraded
-and that are running a less recent version. When a node is in the
-Blocked state it will not serve any LXD API request (in particular,
+and that are running an older version. When a node is in the
+Blocked state it will not serve any LXD API requests (in particular,
 lxc commands on that node will not work, although any running
 container will continue to run).
 
@@ -239,15 +240,15 @@ Now run:
 lxc storage create data zfs
 ```
 
-and the storage will be actually created on all nodes. If you didn't
-define it on some node, or some node is down, an error will be
+and the storage will be instantiated on all nodes. If you didn't
+define it on a particular node, or a node is down, an error will be
 returned.
 
 ## Storage volumes
 
-Each volume is lives on a specific node. The `lxc storage volume list`
-includes a `NODE` column to indicate which node a certain volume lives
-on.
+Each volume lives on a specific node. The `lxc storage volume list`
+includes a `NODE` column to indicate on which node a certain volume
+resides.
 
 Different volumes can have the same name as long as they live on
 different nodes (for example image volumes). You can manage storage


More information about the lxc-devel mailing list