add pgsqlsetup man page and fix mysqlsetup man page

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@6432 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
lissav 2010-06-11 13:32:34 +00:00
parent 23263c0500
commit 299ca48ac5
2 changed files with 72 additions and 3 deletions

View File

@ -40,7 +40,7 @@ Displays verbose messages.
=item B<-i|--init>
The init option is used to setup an installed MySQL database so that xCAT can use the database. This involves creating the xcatdb database, the xcatadmin id, dllowing access to the xcatdb database by the Management Node. It customizes the my.cnf configuration file for xcat and starts the MySQL server. It also backs up the current xCAT database and restores it into the newly setup xcatdb MySQL database. It creates the /etc/xcat/cfgloc file to point the xcatd daemon to the MySQL database and restarts the xcatd daemon using the database.
The init option is used to setup an installed MySQL database so that xCAT can use the database. This involves creating the xcatdb database, the xcatadmin id, allowing access to the xcatdb database by the Management Node. It customizes the my.cnf configuration file for xcat and starts the MySQL server. It also backs up the current xCAT database and restores it into the newly setup xcatdb MySQL database. It creates the /etc/xcat/cfgloc file to point the xcatd daemon to the MySQL database and restarts the xcatd daemon using the database.
On AIX, it additionally setup the mysql id and group and corrects the permissions in the MySQL install directories. For AIX, you should be using the MySQL rpms available from the xCAT website. For Linux, you should use the MySQL rpms shipped with the OS. You can chose the -f and/or the -o option, to run after the init.
=item B<-u|--update>
@ -80,13 +80,13 @@ B<XCATMYSQLROOT_PW> - the password for the root id that will be assigned to the
=item *
To setup MySQL for xCAT to run on the MySQL xcatd database :
To setup MySQL for xCAT to run on the MySQL xcatdb database :
B<mysqlsetup> I<-i>
=item *
To add hosts from /tmp/xcat/hostlist that can access the xcatd database in MySQL:
To add hosts from /tmp/xcat/hostlist that can access the xcatdb database in MySQL:
B<mysqlsetup> I<-u> I<-f /tmp/xcat/hostlist>

View File

@ -0,0 +1,69 @@
=head1 NAME
B<pgsqlsetup> - Sets up the PostgreSQL database for xCAT to use.
=head1 SYNOPSIS
B<pgsqlsetup> {B<-h>|B<--help>}
B<pgsqlsetup> {B<-v>|B<--version>}
B<pgsqlsetup> {B<-i>|B<--init>} [-o|--setupODBC] [B<-V>|B<--verbose>]
B<pgsqlsetup> {B<-o>|B<--setupODBC>} [-V|--verbose]
=head1 DESCRIPTION
B<pgsqlsetup> - Sets up the PostgreSQL database for xCAT to use. The pgsqlsetup script is run on the Management Node as root after the PostgreSQL code has been installed. Before running the init option, the PostgreSQL server should be stopped. The xcatd daemon will be stopped during migration. No xCAT commands should be run during the init process, because we will be migrating the xCAT database to PostgreSQL and restarting the xcatd daemon as well as the PostgreSQL daemon. For full information on all the steps that will be done reference
http://xcat.svn.sourceforge.net/viewvc/xcat/xcat-core/trunk/
xCAT-client/share/doc/xCAT2SetupPostgresql.pdf.
One password must be supplied for the setup, a password for the xcatadm unix idand the same password for the xcatadm database id. The password will be prompted for interactively.
=head1 OPTIONS
=over 6
=item B<-h|--help>
Displays the usage message.
=item B<-v|--version>
Displays the release version of the code.
=item B<-V|--verbose>
Displays verbose messages.
=item B<-i|--init>
The init option is used to setup an installed PostgreSQL database so that xCAT can use the database. This involves creating the xcatdb database, the xcatadm id, allowing access to the xcatdb database by the Management Node. It customizes the postgresql.conf configuration file for xcat and starts the PostgreSQL server. It also backs up the current xCAT database and restores it into the newly setup xcatdb PostgreSQL database. It creates the /etc/xcat/cfgloc file to point the xcatd daemon to the PostgreSQL database and restarts the xcatd daemon using the database.
On AIX, it additionally setup the xcatadm unix id and the postgres id and group. For AIX, you should be using the PostgreSQL rpms available from the xCAT website. For Linux, you should use the PostgreSQL rpms shipped with the OS. You can chose the -o option, to run after the init.
To add additional nodes to access the PostgreSQL server, setup on the Management Node, edit the pg_hba.conf file.
=item B<-o|--setupODBC>
This option sets up the ODBC /etc/../odbcinst.ini, /etc/../odbc.ini and the .odbc.ini file in roots home directory will be created and initialized to run off the xcatdb PostgreSQL database.
=back
=head1 ENVIRONMENT VARIABLES
=head1 EXAMPLES
=over 2
=item *
To setup PostgreSQL for xCAT to run on the PostgreSQL xcatdb database :
B<pgsqlsetup> I<-i>
=item *
To setup the ODBC for PostgreSQL xcatdb database access :
B<pgsqlsetup> I<-o>
=back