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

Make formatting changes in the kit related manpages.

Browse Source
This commit is contained in:
Victor Hu 2016-01-25 14:50:05 -05:00
parent fa2237d141
commit b4c623f117
6 changed files with 70 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/source/guides/admin-guides/references/man1/addkit.1.rst
View File

@ -33,7 +33,7 @@ DESCRIPTION
The \ **addkit**\ command install a kit on the xCAT management node from a kit tarfile or directory, creating xCAT database definitions for kit, kitrepo, kitcomponent.
Note: The xCAT support for Kits is only available for Linux operating systems.
\ **Note:**\ xCAT Kit support is ONLY available for Linux operating systems.
*******
@ -68,13 +68,13 @@ OPTIONS
\ **-p|--path <path**\ >
The destination directory to which the contents of the kit tarfiles and/or kit deploy dirs will be copied. When this option is not specified, the default destination directory will be formed from the installdir site attribute with ./kits subdirectory.
The destination directory to which the contents of the kit tarfiles and/or kit deploy directories will be copied. When this option is not specified, the default destination directory will be formed from the installdir site attribute with ./kits subdirectory.
\ **kitlist**\
a comma delimited list of kit_tarball_files and kit_deploy_dirs that are to be added to the xCAT cluster. Each entry can be an absolute or relative path. For kit_tarball_files, these must be valid kits tarfiles added. For kit_deploy_dirs, these must be fully populated directory structures that are identical to the contents of an expanded kit_tarball_file.
A comma delimited list of kit_tarball_files and kit_deploy_dirs that are to be added to the xCAT cluster. Each entry can be an absolute or relative path. For kit_tarball_files, these must be valid kits tarfiles added. For kit_deploy_dirs, these must be fully populated directory structures that are identical to the contents of an expanded kit_tarball_file.
@ -96,38 +96,35 @@ EXAMPLES
1. To add two kits from tarball files.
addkit kit-test1.tar.bz2,kit-test2.tar.bz2
Output is similar to:
.. code-block:: perl
addkit kit-test1.tar.bz2,kit-test2.tar.bz2
Kit /kit/kit-test1.tar.bz2,/kit/kit-test2.tar.bz2 was successfully added.
2. To add two kits from directories.
addkit kit-test1,kit-test2
Output is similar to:
.. code-block:: perl
addkit kit-test1,kit-test2
Kit /kit/kit-test1,/kit/kit-test2 was successfully added.
3. To add a kit from tarball file to /install/test directory.
addkit -p /install/test kit-test1.tar.bz2
Output is similar to:
.. code-block:: perl
Kit /kit/kit-test1.tar.bz2 was successfully added.
addkit -p /install/test kit-test1.tar.bz2
4. To read the general infomration of the kit, without adding the kits to xCAT DB
addkit -i kit-test1.tar.bz2
4. To read the general information of the kit, without adding the kits to xCAT DB
Output is similar to:
kitname=xlc-12.1.0.0-Linux
description=XLC12 for Linux
version=12.1.0.0
ostype=Linux
.. code-block:: perl
addkit -i kit-test1.tar.bz2
********

43
docs/source/guides/admin-guides/references/man1/addkitcomp.1.rst
View File

@ -31,7 +31,7 @@ DESCRIPTION
The \ **addkitcomp**\ command will assign kit components to an xCAT osimage. The kit component meta rpm, package rpm and deploy parameters will be added to osimage's otherpkg.pkglist and postbootscripts will be added to osimages's postbootscripts attribute.
Note: The xCAT support for Kits is only available for Linux operating systems.
\ **Note:**\ xCAT Kit support is ONLY available for Linux operating systems.
*******
@ -112,48 +112,37 @@ EXAMPLES
********
1. To assign a kit component to osimage
1. To add a single kit component to osimage "rhels6.2-ppc64-netboot-compute":
addkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
.. code-block:: perl
Assigning kit component comp-test1-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Kit components comp-test1-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
addkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
2. To assign a kit component to osimage with its dependency.
addkitcomp -a -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
2. To add a kit component to osimage with dependencies, use the -a (addeps) option:
Output is similar to:
Assigning kit component comp-test1-1.0-1-rhels-6.0-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Assigning kit component comp-test2-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Kit components comp-test1-1.0-1-rhels-6.0-ppc64,comp-test2-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
.. code-block:: perl
3. To assign a kit component to osimage with incompatable osarch, osversion or ostype.
addkitcomp -a -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
addkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
3. To add a kit component to osimage with incompatable osarch, osversion or ostype, use the -f (force) option:
Assigning kit component comp-test1-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Kit components comp-test1-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
4. To assign a new version of kit component to osimage without upgrade.
.. code-block:: perl
addkitcomp -n -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
addkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
Assigning kit component comp-test1-1.0-1-rhels-6.0-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Assigning kit component comp-test2-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Kit components comp-test2-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
4. To add a new version of kit component to osimage without upgrade, use the -n (noupgrade) option:
.. code-block:: perl
addkitcomp -n -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
The result will be:
lsdef -t osimage rhels6.2-ppc64-netboot-compute -i kitcomponents
Object name: rhels6.2-ppc64-netboot-compute
kitcomponents=comp-test2-1.0-0-rhels-6.2-ppc64,comp-test2-1.0-1-rhels-6.2-ppc64
********

