[Cluster-devel] conga/luci/docs user_manual.html

[jparsons at sourceware.org]

CVSROOT:	/cvs/cluster
Module name:	conga
Changes by:	jparsons at sourceware.org	2006-09-26 12:12:47

Modified files:
	luci/docs      : user_manual.html 

Log message:
	latest additions

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/conga/luci/docs/user_manual.html.diff?cvsroot=cluster&r1=1.1&r2=1.2

--- conga/luci/docs/user_manual.html	2006/09/15 03:57:41	1.1
+++ conga/luci/docs/user_manual.html	2006/09/26 12:12:47	1.2
@@ -40,17 +40,29 @@
   With no systems registered with a luci server, the homebase page provides 3 initial utilities to the admin:
   <ul><li>Add a system: Adding a single system to luci in this first release makes the system available for remote storage administration. In addition to storage administration, conga also provides remote package retrieval and installation, chkconfig functionality, full remote cluster administration, and module support to filter and retrieve log entries. The storage and cluster UIs use some of this broad functionality, but at this time UI has not been built for all that conga will do remotely. <p/>
   To add a system, click on the 'Add a System' link in the left hand nav table. This will load the following page:
-  <h1>SCREENSHOT</h1>
+  <img src="./ss_homebase2.png"/>
   The fully qualified domain name  OR IP Address of the system is entered in the System Hostname field. The root passsword for the system is entered in the adjacent field. As a convenience for adding multiple systems at once, and 'Add Another Entry' button is provided. Whhen this button is clicked and at least one additional entry row has been provided, a checkbox is also made available that can be selected if all systems specified for addition to the luci server share the same password.
-  <h1>SCREENSHOT MULTI ROW</h1>
+  <img src="./ss_homebase3.png"/>
   <p/>
   If the System Hostname is left blank for any row, it is disregarded when the list of systems is submitted for addition. If systems in the list of rows do NOT share the same password (and the checkbox is, of course, left unchecked) and one ior more passwords are incorrect, an error message is generated for each system that has an incorrect password. Those systems listed with correct passwords are added to the luci server. Inn addition to incorrect password problems, an error message is also displayed if luci is unable to connect to the ricci agent on a system. Finally, is a system is entered on the form for addition and it is ALREADY being managed by the luci server, it is not added again - but the admin is informed via error message.</li>
-  <li>Add a Cluster: This page looks much like the Add a System page, only one system may be listed. Any node in the cluster may bbe used for this entry.  Luci will contact tthe specified system and attempt to authenticate with the password provided. If successful, the complete list of cluster nodes will be returned, and a table will be populated with the node names and an adjacent field for a password for each node. The initial node that was entered appears in tthe list with its password field marked as 'authennticated'. There is a convenience checkbox if all nodes share the same password. NOTE: At this point, no cluster nodes have been added to luci - not even the initial node used to retrieve the cluster node list that successfully autthenticated. The cluster and subsequent nodes are only added after the entire list has been submitted with tthe submit button, and all nodes authenticate. 
-  <p/>
+  <li>Add a Cluster: This page looks much like the Add a System page, only one system may be listed. Any node in the cluster may bbe used for this entry.  Luci will contact tthe specified system and attempt to authenticate with the password provided. If successful, the complete list of cluster nodes will be returned, and a table will be populated with the node names and an adjacent field for a password for each node. The initial node that was entered appears in tthe list with its password field marked as 'authennticated'. There is a convenience checkbox if all nodes share the same password. NOTE: At this point, no cluster nodes have been added to luci - not even the initial node used to retrieve the cluster node list that successfully autthenticated. The cluster and subsequent nodes are only added after the entire list has been submitted with tthe submit button, and all nodes authenticate.  <p/>
 If any nodes fail to authenticate, they appear in the list in red font, so that the password can be corrected and the node list submittted aggain. Luci hhas a strict policy about addinng a cluster to be managed: A cluster cannot be added unless ALL nodes can be reached and authenticated.
   <p/>When a cluster is added to a luci server, all nodes are also added as general systems so that storage may be managed on them. If this is not desired, the individual systems may be removed fromm luci, while remote cluster management capability is maintained.
   
   <h2>Cluster Tab</h2>
+  When the cluster tab is selected, luci first checks the identity of the user and compiles a list of cluster that the current user is privileged to administer.
+If the current user is not privileged to access any of the clusters registered on the luci server, they are informed accordingly. If the current user is the admin, then all clusters are accessible.
+  <br/>
+  Selecting the cluster tab displays a list of the clusters accessible by the current user. Each cluster is identified by name, and the name is a link to the properties page for that specific cluster. In addition, the health of the cluster can be quickly assessed - green indicates health, and red indicates a problem.
+ The nodes of the cluster are also listed, and their health can be spotted depending on their font color. Green means healthy and part of the cluster; red means not part of the cluster, and gray means that the node is not responding and in an unknown state.
+  <br/>
+  The cluster list page offers some additional summary information about each cluster. Whether not the cluster is quorate is specified, as is total cluster votes. A dropdown menu allows a cluster to be started, stopped, or restarted. Finally, services for the cluster are listed as links, annd again, their health is identified by their font color.
+  <br/>
+  On the left hand side of every cluster tab page is a navigation table with three links: Cluster List, Create, and Configure. The default page is the Cluster List page. The Create page is for creating a new cluster. Selecting the Configure link displays a short list of clusters in tthe navigation table. Choosing a cluster name takes the user to the properties page for that cluster (the cluster name link on the Cluster List page performs the same action).
+  <img src="./clus1.png"/>
+ NOTE: Until a specific cluster is selected, the cluster pages have no context associated with them. Once a cluster has been selected, however, an additional navigation table is displayed with links to nodes, services, fence devices, and failover domains.
+  <img src="./clus2.png"/>
+  
   <h2>Storage Tab</h2>
  </body>
 </html>