From 3b392c30d85ec466bad6e2b3818bface5e90790c Mon Sep 17 00:00:00 2001 From: bp-sawyers Date: Fri, 25 Sep 2009 15:30:53 +0000 Subject: [PATCH] Fixed bug 2866388 (corrected updatenode man page and fixed formatting) git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@4229 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd --- xCAT-client/pods/man1/nodels.1.pod | 24 +- xCAT-client/pods/man1/updatenode.1.pod | 528 +++++++++++++++---------- 2 files changed, 326 insertions(+), 226 deletions(-) diff --git a/xCAT-client/pods/man1/nodels.1.pod b/xCAT-client/pods/man1/nodels.1.pod index 36eef5d2a..10446d404 100644 --- a/xCAT-client/pods/man1/nodels.1.pod +++ b/xCAT-client/pods/man1/nodels.1.pod @@ -2,7 +2,6 @@ B - lists the nodes, and their attributes, from the xCAT database. - =head1 SYNOPSIS B [I] [B<-H> | B<--with-fieldname>] [I | I] [I<...>] @@ -11,7 +10,6 @@ B [I] [B<-H> | B<--with-fieldname>] [I] B [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>] - =head1 DESCRIPTION The B command lists the nodes specified in the node range. If no noderange is provided, then all nodes are listed. @@ -58,13 +56,11 @@ Select nodes where the table.column value does not match a given regular express =back - The B command with a specific node and one or more table.attribute parameters is a good substitute for grep'ing through the tab files, as was typically done in xCAT 1.x. This is because nodels will translate any regular expression rows in the tables into their meaning for the specified node. The tab* commands will not do this, instead they will just display the regular expression row verbatim. - =head1 OPTIONS =over 10 @@ -83,21 +79,11 @@ Display usage message. =back - =head1 RETURN VALUE -=over 3 - -=item 0 - -The command completed successfully. - -=item 1 - -An error has occurred. - -=back +0 The command completed successfully. +1 An error has occurred. =head1 EXAMPLES @@ -206,6 +192,7 @@ Listing the switch.switch value for nodes in the second rack: nodels all nodepos.rack==2 switch.switch Output is similar to: + n41: switch.switch: switch2 n42: switch.switch: switch2 n43: switch.switch: switch2 @@ -227,6 +214,7 @@ Listing the blade slot number for anything managed through a device with a name nodels all mp.mpa=~/^amm.*/ mp.id Output looks like: + blade1: mp.id: 1 blade10: mp.id: 10 blade11: mp.id: 11 @@ -241,16 +229,12 @@ Output looks like: blade8: mp.id: 8 blade9: mp.id: 9 - - =back - =head1 FILES /opt/xcat/bin/nodels - =head1 SEE ALSO L, L, L diff --git a/xCAT-client/pods/man1/updatenode.1.pod b/xCAT-client/pods/man1/updatenode.1.pod index 37f5d6724..c7ca2a15d 100644 --- a/xCAT-client/pods/man1/updatenode.1.pod +++ b/xCAT-client/pods/man1/updatenode.1.pod @@ -1,27 +1,35 @@ - - -=head1 B +=head1 NAME B - Update nodes in an xCAT cluster environment. +=head1 SYNOPSIS -=head1 B +B I [B<-V>|B<--verbose>] [B<-F>|B<--sync>] [B<-S>|B<--sw>] [B<-P>|B<--scripts> [I]] -B [-h|--help|-v|--version] +B I [B<-V>|B<--verbose>] [I] -B [-V|--verbose] [-F|--sync] [-S|--sw] -[-P|--scripts [script1,script2...]] +B [B<-h>|B<--help>|B<-v>|B<--version>] -B [-V|--verbose] [script1,script2...] - - -=head1 B +=head1 DESCRIPTION The updatenode command is run on the xCAT management node and can be used to perform the following node updates: - 1) Distribute and synchronize files. - 2) Install or update software on diskfull nodes. - 3) Run postscripts. + +=over 3 + +=item 1 + +Distribute and synchronize files. + +=item 2 + +Install or update software on diskfull nodes. + +=item 3 + +Run postscripts. + +=back The default behavior of updatenode will be to attempt to perform all three types of updates. If you wish to limit updatenode to one or two specific @@ -40,208 +48,297 @@ is recorded and easily repeatable. If you are not concerned about the structure the updatenode command provides you can use other xCAT support such as xdsh and xdcp to accomplish these update tasks. -=head2 B +=head2 To distribute and synchronize files - The basic process for distributing and synchronizing nodes is: - - Create a synclist file. - - Indicate the location of the synclist file. - - Run the updatenode command to update the nodes. +The basic process for distributing and synchronizing nodes is: - Files may be distributed and synchronized for both diskless and - diskfull nodes. However, since some filesystems are mounted - read-only on AIX diskless nodes it my not be possible to update all - files on AIX systems. For example, any files under /usr on AIX - diskless nodes cannot be updated. - - More information on using the synchronization file function is in - "xCAT2SyncFilesHowTo.pdf". +=over 3 - Create the synclist file. +=item * - The synclist file contains the configuration entries that specify - where the files should be synced to. In the synclist file, each - line is an entry which describes the location of the source files - and the destination location for the files on the target node. +Create a synclist file. - The basic entry format looks like following: - path_of_src_file1 -> path_of_dst_file1 - path_of_src_file1 path_of_src_file2 ... -> - path_of_dst_directory +=item * - The path_of_src_file* should be the full path of the source file - on the Management Node. - The path_of_dst_file* should be the full path of the destination - file on target node. - The path_of_dst_directory should be the full path of the destina- - tion directory. - Since the synclist file is for common purpose, the target node - need not be configured in it, it will be the noderange input to - updatenode. +Indicate the location of the synclist file. - The following formats are supported: - 1) sync file /etc/file1 to the file /etc/file1 on the node with - the same file name. Note with one file, full path to file - must be provide. - /etc/file1 -> /etc/file1 - 2) sync file /etc/file2 to the file /etc/file3 on the node (with - different file name) - /etc/file2 -> /etc/file3 - 3) sync file /etc/file2 to the file /etc/tmp/file3 on the node - with different file name, different directory) - If the directory does not exist, it will be created. - /etc/file2 -> /etc/tmp/file3 - 4) sync the multiple files /etc/file1, /etc/file2, /etc/file3, - ... to the directory /tmp/etc (/tmp/etc must be a directory when - multiple files are sync'd at one time). If the directory does - not exist, xdcp will create it. - /etc/file1 /etc/file2 /etc/file3 -> /tmp/etc +=item * +Run the updatenode command to update the nodes. +=back - Indicate the location of the synclist file. +Files may be distributed and synchronized for both diskless and +diskfull nodes. However, since some filesystems are mounted +read-only on AIX diskless nodes it my not be possible to update all +files on AIX systems. For example, any files under /usr on AIX +diskless nodes cannot be updated. - For Linux nodes. +More information on using the synchronization file function is in +"xCAT2SyncFilesHowTo.pdf". - The path of the synclist should be following format: - /install/custom///... - synclist - : "install", "netboot" - : "rh", "centos", "fedora", "sles" - , and are what you set for the node +=head3 Create the synclist file +The synclist file contains the configuration entries that specify +where the files should be synced to. In the synclist file, each +line is an entry which describes the location of the source files +and the destination location for the files on the target node. - For AIX nodes. +The basic entry format looks like following: - Add a full path of the synclist file to the "synclists" - attribute base on the xCAT osimage name used by the node - in the osimage table. + path_of_src_file1 -> path_of_dst_file1 + path_of_src_file1 path_of_src_file2 ... -> path_of_dst_directory - chdef -t osimage -o myosimage synclists=/mydir/syncfile1 +The path_of_src_file* should be the full path of the source file +on the Management Node. +The path_of_dst_file* should be the full path of the destination +file on target node. +The path_of_dst_directory should be the full path of the destination directory. +Since the synclist file is for common purpose, the target node +need not be configured in it, it will be the noderange input to +updatenode. - Run updatenode to synchronize the files. +The following formats are supported: + +=over 3 + +=item 1 + +sync file /etc/file1 to the file /etc/file1 on the node with +the same file name. Note with one file, full path to file +must be provide. + + /etc/file1 -> /etc/file1 + +=item 2 + +sync file /etc/file2 to the file /etc/file3 on the node (with +different file name) + + /etc/file2 -> /etc/file3 + +=item 3 + +sync file /etc/file2 to the file /etc/tmp/file3 on the node +with different file name, different directory) +If the directory does not exist, it will be created. + + /etc/file2 -> /etc/tmp/file3 + +=item 4 + +sync the multiple files /etc/file1, /etc/file2, /etc/file3, +... to the directory /tmp/etc (/tmp/etc must be a directory when +multiple files are sync'd at one time). If the directory does +not exist, xdcp will create it. + + /etc/file1 /etc/file2 /etc/file3 -> /tmp/etc + +=back + +=head3 Indicate the location of the synclist file + +For Linux nodes, the path of the synclist should be following format: + + /install/custom///...synclist + +where: + + : "install", "netboot" + : "rh", "centos", "fedora", "sles" + , and are what you set for the node + +For AIX nodes, add a full path of the synclist file to the "synclists" +attribute base on the xCAT osimage name used by the node +in the osimage table. + + chdef -t osimage -o myosimage synclists=/mydir/syncfile1 + +=head3 Run updatenode to synchronize the files - updatenode -F + updatenode -F -=head2 B +=head2 To install or update software (only available on Linux Nodes) - The basic process for updating software on a node is: - - Copy the software to a directory. - - Create a record of what software to install. - - Run the updatenode command to update the nodes. +The basic process for updating software on a node is: - On Linux systems - - To install additional software for Linux nodes, - - First, copy the extra rpms you are going to add on to - /install/post/otherpkgs///* directory where - and are defined in the table. - - Second, add rpm names (without version number) into - - /install/custom/// - ...otherpkgs.pkglist +=over 3 - In the file path, the should be "install" if the - node was installed in diskfull state, otherwise it should be - "netboot" if it was installed in diskless state. - is the operating system name without the version - number.The following are recognized by xCAT. - centos - fedora - rh - sles - windows - In the file name, the , , are defined in - the table. And the and fields can be - ignored if the pkglist file is available just depend on the - attribute. +=item * - Third, type: - - updatenode -S +Copy the software to a directory. + +=item * + +Create a record of what software to install. + +=item * + +Run the updatenode command to update the nodes. + +=back + +On Linux systems, to install additional software for Linux nodes: + +=over 3 + +=item 1 + +Copy the extra rpms you are going to add on to + + /install/post/otherpkgs/// + + where and are defined in the table. + +=item 2 + +Add rpm names (without version number) into + + /install/custom///...otherpkgs.pkglist + +In the file path, the should be "install" if the +node was installed in diskfull state, otherwise it should be +"netboot" if it was installed in diskless state. + is the operating system name without the version +number.The following are recognized by xCAT: + +=over 1 + +=item centos + +=item fedora + +=item rh + +=item sles + +=item windows + +=back + +In the file name, the , , are defined in +the table. And the and fields can be +ignored if the pkglist file is available just depend on the + attribute. + +=item 3 + +Type: + + updatenode -S + +=back + +=head2 To run postscripts + +The scripts must be copied to the /install/postscripts +directory on the xCAT management node. (Make sure they are +executable.) + +To run scripts on a node you must either specify them on the +command line or you must add them to the "postscripts" attribute +for the node. + +To set the postscripts attribute of the node (or group) +definition you can use the xCAT chdef command. Set the value to +be a comma separated list of the scripts that you want to be +executed on the nodes. The order of the scripts in the list +determines the order in which they will be run. You could also set +the postscripts value by directly editing the xCAT "postscripts" +database table using the xCAT tabedit command. + +Scripts may be run on both diskless and diskfull nodes. + +To run all the customization scripts that have been designated +for the nodes, (in the "postscripts" attribute), type: + + updatenode -P + +To run the "syslog" script for the nodes, type: + + updatenode -P syslog + +To run a list of scripts, type: + + updatenode -P script1,script2 + +The flag '-P' can be omitted when only postscripts parameters are +specified. + +Note: script1,script2 may or may not be designated as scripts to +automatically run on the node. However, if you want script1 and +script2 to get invoked next time the nodes are deployed then make sure +to add them to the "postscripts" attribute in the database for the nodes. + +=head1 PARAMETERS + +=over 10 + +=item I + +A set of comma delimited xCAT node names +and/or group names. See the xCAT "noderange" +man page for details on additional supported +formats. + +=item I + +A comma-separated list of script names. +The scripts must be executable and copied +to the /install/postscripts directory. + +=back + +=head1 OPTIONS + +=over 10 + +=item -F|--sync + +Specifies the file synchronization should be +performed on the nodes. rsync and ssh must +be installed and configured on the nodes. + +=item -h|--help + +Display usage message. + +=item -P|--scripts + +Specifies that postscripts should be run on the nodes. + +=item -S|--sw + +Specifies that node software should be updated. + +=item -v|--version + +Command Version. + +=item -V|--verbose + +Verbose mode. + +=back + +=head1 RETURN VALUE + +0 The command completed successfully. + +1 An error has occurred. -=head2 B - - The scripts must be copied to the /install/postscripts - directory on the xCAT management node. (Make sure they are - executable.) +=head1 EXAMPLES - To run scripts on a node you must either specify them on the - command line or you must add them to the "postscripts" attribute - for the node. +=over 3 - To set the postscripts attribute of the node (or group) - definition you can use the xCAT chdef command. Set the value to - be a comma separated list of the scripts that you want to be - executed on the nodes. The order of the scripts in the list - determines the order in which they will be run. You could also set - the postscripts value by directly editing the xCAT "postscripts" - database table using the xCAT tabedit command. +=item 1 - Scripts may be run on both diskless and diskfull nodes. +To perform all updatenode features for the Linux nodes in the group +"compute": - To run all the customization scripts that have been designated - for the nodes, (in the "postscripts" attribute), type: - updatenode -P - - To run the "syslog" script for the nodes, type: - updatenode -P syslog - - To run a list of scripts, type: - updatenode -P script1,script2 - - The flag '-P' is omitted when only postscripts parameters are - specified. - - Note: script1,script2 may or may not be designated as a scripts to - automatically run on the node. However, if you want script1 and - script2 get invoked next time the nodes are deployed then make sure - to add them to the "postscripts" values for the nodes. - - -=head1 B - - A set of comma delimited xCAT node names - and/or group names. See the xCAT "noderange" - man page for details on additional supported - formats. - - A comma-separated list of script names. - The scripts must be executable and copied - to the /install/postscripts directory. - -=head1 B - --F|--sync Specifies the file synchronization should be - performed on the nodes. rsync and ssh must - be installed and configured on the nodes. - --h|--help Display usage message. - --P|--sw Specifies that node software should be updated. - --S|--scripts Specifies that postscripts should be run on the nodes. - --v|--version Command Version. - --V|--verbose Verbose mode. - - -=head1 B - -0 The command completed successfully. - -1 An error has occurred. - - -=head1 B - -1) To perform all updatenode features for the Linux nodes in the group -"compute". - updatenode compute + updatenode compute The command will: run any scripts listed in the nodes "postscripts" attribute, install or update any software indicated in the @@ -249,33 +346,52 @@ attribute, install or update any software indicated in the B), synchronize any files indicated by the synclist files specified in the osimage "synclists" attribute. -2) To perform a software update and file synchronization only on the node -"clstrn01". - updatenode clstrn01 -F -P +=item 2 -3) To run the postscripts which indicated in the postscripts attribute on -the node "clstrn01". - updatenode clstrn01 -P +To perform a software update and file synchronization only on the node +"clstrn01": -4) To run the postscripts script1 and script2 on the node "clstrn01". -Copy these scripts to the /install/postscripts first. - updatenode clstrn01 -P script1,script2 -Since flag '-P' is omitted when only postscripts parameters are specified, -the following command line are equivalent. - updatenode clstrn01 script1,script2 + updatenode clstrn01 -F -P -5) To synchronize the files on the node "clstrn01". Prepare the synclist file. -For AIX node, set the full path of synclist in the osimage table synclists -attribute. For Linux node, put the synclist file into the location: +=item 3 + +To run the postscripts which indicated in the postscripts attribute on +the node "clstrn01": + + updatenode clstrn01 -P + +=item 4 + +To run the postscripts script1 and script2 on the node "clstrn01": + + cp script1,script2 /install/postscripts + updatenode clstrn01 -P script1,script2 + +Since flag '-P' can be omitted when only postscripts parameters are specified, +the following command is equivalent: + + updatenode clstrn01 script1,script2 + +=item 5 + +To synchronize the files on the node "clstrn01": Prepare the synclist file. +For AIX, set the full path of synclist in the osimage table synclists +attribute. For Linux, put the synclist file into the location: /install/custom///...synclist - updatenode clstrn01 -F +Then: -6) To perform the software update on the Linux node "clstrn01". Copy the extra + updatenode clstrn01 -F + +=item 6 + +To perform the software update on the Linux node "clstrn01": Copy the extra rpm into the /install/post/otherpkgs///* and add the rpm names into -the /install/custom/install//profile.otherpkgs.pkglist - updatenode clstrn01 -S +the /install/custom/install//profile.otherpkgs.pkglist . Then: + updatenode clstrn01 -S -=head1 B +=back + +=head1 FILES /opt/xcat/bin/updatenode