xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 17:23:08 +00:00
Code Issues Releases Wiki Activity

remove install/netboot/statelite from the manpages of genimage,packimage,nodeset and imgcapture

Browse Source
This commit is contained in:
ligc 2015-05-14 04:29:23 -04:00
parent 4322c2b553
commit 74cb3470eb
4 changed files with 9 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,8 +8,6 @@ B<genimage>
B<genimage> [B<-o> I<osver>] [B<-a> I<arch>] [B<-p> I<profile>] [B<-i> I<nodebootif>] [B<-n> I<nodenetdrivers>] [B<--onlyinitrd>] [B<-r> I<otherifaces>] [B<-k> I<kernelver>] [B<-g> I<krpmver>] [B<-m> I<statelite>] [B<-l> I<rootlimitsize>] [B<--permission> I<permission>] [B<--interactive>] [B<--dryrun>] [B<--ignorekernelchk>] [B<--noupdate>] I<imagename>
B<genimage> B<-o> I<osver> [B<-a> I<arch>] B<-p> I<profile> B<-i> I<nodebootif> B<-n> I<nodenetdrivers> [B<--onlyinitrd>] [B<-r> I<otherifaces>] [B<-k> I<kernelver>] [B<-g> I<krpmver>] [B<-m> I<statelite>] [B<-l> I<rootlimitsize>] [B<--permission> I<permission>] [B<--interactive>] [B<--dryrun>] [B<--noupdate>]
B<genimage> [B<-h> | B<--help> | B<-v> | B<--version>]
@ -18,27 +16,7 @@ B<genimage> [B<-h> | B<--help> | B<-v> | B<--version>]
Generates a stateless and a statelite image that can be used to boot xCAT nodes in a diskless mode.
The I<imagename> format of the command is recommended. When specified, genimage will use the osimage definition for information to generate this image. Additional options specified on the command line will override any corresponding previous osimage settings, and will be written back to the osimage definition.
If I<imagename> is not specified (old method):
- the default packages included (and excluded) in the image are specified by
/opt/xcat/share/xcat/netboot/<os>/<profile>[.<osver>][.<arch>].pkglist and
/opt/xcat/share/xcat/netboot/<os>/<profile>[.<osver>][.<arch>].exlist.
- Additional packages that are not from the os distro can be specified in a
/opt/xcat/share/xcat/netboot/<os>/<profile>[.<osver>][.<arch>].otherpkgs.pkglist file.
- Customized package list files will override these files and can be specified under /install/custom/netboot/<os> directory.
- The generated image will be put in /install/netboot/<osver>/<arch>/<profile> directory.
- osimage definitions will be created in the I<linuximage> and I<osimage> tables. The newly generated image names will have the following format:
for stateless: <osver>-<arch>-netboot-<profile>
for statelite: <osver>-<arch>-statelite-<profile>
genimage will use the osimage definition for information to generate this image. Additional options specified on the command line will override any corresponding previous osimage settings, and will be written back to the osimage definition.
If B<genimage> runs on the management node, both the I<osimage> table and I<linuximage> table will be updated with the given values from the options.
@ -112,7 +90,6 @@ Regenerates the initrd for a stateless image to be used for a diskless install.
Regenerates the initrd that is part of a stateless/statelite image that is used to boot xCAT nodes in a stateless/stateli
te mode.
The generated initrd will be put in /install/netboot/<OS>/<arch>/<profile>.
The B<genimage --onlyinitrd> 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.
@ -205,36 +182,6 @@ To generate an image, replacing some values in the osimage definition:
genimage -i eth0 -n tg3 myimagename
=item 6
(old method) To generate a fedora8 image for a compute node architecture
x86_64 and place it in the
/install/netboot/fedora8/x86_64/compute/rootimg directory:
genimage -i eth0 -o fedora8 -p compute
=item 7
(old method)
genimage -i eth0 -r eth1,eth2 -n tg3,bnx2 -o centos5.1 -p compute
=item 8
(old method)
genimage -i eth0 -n tg3,bnx2 -o sles11 -p compute --interactive
=item 9
(old method)
genimage -i eth0 -n igb,e1000e,e1000,bnx2,tg3 -o centos5.4 -p nfsroot --permission 777
=item 10
(old method)
To regenerate the initrd for a fedora8 image for a compute node architecture x86_64 and place it in the /install/netboot/fedora8/x86_64/compute/rootimg directory:
cd /opt/xcat/share/xcat/netboot/fedora
./genimage --onlyinitrd -i eth0 -n tg3,bnx2 -o fedora8 -p compute
=back

22
xCAT-client/pods/man1/imgcapture.1.pod
View File

