arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

document runimage and also add the deprecation of the install,netboot,statelite attributes. Change example.

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@15034 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
lissav 2013-02-01 12:43:36 +00:00
parent f23d37e410
commit 8435630bd0
1 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
xCAT-client/pods/man8/nodeset.8.pod
View File

@ -10,14 +10,14 @@ B<nodeset> [I<-h>|I<--help>|I<-v>|I<--version>]
=head1 B<Description>
B<nodeset> sets the next cold or warm boot state for a single or range of
nodes or groups. This tells xCAT what you want to happen the next time the
B<nodeset> sets the next boot state for a single or range of
nodes or groups. It tells xCAT what you want to happen the next time the
nodes are booted up. See L<noderange(3)|noderange.3>. B<nodeset> accomplishes this by
changing the network boot files. Each xCAT node always boots from the
network and downloads a boot file with instructions on what action to
take next.
B<nodeset> will maniputale the boot configuration files of yaboot and pxelinux.0.
B<nodeset> will manipulate the boot configuration files of yaboot and pxelinux.0.
Assume that /tftpboot is the root for tftpd (set in L<site(5)|site.5>).
@ -30,7 +30,7 @@ B<nodeset> only sets the next boot state, but does not reboot.
B<nodeset> is called by rinstall and winstall and is also called by the
installation process remotely to set the boot state back to "boot".
User can supply their own scripts to be run on the mn or on the service node (if their is hierarchy) for a node during the nodeset command. Such scripts are called B<prescripts>. They should be copied to /install/prescripts dirctory. A table called I<prescripts> is used to specify the scripts and their associated actions. The scripts to be run at the beginning of the nodeset command are stored in the 'begin' column of I<prescripts> table. The scripts to be run at the end of the noodeset command are stored in the 'end' column of I<prescripts> table. Please run 'tabdump prescripts -d' command for details. The following two environment variables will be passed to each script: NODES contains all the names of the nodes that need to run the script for and ACTION contains the current nodeset action. If I<#xCAT setting:MAX_INSTANCE=number> is specified in the script, the script will get invoked for each node in parallel, but no more than I<number> of instances will be invoked at at a time. If it is not sepcified, the script will be invoked once for all the nodes.
A user can supply their own scripts to be run on the mn or on the service node (if a hierarchical cluster) for a node when the nodeset command is run. Such scripts are called B<prescripts>. They should be copied to /install/prescripts dirctory. A table called I<prescripts> is used to specify the scripts and their associated actions. The scripts to be run at the beginning of the nodeset command are stored in the 'begin' column of I<prescripts> table. The scripts to be run at the end of the nodeset command are stored in the 'end' column of I<prescripts> table. You can run 'tabdump prescripts -d' command for details. The following two environment variables will be passed to each script: NODES contains all the names of the nodes that need to run the script for and ACTION contains the current nodeset action. If I<#xCAT setting:MAX_INSTANCE=number> is specified in the script, the script will get invoked for each node in parallel, but no more than I<number> of instances will be invoked at at a time. If it is not sepcified, the script will be invoked once for all the nodes.
=head1 B<Options>
@ -46,14 +46,18 @@ Instruct network boot loader to be skipped, generally meaning boot to hard disk
Prepare server for installing a node according to the table configuration. This will
typically mean an unattended install file is created (i.e. kickstart or autoyast),
install resources will be verified in tftp and the bulk transfer method (http, ftp, or nfs for example), and the boot loader configuration file will be written.
Note: this option has been deprecated and will be removed in a future release. You should change to using the osimage option instead.
=item B<netboot>|B<netboot=profilename>|B<netboot=<os-architecture-profilename>>
Prepare server for deploying diskless nodes. With the diskless solution, the os image will reside in the RAM of the node.
Prepare server for deploying diskless nodes. With the diskless solution, the os image will reside in the RAM of the node.
Note: this option has been deprecated and will be removed in a future release. You should change to using the osimage option instead.
=item B<statelite>|B<statelite=profilename>|B<statelite=<os-architecture-profilename>>
Prepare server for deploying statelite nodes. Statelite provides an efficient and flexible diskless solution because most of the OS image is NFS mounted read-only, but a configurable list of directories and files can be read-write. The read-write files can either be persistent across reboots, or volatile (restoring to pristine state after reboot). The configuration can be done through B<litefile>, B<litetree> and B<statelite> tables.
Note: this option has been deprecated and will be removed in a future release. You should change to using the osimage option instead.
=item B<offline>
@ -61,7 +65,11 @@ Cleanup the current pxe/tftp boot configuration files for the nodes requested
=item B<osimage>|B<osimage=<imagename>>
Prepare server for installing a node using the sepcified os image. The os image is defined in the I<osimage> table and I<linuximage> table. If the <imagename> is omitted, the os image name will be obtained from I<nodetype.provmethod> for the node.
Prepare server for installing a node using the specified os image. The os image is defined in the I<osimage> table and I<linuximage> table. If the <imagename> is omitted, the os image name will be obtained from I<nodetype.provmethod> for the node.
=item B<runimage>=<task>>
If you would like to run a task after deployment, you can define that task with this attribute.
=item B<stat>
@ -107,13 +115,21 @@ root directory and the TFTP xCAT subdirectory. /tftpboot and
=head1 B<Examples>
B<nodeset> I<node5> I<install>
=over 3
node5: install compute62-compute
=item *
Install node5 with the compute62 image using resources from the compute
resource group.
To setup to install mycomputeimage on the compute node group.
nodeset compute osimage=mycomputeimage
=item *
To run http://$master/image.tgz after deployment:
nodeset $node runimage=http://$MASTER/image.tgznodeset
=back
=head1 B<See> B<Also>