From mboxrd@z Thu Jan 1 00:00:00 1970 From: jparsons@sourceware.org Date: 15 Jan 2007 16:00:48 -0000 Subject: [Cluster-devel] conga/luci/docs user_manual.html Message-ID: <20070115160048.11611.qmail@sourceware.org> List-Id: To: cluster-devel.redhat.com MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit CVSROOT: /cvs/cluster Module name: conga Changes by: jparsons at sourceware.org 2007-01-15 16:00:48 Modified files: luci/docs : user_manual.html Log message: user manual edits - thanks, paul k Patches: http://sourceware.org/cgi-bin/cvsweb.cgi/conga/luci/docs/user_manual.html.diff?cvsroot=cluster&r1=1.9&r2=1.10 --- conga/luci/docs/user_manual.html 2006/11/03 21:47:27 1.9 +++ conga/luci/docs/user_manual.html 2007/01/15 16:00:48 1.10 @@ -6,83 +6,179 @@

Conga User Manual

All you need to know to get Conga up and running

Introduction

Conga Architecture

- Conga is an agent/server architecture for remote administration of systems. The agent component is called 'ricci', and the server is called luci. One luci server can communicate with many multiple ricci agents installed on systems. - When a system is added to a luci server to be administered, authentication is done once. No authentication is necessary from then on (unless the certificate used is revoked by a CA, but in fact, CA integration is not complete in version #1 of conga). Through the UI provided by luci, users can configure and administer storage and cluster behavior on remote systems. Communication between luci and ricci is done via XML. + + Conga is an agent/server architecture for remote administration of + systems. The agent component is called "ricci", and the server is called + "luci". One luci server can communicate with many multiple ricci agents + installed on systems. When a system is added to a luci server to be + administered, authentication is done once. No authentication is necessary from + then on (unless the certificate used is revoked by a CA, but in fact, CA + integration is not complete in version #1 of conga). Through the UI provided + by luci, users can configure and administer storage and cluster behavior on + remote systems. Communication between luci and ricci is done via XML. +

Luci Description

- As stated above, systems to be administered are 'added' to a luci server (in the documentation that follows, the term 'registered' is also used to mean that a system has been added to a luci server to administered remotely). This is done by storing the hostname (FQDN) or IP address of the system in the luci database. When a luci server is first installed, the database is empty. It is possible, however, to import part or all of a systems database from an existing luci server when deploying a new luci server. This capability provides a means for replication of a luci server instance, as well as an easier upgrade and testing path. -

- Every luci server instance has one user at initial installation time. This user is called 'admin'. Only the admin user may add systems to a luci server. The admin user can also create additional user accounts and determine which users are allowed to access which systems in the luci server database. It is possible to import users as a batch operation in a new luci server, just as it is possible to import systems. -

Installation of Luci

- After the necessary luci RPMs are installed, the server can be started with the command "service luci start". The first time the server is started, a couple of events take place. The first is that the server is initialized by generating https SSL certificates for the server. An initial password for the admin user is generated as a random value. The admin password can be set any time by running the /usr/sbin/luci_admin application and specifying 'password' on the command line. luci_admin can be run before luci is started for the first time to set up an initial password for the admin account. Other utilities available from luci_admin are: + + As stated above, systems to be administered are "added" to a luci server (in + the documentation that follows, the term "registered" is also used to mean + that a system has been added to a luci server to be administered remotely). This + is done by storing the hostname (FQDN) or IP address of the system in the luci + database. When a luci server is first installed, the database is empty. It is + possible, however, to import part or all of a systems database from an + existing luci server when deploying a new luci server. This capability + provides a means for replication of a luci server instance, as well as an + easier upgrade and testing path.

+ + Every luci server instance has one user at initial installation time. This + user is called "admin". Only the admin user may add systems to a luci + server. The admin user can also create additional user accounts and determine + which users are allowed to access which systems in the luci server + database. It is possible to import users as a batch operation in a new luci + server, just as it is possible to import systems. + +

Installation of Luci

After the luci RPMs are installed, the server + can be started with the command "service luci start". The first time the + server is started, it is initialized by generating https SSL certificates + for that server and an initial password for the admin user is generated as a + random value. The admin password can be set any time by running the + /usr/sbin/luci_admin application and specifying "password" on the command + line. luci_admin can be run before luci is started for the first time to set + up an initial password for the admin account. Other utilities available from + luci_admin are: +

Logging In

- With the luci service running and an admin password set up, the next step is to log in to the server. Remember to specify https in the browser. Port 8084 is the default port for luci, but this value can be easily changed in /etc/sysconfig/luci. + With the luci service running and an admin password set up, the next step is + to log in to the server. Remember to specify https in the browser. Port + 8084 is the default port for luci, but this value can be easily changed in + /etc/sysconfig/luci.
Typical URL: https://hostname.org:8084/luci

- Here is a screenshot of the luci login page.
+ Here is a screen shot of the luci login page.

Figure #1: Login Page

- Enter admin as the user name, and then enter the admin password that has been set up in the appropriate field, then click 'log in'. + Enter admin as the user name, and then enter the admin password that has been + set up in the appropriate field, then click "log in".

UI Organization

- luci is set up with three tabs right now. They are: -