16
docs/source/guides/admin-guides/references/man1/chkkitcomp.1.rst
View File

@ -31,9 +31,9 @@ DESCRIPTION
The \ **chkkitcomp**\ command will check if the kit components are compatible with the xCAT osimage.
This command will ignore the current osimage.kitcomponents setting, and just to check if the kitcompname list in the cmdline are compatible with the osimage by osversion/ostype/osarch/ and kit component dependencies.
This command will ignore the current osimage.kitcomponents setting and check if the kitcompname_list is compatible with the osimage and kit component dependencies.
Note: The xCAT support for Kits is only available for Linux operating systems.
\ **Note:**\ xCAT Kit support is ONLY available for Linux operating systems.
*******
@ -62,13 +62,13 @@ OPTIONS
\ **-i**\ \ *osimage*\
The name of the osimage is used for check.
The name of the osimage to check against.
\ **kitcompname_list**\
A comma-delimited list of valid full kit component names or kit component basenames that are to be checking to the osimage.
A comma-delimited list of valid full kit component names or kit component basenames that are to be checked against the osimage.
@ -88,13 +88,13 @@ EXAMPLES
********
1. To check if a kit component is fitting to an osimage
1. To check if a kit component , \ *comp-test1-1.0-1-rhels-6.2-ppc64*\ can be added to osimage \ *rhels6.2-ppc64-netboot-compute*\ :
chkkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
.. code-block:: perl
chkkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Kit components comp-test1-1.0-1-rhels-6.2-ppc64 fit to osimage rhels6.2-ppc64-netboot-compute
********

47
xCAT-client/pods/man1/addkit.1.pod
View File

@ -1,6 +1,6 @@
=head1 NAME
B<addkit> - Install a kit on the xCAT management node
B<addkit> - Adds product software Kits to an xCAT cluster environmnet.
=head1 SYNOPSIS
@ -12,9 +12,10 @@ B<addkit> [B<-V>|B<--verbose>] [B<-p>|B<--path> I<path>] I<kitlist>
=head1 DESCRIPTION
The B<addkit> command install a kit on the xCAT management node from a kit tarfile or directory, creating xCAT database definitions for kit, kitrepo, kitcomponent.
The B<addkit> command installs a kit on the xCAT management node from a kit tarfile or directory.
It creates xCAT database definitions for the kit, kitrepo, and kitcomponent.
Note: The xCAT support for Kits is only available for Linux operating systems.
B<Note:> xCAT Kit support is ONLY available for Linux operating systems.
=head1 OPTIONS
@ -36,13 +37,13 @@ Command version.
Show the summary of the given kits
=item B<-p|--path <path>>
=item B<-p|--path <path>
The destination directory to which the contents of the kit tarfiles and/or kit deploy dirs will be copied. When this option is not specified, the default destination directory will be formed from the installdir site attribute with ./kits subdirectory.
The destination directory to which the contents of the kit tarfiles and/or kit deploy directories will be copied. When this option is not specified, the default destination directory will be formed from the installdir site attribute with ./kits subdirectory.
=item B<kitlist>
a comma delimited list of kit_tarball_files and kit_deploy_dirs that are to be added to the xCAT cluster. Each entry can be an absolute or relative path. For kit_tarball_files, these must be valid kits tarfiles added. For kit_deploy_dirs, these must be fully populated directory structures that are identical to the contents of an expanded kit_tarball_file.
A comma delimited list of kit_tarball_files or kit_deploy_directories to be added to the xCAT environment. Each entry can be an absolute or relative path. See xCAT documentation for more information on building kits.
=back
@ -54,40 +55,22 @@ a comma delimited list of kit_tarball_files and kit_deploy_dirs that are to be a
=head1 EXAMPLES
1. To add two kits from tarball files.
1. To add kits from tarball files:
addkit kit-test1.tar.bz2,kit-test2.tar.bz2
addkit kit-test1.tar.bz2,kit-test2.tar.bz2
Output is similar to:
2. To add kits from directories:
Kit /kit/kit-test1.tar.bz2,/kit/kit-test2.tar.bz2 was successfully added.
addkit kit-test1,kit-test2
2. To add two kits from directories.
3. To add kits from tarball 'kit-test1.tar.bz2' to target path '/install/test':
addkit kit-test1,kit-test2
addkit -p /install/test kit-test1.tar.bz2
Output is similar to:
4. To see general information about kit 'kit-test1.tar.bz2' without adding the kit to xCAT:
Kit /kit/kit-test1,/kit/kit-test2 was successfully added.
addkit -i kit-test1.tar.bz2
3. To add a kit from tarball file to /install/test directory.
addkit -p /install/test kit-test1.tar.bz2
Output is similar to:
Kit /kit/kit-test1.tar.bz2 was successfully added.
4. To read the general infomration of the kit, without adding the kits to xCAT DB
addkit -i kit-test1.tar.bz2
Output is similar to:
kitname=xlc-12.1.0.0-Linux
description=XLC12 for Linux
version=12.1.0.0
ostype=Linux
=head1 SEE ALSO