@ -4,9 +4,7 @@ B<imgcapture> - Captures an image from a Linux diskful node and create a diskles
=head1 SYNOPSIS
B<imgcapture> node B<-t>|B<--type> diskless [B<-p>|B<--profile> I<profile>] [B<-o>|B<--osimage> I<osimage>] [B<-i> I<nodebootif>] [B<-n> I<nodenetdrivers>] [B<-V>|B<--verbose>]
B<imgcapture> node B<-t>|B<--type> sysclone B<-o>|B<--osimage> I<osimage> [B<-V>|B<--verbose>]
B<imgcapture> node B<-t>|B<--type> {diskless|sysclone} B<-o>|B<--osimage> I<osimage> [B<-V>|B<--verbose>]
B<imgcapture> [B<-h> | B<--help>] | [B<-v> | B<--version>]
@ -20,7 +18,7 @@ The B<imgcapture> command supports two image types: B<diskless> and B<sysclone>.
The B<diskless> type:
The I<osimage> is pre-defined, the attributes of osimage will be used to capture and prepare the root image. The B<osver>, B<arch> and B<profile> attributes for the stateless/statelite image to be created are duplicated from the B<node>'s attribute. If the B<-p|--profile> I<profile> option is specified, the image will be created under "/<I<installroot>>/netboot/<osver>/<arch>/<I<profile>>/rootimg".
The attributes of osimage will be used to capture and prepare the root image. The B<osver>, B<arch> and B<profile> attributes for the stateless/statelite image to be created are duplicated from the B<node>'s attribute. If the B<-p|--profile> I<profile> option is specified, the image will be created under "/<I<installroot>>/netboot/<osver>/<arch>/<I<profile>>/rootimg".
The default files/directories excluded in the image are specified by /opt/xcat/share/xcat/netboot/<os>/<I<profile>>.<osver>.<arch>.imgcapture.exlist; also, you can put your customized file (<I<profile>>.<osver>.<arch>.imgcapture.exlist) to /install/custom/netboot/<osplatform>. The directories in the default I<.imgcapture.exlist> file are necessary to capture image from the diskful Linux node managed by xCAT, please don't remove it.
@ -100,23 +98,11 @@ Verbose output.
B<node1> is one diskful Linux node, which is managed by xCAT.
1. In order to capture and prepare the diskless root image, run the following command:
imgcapture node1 -t diskless
2. In order to capture and prepare the diskless root image with B<hpc> as profile, run the command:
imgcapture node1 -t diskless -p hpc
3. In order to capture and prepare the diskless root image: its profile is B<hpc>, and the network interface the diskless node will boot over is B<eth0>, the driver modules for this network interface is B<e1000e>.
imgcapture node1 -t diskless -p hpc -i eth0 -n e1000e
4. There's one pre-defined I<osimage>. In order to capture and prepare the diskless root image for I<osimage>, run the command:
1. There's one pre-defined I<osimage>. In order to capture and prepare the diskless root image for I<osimage>, run the command:
imgcapture node1 -t diskless -o osimage
5. In order to capture the diskful image from B<node1> and create the I<osimage> B<img1>, run the command:
2. In order to capture the diskful image from B<node1> and create the I<osimage> B<img1>, run the command:
imgcapture node1 -t sysclone -o img1

11
xCAT-client/pods/man1/packimage.1.pod
View File

@ -8,9 +8,6 @@ I<packimage [-h| --help]>
I<packimage [-v| --version]>
I<packimage [-o OS] [ -p profile] [-a architecture] [-m method]>
I<packimage imagename>
=head1 DESCRIPTION
@ -20,8 +17,7 @@ sent to the node for a diskless install.
The install dir is setup by using "installdir" attribute set in the site table.
The nodetype table "profile" attribute for the node should reflect the profile of the install image.
If no I<imagename> is specified, this command uses the os image definition files from /install/custom/netboot/[os] directory first. If not found, it falls back to the default directory /opt/xcat/share/xcat/netboot/[os].
If a I<imagename> is specified, this command will get all the necessary os image definition files from the I<osimage> and I<linuximage> tables.
This command will get all the necessary os image definition files from the I<osimage> and I<linuximage> tables.
=head1 Parameters
@ -51,11 +47,10 @@ B<-m> Method (default cpio)
=head1 EXAMPLES
1. To pack a fedora8 image for a compute node architecture x86_64 and place it in the /install/netboot/fedora8/x86_64/compute/rootimg.gz file enter:
1. To pack the osimage rhels7.1-x86_64-netboot-compute:
I<packimage -o fedora8 -p compute -a x86_64>
I<packimage rhels7.1-x86_64-netboot-compute>
This would use the package information from the /install/custom/netboot/fedora/compute* files first. If not found it uses /opt/xcat/share/xcat/netboot/fedora/compute* files.
=head1 FILES

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

@ -4,7 +4,7 @@ B<nodeset> - set the boot state for a noderange
=head1 B<Synopsis>
B<nodeset> [I<noderange>] [I<boot>|I<install>|I<stat>|I<iscsiboot>|I<netboot>|I<statelite>|I<offline>|I<runcmd=bmcsetup>|I<osimage[=<imagename>>]|I<shell>|I<shutdown>]
B<nodeset> [I<noderange>] [I<boot>|I<stat>|I<iscsiboot>|I<offline>|I<runcmd=bmcsetup>|I<osimage[=<imagename>>]|I<shell>|I<shutdown>]
B<nodeset> I<noderange> I<osimage=<imagename>> [I<--noupdateinitrd>] [I<--ignorekernelchk>]
@ -43,24 +43,6 @@ A user can supply their own scripts to be run on the mn or on the service node (
Instruct network boot loader to be skipped, generally meaning boot to hard disk
=item B<install>|B<install=profilename>|B<install=<os-architecture-profilename>>
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.
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>
Cleanup the current pxe/tftp boot configuration files for the nodes requested