From ba0741b932c4b9f31d656ad28d7b9f38e6a5b2c9 Mon Sep 17 00:00:00 2001 From: nott Date: Mon, 3 May 2010 17:49:25 +0000 Subject: [PATCH] Add xcatchroot man page. git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@5940 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd --- mkAIXdeps | 9 ++ xCAT-client/pods/man1/xcatchroot.1.pod | 131 +++++++++++++++++++++++++ 2 files changed, 140 insertions(+) create mode 100644 xCAT-client/pods/man1/xcatchroot.1.pod diff --git a/mkAIXdeps b/mkAIXdeps index 733c92a56..ec394effb 100755 --- a/mkAIXdeps +++ b/mkAIXdeps @@ -95,6 +95,15 @@ echo "rpm -Uvh perl-IO-Socket-SSL-1.06-1.aix5.3.ppc.rpm" >> $RPMDIR/instoss cp /opt/freeware/src/packages/RPMS/ppc/perl-Net_SSLeay.pm-1.30-1.aix5.3.ppc.rpm $RPMDIR/ echo "rpm -Uvh perl-Net_SSLeay.pm-1.30-1.aix5.3.ppc.rpm" >> $RPMDIR/instoss +cp /opt/freeware/src/packages/RPMS/ppc/perl-Digest-SHA1-2.11-1.aix5.3.ppc.rpm $RPMDIR/ +echo "rpm -Uvh perl-Digest-SHA1-2.11-1.aix5.3.ppc.rpm" >> $RPMDIR/instoss + +cp /opt/freeware/src/packages/RPMS/ppc/perl-Digest-SHA-5.48-1.aix5.3.ppc.rpm $RPMDIR/ +echo "rpm -Uvh perl-Digest-SHA-5.48-1.aix5.3.ppc.rpm" >> $RPMDIR/instoss + +cp /opt/freeware/src/packages/RPMS/ppc/perl-Digest-HMAC-1.01-1.aix5.3.ppc.rpm $RPMDIR/ +echo "rpm -Uvh perl-Digest-HMAC-1.01-1.aix5.3.ppc.rpm" >> $RPMDIR/instoss + cp /opt/freeware/src/packages/RPMS/ppc/perl-Digest-MD5-2.36-1.aix5.3.ppc.rpm $RPMDIR/ echo "rpm -Uvh perl-Digest-MD5-2.36-1.aix5.3.ppc.rpm" >> $RPMDIR/instoss diff --git a/xCAT-client/pods/man1/xcatchroot.1.pod b/xCAT-client/pods/man1/xcatchroot.1.pod new file mode 100644 index 000000000..e45d147b7 --- /dev/null +++ b/xCAT-client/pods/man1/xcatchroot.1.pod @@ -0,0 +1,131 @@ +=head1 NAME + +B - Use this xCAT command to modify an xCAT diskless operating system image. + +=head1 SYNOPSIS + +B + +B + +=head1 DESCRIPTION + +For AIX diskless images this command will modify the AIX SPOT resource using +the chroot command. You must include the name of an xCAT osimage +definition and the command that you wish to have run in the spot. + +WARNING: + +=over 3 + + Be very careful when using this command!!! Make sure you are + very clear about exactly what you are changing so that you do + not accidently corrupt the image. + + As a precaution it is advisable to make a copy of the original + spot in case your changes wind up corrupting the image. + +=back + +When you are done updating a NIM spot resource you should always run the NIM +check operation on the spot. + +=over 3 + + nim -Fo check + +=back + +The xcatchroot command will take care of any of the required setup so that +the command you provide will be able to run in the spot chroot environment. +It will also mount the lpp_source resource listed in the osimage definition +so that you can access additional software that you may wish to install. + +For example, assume that the location of the spot named in the xCAT osimage +definition is /install/nim/spot/614spot/usr. The associated root directory in +this spot would be /install/nim/spot/614spot/usr/lpp/bos/inst_root. The chroot +is automatically done to this new root directory. The spot location is +mounted on /.../inst_root/usr so that when your command is run in the chroot +environment it is actually running commands from the spot usr location. + +Also, the location of the lpp_source resource specified in the osimage +definition will be mounted to a subdirectory of the spot /.../inst_root +directory. For example, if the lpp_source location is +/install/nim/lpp_source/614lpp_lpp_source then that would be mounted over +/install/nim/spot/614spot/usr/lpp/bos/inst_root/lpp_source. + +When you provide a command string to run make sure you give the full paths +of all commands and files assuming the /.../inst_root directory is you root +directory. + +If you wish to install software from the lpp_source location you would +provide a directory location of /lpp_source (or /lpp_source/installp/ppc +or /lpp_source/RPMS/ppc etc.) See the example below. + +Always run the NIM check operation after you are done updating your spot. +(ex. "nim -o check ") + +=head1 OPTIONS + +=over 10 + +=item B + +The command you wish to have run in the chroot environment. (Use a quoted +string.) + +=item B<-h |--help> + +Display usage message. + +=item B<-i osimage_name> + +The name of the xCAT osimage definition. + +=item B<-V |--verbose> + +Verbose mode. + +=back + +=head1 RETURN VALUE + +=over 3 + +=item 0 + +The command completed successfully. + +=item 1 + +An error has occurred. + +=back + +=head1 EXAMPLES + +1) Set the root password to "cluster" in the spot so that when the diskless +node boots it will have a root password set. + +B + +2) Install the bash rpm package. + +B + +3) To enable system debug. + +B + +4) To set the "ipforwarding" system tunable. + +B + +=head1 FILES + +/opt/xcat/bin/xcatchroot + +=head1 NOTES + +This command is part of the xCAT software product. +