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

for defect 3074153,

Browse Source 
the manpage for genimage and geninitrd are updated.

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@7633 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
mxi1 2010-09-25 07:13:37 +00:00
parent 9f98099d5c
commit ee383000ed
2 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
xCAT-client/pods/man1/genimage.1.pod
View File

@ -4,9 +4,9 @@ B<genimage> - Generates a stateless image to be used for a diskless install.
=head1 SYNOPSIS
B<genimage> B<-i> I<nodebootif> B<-n> I<nodenetdrivers> B<-o> I<OS> B<-p> I<profile> [B<-l> I<rootlimit>] [B<-r> I<additional_nics>] [B<-k> I<kernel_version>] [B<-m> I<mode>]
B<genimage> [B<-i> I<nodebootif>] [B<-n> I<nodenetdrivers>] B<-o> I<OS> B<-p> I<profile> [B<-l> I<rootlimit>] [B<-r> I<additional_nics>] [B<-k> I<kernel_version>] [B<--permission> I<permission>]
B<genimage> B<-i> I<nodebootif> B<-n> I<nodenetdrivers> [B<-o> I<OS>] [B<-l> I<rootlimit>] [B<-r> I<additional_nics>] [B<-k> I<kernel_version>] imagename
B<genimage> [B<-i> I<nodebootif>] [B<-n> I<nodenetdrivers>] [B<-o> I<OS>] [B<-l> I<rootlimit>] [B<-r> I<additional_nics>] [B<-k> I<kernel_version>] imagename
B<genimage> [B<-h> | B<--help> | B<-v> | B<--version>]
@ -15,11 +15,13 @@ B<genimage> [B<-h> | B<--help> | B<-v> | B<--version>]
Generates a stateless image that can be used to boot xCAT nodes in a diskless mode.
If I<imagename> is not specified, the default packages included
(and excluded) in the image are specified by /opt/xcat/share/xcat/netboot/<OS>/<profile>.pkglist and
(and excluded) in the image are specified by /opt/xcat/share/xcat/netboot/<OS>/<profile>.<OS>.<arch>.pkglist and
/opt/xcat/share/xcat/netboot/<OS>/<profile>.exlist.
Additional packages that are not from the os distro can be specified in a <profile>.otherpkgs.pkglist file.
Additional packages that are not from the os distro can be specified in a <profile><OS>.<arch>.otherpkgs.pkglist file.
Customized package list files can be specified under /install/custom/netboot/<OS> directory. The generated image will be put in /install/netboot/<OS>/<arch>/<profile>.
If I<imagename> is specified, the package list files are specified in the I<osimage> table and I<linuximage> table.
If B<genimage> runs on the Management node, both the I<osimage> table and I<linuximage> table will be updated following the B<genimage> options. And, if there is no I<imagename> called <OS>-<arch>-netboot-<profile> or <OS>-<arch>-statelite-<profile>, the B<genimage> command will create them into I<linuximage> and I<osimage> tables.
The B<genimage> command must be run on a system that is the same architecture as the nodes it will be
used on. If the management node is not the same architecture, copy the contents of
@ -31,6 +33,8 @@ you want to rebuild the initrd.) After your image is created, you can chroot to
image, install any additional software you would like, or make modifications to files, and then run
B<packimage> to prepare the image for deployment.
The B<genimage> and B<geninitrd> commands will generate two initial ramdisks for B<statelite> and B<stateless>, one is B<initrd-statelite.gz>, the other one is B<initrd-stateless.gz>.
=head1 Parameters
I<imagename> specifies the name of a os image definition to be used. The specification for the image is storted in the I<osimage> table and I<linuximage> table.
@ -55,9 +59,9 @@ the nodes' nodetype.profile attribute must be set to this same value.
The network interface the diskless node will boot over (e.g. eth0).
=item B<-m> I<mode>
=item B<--permission> I<permission>
The mode of diskless image, the valid value is statelite. 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. If this option is not specified, regular non-statelite diskless image will be generated.
The mount permission of B</.statelite> directory for B<statelite> mode, which is only used for B<statelite> mode, and the default permission is 755.
=item B<-n> I<nodenetdrivers>

10
xCAT-client/pods/man1/geninitrd.1.pod
View File

@ -4,14 +4,16 @@ B<geninitrd> - Regenerates the initrd for a stateless image to be used for a dis
=head1 SYNOPSIS
B<geninitrd> B<-i> I<nodebootif> B<-n> I<nodenetdrivers> B<-o> I<OS> B<-p> I<profile> [B<-l> I<rootlimit>] [B<-k> I<kernel_version>]
B<geninitrd> [B<-i> I<nodebootif>] [B<-n> I<nodenetdrivers>] [B<-o> I<OS>] [B<-p>] [I<profile>] [B<-l> I<rootlimit>] [B<-k> I<kernel_version>] [B<--permission> I<permission>]
B<geninitrd> [B<-i> I<nodebootif>] [B<-n> I<nodenetdrivers>] [B<-o> I<OS>] [B<-p>] [I<profile>] [B<-l> I<rootlimit>] [B<-k> I<kernel_version>] [B<--permission> I<permission>] imagename
B<geninitrd> [B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
Regenerates the initrd that is part of a stateless image that is used to boot xCAT nodes in a diskless mode.
Regenerates the initrd that is part of a stateless/statelite image that is used to boot xCAT nodes in a stateless/statelite mode.
The generated initrd will be put in /install/netboot/<OS>/<arch>/<profile>.
The B<geninitrd> command must be run on a system that is the same architecture as the nodes it will be
@ -19,6 +21,8 @@ used on. If the management node is not the same architecture, copy the contents
/opt/xcat/share/xcat/netboot/<OS> to a system that is the proper architecture, and mount /install from
the management node to that system.
The B<geninitrd> command will generate two initial ramdisks, one is B<initrd-statelite.gz> for B<statelite> mode, the other one is B<initrd-stateless.gz> for B<stateless> mode.
=head1 OPTIONS
@ -93,4 +97,4 @@ To regenerate the initrd for a fedora8 image for a compute node architecture x86
=head1 SEE ALSO
L<genimage(1)|genimage.1>, L<packimage(1)|packimage.1>
L<genimage(1)|genimage.1>, L<packimage(1)|packimage.1>