moving *sqlsetup pods to man1

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@7749 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd

xCAT-client/pods/man1/db2sqlsetup.1.pod

@@ -0,0 +1,87 @@
+=head1 NAME
+
+B<db2sqlsetup> - Sets up the IBM DB2 for xCAT to use.  
+
+=head1 SYNOPSIS
+
+
+B<db2sqlsetup> {B<-h>|B<--help>}
+
+B<db2sqlsetup> {B<-v>|B<--version>}
+
+B<db2sqlsetup> {B<-i>|B<--init>}{<-S> | <-C>} [-o|--setupODBC]  [B<-V>|B<--verbose>]
+
+B<db2sqlsetup> {B<-o>|B<--setupODBC>} {<-S> | <-C>} [-V|--verbose] 
+
+=head1 DESCRIPTION
+
+B<db2sqlsetup> - Sets up the IBM DB2 database for xCAT to use. The db2sqlsetup script is run on the Management Node, after the DB2 Server code has been installed, to setup the DB2 Server (-S). The db2sqlsetup script is run on each Service Node, after the DB2 Client code has been installed, to setup the DB2 Client (-C). The xcatd daemon will be stopped during migration on the MN.  No xCAT commands should be run during the init process, because we will be migrating the xCAT database to DB2 and restarting the xcatd daemon as well as the DB2 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/xCAT2SetupDB2.pdf. 
+One password must be supplied for the setup,  a password for the xcatdb unix id which will be used as the DB2 instance id and database name.  The password will be prompted for interactively or can be input with the XCATDB2PW  environment variable.  
+The hostname or ip address of the Management Node as known by the Service Node must be supplied when setting up the Client, unless the XCATDB2SERVER environment variable is set. 
+The script  will assume the default install paths of /opt/IBM/db2 for AIX and
+/opt/ibm/db2 for Linux,  unless overridden with the XCATDB2INSPATH
+environment variable.
+
+Note: On AIX , root must be running ksh and on Linux,  bash shell.
+
+=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 DB2 database on AIX or Linux (p-Series) so that xCAT can use the database. This must be combined with either the -S or -C flag to indicate whether we are setting up the Server or the Client. With the -S flag, it involves creating the xcatdb database, the xcatdb instance id, allowing access to the xcatdb database by the Management Node. It also backs up the current xCAT database and restores it into the newly setup xcatdb DB2 database.  It creates the /etc/xcat/cfgloc file to point the xcatd daemon to the DB2 database and restarts the xcatd daemon using the database. 
+
+=item B<-S|-C>
+
+This options says whether to setup the Server (-S) on the Management Node, or the Client (-C) on the Service Nodes.
+
+
+=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 DB2 database.
+
+=back
+
+=head1 ENVIRONMENT VARIABLES
+
+=head1 EXAMPLES
+
+=over 2
+
+=item *
+
+To setup DB2 Server for  xCAT to run on the DB2 xcatdb database, on the MN:
+
+B<db2sqlsetup> I<-i> I<-S>
+
+=item *
+
+To setup DB2 Client for  xCAT to run on the DB2 xcatdb database, on the SN:
+
+B<db2sqlsetup> I<-i> I<-C>
+
+
+To setup the ODBC for  DB2 xcatdb database access, on the MN :
+
+B<db2sqlsetup> I<-o> I<-S>
+
+To setup the ODBC for  DB2 xcatdb database access, on the SN :
+
+B<db2sqlsetup> I<-o> I<-C>
+
+=back

xCAT-client/pods/man1/mysqlsetup.1.pod

@@ -0,0 +1,112 @@
+=head1 NAME
+
+B<mysqlsetup> - Sets up the MySQL database for xCAT to use.  
+
+=head1 SYNOPSIS
+
+
+B<mysqlsetup> {B<-h>|B<--help>}
+
+B<mysqlsetup> {B<-v>|B<--version>}
+
+B<mysqlsetup> {B<-i>|B<--init>} [B<-f>|B<--hostfile>] [-o|--setupODBC]  [B<-V>|B<--verbose>]
+
+B<mysqlsetup> {B<-u>|B<--update>} [B<-f>|B<--hostfile>] [-o|--setupODBC]           [B<-V>|B<--verbose>]
+
+B<mysqlsetup> {B<-o>|B<--setupODBC>} [-V|--verbose] 
+
+=head1 DESCRIPTION
+
+B<mysqlsetup> - Sets up the MySQL database for xCAT to use. The mysqlsetup script is run on the Management Node as root after the MySQL code has been installed. Before running the init option, the MySQL server should be stopped.  The xCAT daemon, xcatd, must be running, do not stop it. No xCAT commands should be run during the init process, because we will be migrating the xCAT database to MySQL and restarting the xcatd daemon as well as the MySQL daemon. For full information on all the steps that will be done, read the "Configure MySQL and Migrate xCAT Data to MySQL" sections in 
+http://xcat.svn.sourceforge.net/viewvc/xcat/xcat-core/trunk/
+xCAT-client/share/doc/xCAT2.SetupMySQL.pdf. 
+Two passwords must be supplied for the setup,  a password for the xcatadmin id and a password for the root id in the MySQL database.  These will be prompted for interactively, unless the environment variables XCATMYSQLADMIN_PW and  XCATMYSQLROOT_PW are set to the passwords for the xcatadmin id and root id in the database,resp. 
+
+=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 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>
+
+To run the update option,  you must first have run the -i option and have xcat successfully running on the MySQL database. You can chose the -f and/or the -o option, to update.    
+
+=item B<-f|--hostfile>
+
+This option runs during update, it will take all the host from the input file (provide a full path) and give them database access to the xcatdb in  MySQL for the xcatadmin id. Wildcards and ipaddresses may be used. xCAT  must have been previously successfully setup to use MySQL. xcatadmin and MySQL root password are required. 
+
+=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 MySQL database.
+See "Add ODBC Support" in
+http://xcat.svn.sourceforge.net/viewvc/xcat/xcat-core/trunk/
+xCAT-client/share/doc/xCAT2.SetupMySQL.pdf
+
+=back
+
+=head1 ENVIRONMENT VARIABLES
+
+=over 2
+
+=item *
+
+B<XCATMYSQLADMIN_PW> - the password for the xcatadmin id that will be assigned in the MySQL database.
+
+=item *
+
+B<XCATMYSQLROOT_PW> - the password for the root id that will be assigned to the MySQL root id, if the script creates it.  The password to use to run MySQL command to the database as the MySQL root id.  This password may be different than the unix root password on the Management Node.  
+
+=back
+
+=head1 EXAMPLES
+
+=over 2
+
+=item *
+
+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 xcatdb database in MySQL:
+
+B<mysqlsetup> I<-u> I<-f /tmp/xcat/hostlist>
+
+Where the file contains a host per line, for example:
+
+         node1
+         1.115.85.2
+         10.%.%.%
+         nodex.cluster.net
+
+=item * 
+
+To setup the ODBC for MySQL xcatdb database access :
+
+B<mysqlsetup> I<-o>
+
+=item * 
+
+To setup MySQL for xCAT and add hosts from /tmp/xcat/hostlist and setup the ODBC in Verbose mode:
+
+B<mysqlsetup> I<-i> I<-f /tmp/xcat/hostlist> I<-o> I<-V>
+
+=back

xCAT-client/pods/man1/pgsqlsetup.1.pod

@@ -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. 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 id and 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, adds the management server to the pg_hba.conf 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