45
xCAT-client/pods/man1/addkitcomp.1.pod
View File

@ -12,7 +12,7 @@ B<addkitcomp> [B<-V>|B<--verbose>] [B<-a>|B<--adddeps>] [B<-f>|B<--force>] [B<-n
The B<addkitcomp> command will assign kit components to an xCAT osimage. The kit component meta rpm, package rpm and deploy parameters will be added to osimage's otherpkg.pkglist and postbootscripts will be added to osimages's postbootscripts attribute.
Note: The xCAT support for Kits is only available for Linux operating systems.
B<Note:> xCAT Kit support is ONLY available for Linux operating systems.
=head1 OPTIONS
@ -66,48 +66,21 @@ A comma-delimited list of valid full kit component names or kit component basena
=head1 EXAMPLES
1. To assign a kit component to osimage
1. To add a single kit component to osimage "rhels6.2-ppc64-netboot-compute":
addkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
addkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
2. To add a kit component to osimage with dependencies, use the -a (addeps) option:
Assigning kit component comp-test1-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Kit components comp-test1-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
addkitcomp -a -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
2. To assign a kit component to osimage with its dependency.
3. To add a kit component to osimage with incompatable osarch, osversion or ostype, use the -f (force) option:
addkitcomp -a -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
addkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
4. To add a new version of kit component to osimage without upgrade, use the -n (noupgrade) option:
Assigning kit component comp-test1-1.0-1-rhels-6.0-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Assigning kit component comp-test2-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Kit components comp-test1-1.0-1-rhels-6.0-ppc64,comp-test2-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
3. To assign a kit component to osimage with incompatable osarch, osversion or ostype.
addkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
Assigning kit component comp-test1-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Kit components comp-test1-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
4. To assign a new version of kit component to osimage without upgrade.
addkitcomp -n -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
Output is similar to:
Assigning kit component comp-test1-1.0-1-rhels-6.0-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Assigning kit component comp-test2-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
Kit components comp-test2-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
The result will be:
lsdef -t osimage rhels6.2-ppc64-netboot-compute -i kitcomponents
Object name: rhels6.2-ppc64-netboot-compute
kitcomponents=comp-test2-1.0-0-rhels-6.2-ppc64,comp-test2-1.0-1-rhels-6.2-ppc64
addkitcomp -n -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
=head1 SEE ALSO

15
xCAT-client/pods/man1/chkkitcomp.1.pod
View File

@ -12,9 +12,9 @@ B<chkkitcomp> [B<-V>|B<--verbose>] B<-i> I<osimage> I<kitcompname_list>
The B<chkkitcomp> command will check if the kit components are compatible with the xCAT osimage.
This command will ignore the current osimage.kitcomponents setting, and just to check if the kitcompname list in the cmdline are compatible with the osimage by osversion/ostype/osarch/ and kit component dependencies.
This command will ignore the current osimage.kitcomponents setting and check if the kitcompname_list is compatible with the osimage and kit component dependencies.
Note: The xCAT support for Kits is only available for Linux operating systems.
B<Note:> xCAT Kit support is ONLY available for Linux operating systems.
=head1 OPTIONS
@ -34,11 +34,11 @@ Command version.
=item B<-i> I<osimage>
The name of the osimage is used for check.
The name of the osimage to check against.
=item B<kitcompname_list>
A comma-delimited list of valid full kit component names or kit component basenames that are to be checking to the osimage.
A comma-delimited list of valid full kit component names or kit component basenames that are to be checked against the osimage.
=back
@ -50,13 +50,10 @@ A comma-delimited list of valid full kit component names or kit component basena
=head1 EXAMPLES
1. To check if a kit component is fitting to an osimage
1. To check if a kit component , I<comp-test1-1.0-1-rhels-6.2-ppc64> can be added to osimage I<rhels6.2-ppc64-netboot-compute>:
chkkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
chkkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
Kit components comp-test1-1.0-1-rhels-6.2-ppc64 fit to osimage rhels6.2-ppc64-netboot-compute
=head1 SEE ALSO