pmgproxy.adoc: add docs for config-parameters

[pmg-docs.git] / pmgcm.adoc

diff --git a/pmgcm.adoc b/pmgcm.adoc
index 7534b958e011671ce266de6e86b03e0ec34158a7..aef23089f8ac3d3cc26723789cd46d4862b6ea64 100644 (file)
--- a/pmgcm.adoc
+++ b/pmgcm.adoc
@@ -48,7 +48,7 @@ management as easy as possible. Complete Cluster setup is done within
 minutes, and nodes automatically reintegrate after temporary failures
 without any operator interaction.
 
-image::images/pmg-ha-cluster.png[]
+image::images/Proxmox_HA_cluster_final_1024.png[]
 
 
 Hardware requirements
@@ -197,34 +197,41 @@ using DNAT. See your firewall manual for more details.
 Cluster administration
 ----------------------
 
-Cluster administration is done with a single command line utility
-called `pmgcm'. So you need to login via ssh to manage the cluster
-setup.
+Cluster administration can be done on the GUI or using the command
+line utility `pmgcm`. The CLI tool is a bit more verbose, so we suggest
+to use that if you run into problems.
 
 NOTE: Always setup the IP configuration before adding a node to the
 cluster. IP address, network mask, gateway address and hostname can’t
 be changed later.
 
-
 Creating a Cluster
 ~~~~~~~~~~~~~~~~~~
 
+image::images/screenshot/pmg-gui-cluster-panel.png[]
+
 You can create a cluster from any existing Proxmox host. All data is
 preserved.
 
 * make sure you have the right IP configuration
-  (IP/MASK/GATEWAY/HOSTNAME), because you cannot changed that later
+  (IP/MASK/GATEWAY/HOSTNAME), because you cannot change that later
 
-* run the cluster creation command:
+* press the create button on the GUI, or run the cluster creation command:
 +
 ----
 pmgcm create
 ----
 
+NOTE: The node where you run the cluster create command will be the
+'master' node.
+
 
-List Cluster Status
+Show Cluster Status
 ~~~~~~~~~~~~~~~~~~~
 
+The GUI shows the status of all cluster nodes, and it is also possible
+to use the command line tool:
+
 ----
 pmgcm status
 --NAME(CID)--------------IPADDRESS----ROLE-STATE---------UPTIME---LOAD----MEM---DISK
@@ -232,9 +239,12 @@ pmg5(1)              192.168.2.127   master A       1 day 21:18   0.30    80%
 ----
 
 
+[[pmgcm_join]]
 Adding Cluster Nodes
 ~~~~~~~~~~~~~~~~~~~~
 
+image::images/screenshot/pmg-gui-cluster-join.png[]
+
 When you add a new node to a cluster (join) all data on that node is
 destroyed. The whole database is initialized with cluster data from
 the master.
@@ -248,7 +258,9 @@ pmgcm join <master_ip>
 ----
 
 You need to enter the root password of the master host when asked for
-a password.
+a password. When joining a cluster using the GUI, you also need to
+enter the 'fingerprint' of the master node. You get that information
+by pressing the `Add` button on the master node.
 
 CAUTION: Node initialization deletes all existing databases, stops and
 then restarts all services accessing the database. So do not add nodes