2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 17:23:08 +00:00

Merge pull request #6382 from gurevichmark/no_kit_links

Remove kit links
This commit is contained in:
Mark Gurevich 2019-07-22 17:15:31 -04:00 committed by GitHub
commit d018408f41
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 0 additions and 7032 deletions

View File

@ -1,137 +0,0 @@
########
addkit.1
########
.. highlight:: perl
****
NAME
****
\ **addkit**\ - Adds product software Kits to an xCAT cluster environmnet.
********
SYNOPSIS
********
\ **addkit**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ]
\ **addkit**\ [\ **-i | -**\ **-inspection**\ ] \ *kitlist*\
\ **addkit**\ [\ **-V | -**\ **-verbose**\ ] [\ **-p | -**\ **-path**\ \ *path*\ ] \ *kitlist*\
***********
DESCRIPTION
***********
The \ **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:**\ xCAT Kit support is ONLY available for Linux operating systems.
*******
OPTIONS
*******
\ **-h|-**\ **-help**\
Display usage message.
\ **-V|-**\ **-verbose**\
Verbose mode.
\ **-v|-**\ **-version**\
Command version.
\ **-i|-**\ **-inspection**\
Show the summary of the given kits
\ **-p|-**\ **-path**\ \ *path*\
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 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.
************
RETURN VALUE
************
0 The command completed successfully.
1 An error has occurred.
********
EXAMPLES
********
1. To add kits from tarball files:
.. code-block:: perl
addkit kit-test1.tar.bz2,kit-test2.tar.bz2
2. To add kits from directories:
.. code-block:: perl
addkit kit-test1,kit-test2
3. To add kits from tarball \ *kit-test1.tar.bz2*\ to target path \ */install/test*\ :
.. code-block:: perl
addkit -p /install/test kit-test1.tar.bz2
4. To see general information about kit \ *kit-test1.tar.bz2*\ without adding the kit to xCAT:
.. code-block:: perl
addkit -i kit-test1.tar.bz2
********
SEE ALSO
********
lskit(1)|lskit.1, rmkit(1)|rmkit.1, addkitcomp(1)|addkitcomp.1, rmkitcomp(1)|rmkitcomp.1, chkkitcomp(1)|chkkitcomp.1

View File

@ -1,154 +0,0 @@
############
addkitcomp.1
############
.. highlight:: perl
****
NAME
****
\ **addkitcomp**\ - Assign Kit components to an xCAT osimage.
********
SYNOPSIS
********
\ **addkitcomp**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ]
\ **addkitcomp**\ [\ **-V | -**\ **-verbose**\ ] [\ **-a | -**\ **-adddeps**\ ] [\ **-f | -**\ **-force**\ ] [\ **-n | -**\ **-noupgrade**\ ] [\ **-**\ **-noscripts**\ ] \ **-i**\ \ *osimage*\ \ *kitcompname_list*\
***********
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:**\ xCAT Kit support is ONLY available for Linux operating systems.
*******
OPTIONS
*******
\ **-a|-**\ **-adddeps**\
Assign kitcomponent dependencies to the osimage.
\ **-h|-**\ **-help**\
Display usage message.
\ **-V|-**\ **-verbose**\
Verbose mode.
\ **-v|-**\ **-version**\
Command version.
\ **-f|-**\ **-force**\
Add kit component to osimage even if there is a mismatch in OS, version, arch, serverrole, or kitcompdeps
\ **-i**\ \ *osimage*\
The osimage name that the kit component is assigning to.
\ **-n|-**\ **-noupgrade**\
1. Allow multiple versions of kitcomponent to be installed into the osimage, instead of kitcomponent upgrade.
2. Kit components added by addkitcomp -n will be installed separately behind all other ones which have been added.
\ **-**\ **-noscripts**\
Do not add kitcomponent's postbootscripts to osimage
\ *kitcompname_list*\
A comma-delimited list of valid full kit component names or kit component basenames that are to be added to the osimage.
************
RETURN VALUE
************
0 The command completed successfully.
1 An error has occurred.
********
EXAMPLES
********
1. To add a single kit component to osimage "rhels6.2-ppc64-netboot-compute":
.. code-block:: perl
addkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
2. To add a kit component to osimage with dependencies, use the -a (addeps) option:
.. code-block:: perl
addkitcomp -a -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
3. To add a kit component to osimage with incompatable osarch, osversion or ostype, use the -f (force) option:
.. code-block:: perl
addkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
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
********
SEE ALSO
********
lskit(1)|lskit.1, addkit(1)|addkit.1, rmkit(1)|rmkit.1, rmkitcomp(1)|rmkitcomp.1, chkkitcomp(1)|chkkitcomp.1

View File

@ -1,372 +0,0 @@
##########
buildkit.1
##########
.. highlight:: perl
****
NAME
****
\ **buildkit**\ - Used to build a software product Kit which may be used to install software in an xCAT cluster.
********
SYNOPSIS
********
\ **buildkit**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ]
To build a new Kit
\ **buildkit**\ [\ **-V | -**\ **-verbose]**\ \ *subcommand*\ [\ *kit_name*\ ] [\ *repo_name*\ | \ **all**\ ] [\ **-l | -**\ **-kitloc**\ \ *kit_location*\ ]
To add packages to an existing Kit.
\ **buildkit**\ [\ **-V | -**\ **-verbose**\ ] \ *addpkgs*\ \ *kit_tarfile*\ [\ **-p | -**\ **-pkgdir**\ \ *package_directory_list*\ ] [\ **-k | -**\ **-kitversion**\ \ *version*\ ] [\ **-r | -**\ **-kitrelease**\ \ *release*\ ] [\ **-l | -**\ **-kitloc**\ \ *kit_location*\ ]
***********
DESCRIPTION
***********
The \ **buildkit**\ command provides a collection of utilities that may be used to package a software product as a Kit tarfile that can be used to install software on the nodes of an xCAT cluster. A Kit contains the product software packages, configuration and control information, and install and customization scripts.
Note: The xCAT support for Kits is only available for Linux operating systems.
You will need to run the \ **buildkit**\ command several times with different subcommands to step through the process of building a kit:
By default the \ **buildkit**\ subcommands will operate in the current working directory, (ie. look for files, create directories etc.). You could specify a different location by using the "\ **-l | -**\ **-kitloc**\ \ *kit_location*\ " option.
The \ *kit_location*\ is the full path name of the directory that contains the kit files. You would use the same location value for all the buildkit subcommands.
For example, to create a new kit named "prodkit" in the directory /home/mykits/ \ *either*\ run:
1.
If no location is provided then the command will create a subdirectory called "prodkit" in the current directory "/home/mykits" and the new kit files will be created there.
\ **cd /home/mykits**\
\ **buildkit create prodkit**\
or
2.
If a location is provided then the Kit files will be created there. Note that the Kit name does not necessarily have to be the directory name where the kit files are located.
\ **buidkit create prodkit -l /home/mykits/prodkit**\
In both cases the /home/mykits/prodkit directory is created and the inital files for the kit are created in that directory.
The following example illustrates the basic process for building a new Kit. In this example we are building a Kit named "mytstkit".
1.
Change to the directory where you wish to create the Kit.
2.
Create a template directory for your kit:
\ **buildkit create mytstkit**\
3.
Change directory to the new "mytstkit" subdirectory that was just created.
\ **cd mytstkit**\
4.
Edit the buildkit configuration file for your kit:
\ **vi buildkit.conf**\
(See xCAT Kit documentation for details.)
5.
Create all required files, scripts, plugins, and packages for your kit.
6.
Validate your kit build configuration and fix any errors that are reported:
\ **buildkit chkconfig**\
7.
List the repos defined in your buildkit configuration file:
\ **buildkit listrepo**\
8.
For each repo name listed, build the repository. Note that if you need to build repositories for OS distributions, versions, or architectures that do not match the current system, you may need to copy your kit template directory to an appropriate server to build that repository, and then copy the results back to your main build server. For example, to build a repo named "rhels6.3" you would run the following command.
\ **buildkit buildrepo rhels6.3**\
or, you can build all of the repos at one time if there are no OS or architecture dependencies for kitcomponent package builds or kitpackage builds:
\ **buildkit buildrepo all**\
9.
Build the kit tar file:
\ **buildkit buildtar**\
*******
OPTIONS
*******
\ **-h |-**\ **-help**\
Display usage message.
\ **-k|-**\ **-kitversion**\ \ *version*\
Product version.
\ **-l|-**\ **-kitloc**\ \ *kit_location*\
The directory location of the Kit files.
\ **-p|-**\ **-pkgdir**\ \ *package_directory_list*\
A comma-separated list of directory locations for product RPMs.
\ **-r|-**\ **-kitrelease**\ \ *release*\
Product release.
\ **-V |-**\ **-verbose**\
Verbose mode.
\ **-v|-**\ **-version**\
Command version.
************
SUB-COMMANDS
************
\ **create**\ \ *kit_basename*\
Creates a new kit build directory structure for kit \ *kit_basename*\ using the location specified on the command line or the current directory. The sample kit files from /opt/xcat/share/xcat/kits/kit_template are copied over, and the buildkit.conf file is modified for the specified \ *kit_basename*\ .
\ **chkconfig**\
Reads the buildkit.conf file, verifies that the file syntax is correct and that all specified files exist.
\ **listrepo**\
Reads the buildkit.conf file, lists all Kit package repositories listed in the file, and reports the build status for each repository.
\ **buildrepo**\ {\ *repo_name*\ | \ **all**\ }
Reads the buildkit.conf file, and builds the specified Kit package repository. The built packages are placed in the directory <kit_location>/build/kit_repodir/\ *repo_name*\ . If \ **all**\ is specified, all kit repositories are built.
\ **cleanrepo**\ {\ *repo_name*\ | \ **all**\ }
Reads the buildkit.conf file, and deletes all the package files and package meta data files from the <kit_location>/build/kit_repodir/\ *repo_name*\ directory. If \ **all**\ is specified, all kit repository files are deleted.
\ **buildtar**\
Reads the buildkit.conf file, validates that all kit repositories have been built, and builds the Kit tar file <kit_location>/\ *kitname*\ .tar.bz2.
\ **cleantar**\
Reads the <kit_location>/buildkit.conf file and \ *deletes*\ the following:
- Kit tar files matching <kit_location>/\ *kit_name\\*.tar.bz2*\ .
- <kit_location>/build/\ *kit_name*\
- <kit_location>/rpmbuild
- <kit_location>/tmp
- <kit_location>/debbuild
Caution: Make sure you back up any tar files you would like to keep before running this subcommand.
\ **cleanall**\
Equivalent to running \ **buildkit cleanrepo all**\ and \ **buildkit cleantar**\ .
\ **addpkgs**\
\ *kit_tarfile*\ {\ **-p**\ | \ **-**\ **-pkgdir**\ \ *package_directory_list*\ } [\ **-k**\ | \ **-**\ **-kitversion**\ \ *version*\ ] [\ **-r**\ | \ **-**\ **-kitrelease**\ \ *release*\ ]
Add product package rpms to a previously built kit tar file. This is used for partial product kits that are built and shipped separately from the product packages, and are identified with a \ *kit_tarfile*\ name of \ *kitname*\ .\ **NEED_PRODUCT_PKGS.tar.bz2**\ . Optionally, change the kit release and version values when building the new kit tarfile. If kitcomponent version and/or release values are defaulted to the kit values, those will also be changed and new kitcomponent rpms will be built. If kit or kitcomponent scripts, plugins, or other files specify name, release, or version substitution strings, these will all be replaced with the new values when built into the new complete kit tarfile \ *kit_location*\ /\ *new_kitname*\ .\ **tar.bz2**\ .
************
RETURN VALUE
************
<B>0
The command completed successfully.
<B>1
An error has occurred.
********
EXAMPLES
********
1.
To create the sample kit shipped with the xCAT-buildkit rpm on a RHELS 6.3 server and naming it \ **mykit**\ , run the following commands:
\ **cd /home/myuserid/kits**\
\ **buildkit create mykit**\
\ **cd mykit**\
\ **vi buildkit.conf**\
\ **buildkit chkconfig**\
\ **buildkit listrepo**\
\ **buildkit buildrepo all**\
\ **buildkit buildtar**\
2.
To clean up a kit repository directory after build failures on a RHELS 6.3 server to prepare for a new kit repository build, run:
\ **buildkit cleanrepo rhels6.3**\
3.
To clean up all kit build files, including a previously built kit tar file, run
\ **buildkit cleanall**\
4.
To create a kit named "tstkit" located in /home/foobar/tstkit instead of the current working directory.
\ **buildkit create tstkit -l /home/foobar/tstkit**\
*****
FILES
*****
/opt/xcat/bin/buildkit
/opt/xcat/share/xcat/kits/kit_template
/opt/xcat/share/xcat/kits/kitcomponent.spec.template
<kit location>/buildkit.conf
<kit location>/build/\ *kitname*\ /kit.conf
<kit location>/\ *kitname*\ .tar.bz2
********
SEE ALSO
********
addkit(1), lskit(1), rmkit(1), addkitcomp(1), rmkitcomp(1), chkkitcomp(1)

View File

@ -1,106 +0,0 @@
############
chkkitcomp.1
############
.. highlight:: perl
****
NAME
****
\ **chkkitcomp**\ - Check if Kit components are compatible with an xCAT osimage.
********
SYNOPSIS
********
\ **chkkitcomp**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ]
\ **chkkitcomp**\ [\ **-V | -**\ **-verbose**\ ] \ **-i**\ \ *osimage*\ \ *kitcompname_list*\
***********
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 check if the kitcompname_list is compatible with the osimage and kit component dependencies.
\ **Note:**\ xCAT Kit support is ONLY available for Linux operating systems.
*******
OPTIONS
*******
\ **-h|-**\ **-help**\
Display usage message.
\ **-V|-**\ **-verbose**\
Verbose mode.
\ **-v|-**\ **-version**\
Command version.
\ **-i**\ \ *osimage*\
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 checked against the osimage.
************
RETURN VALUE
************
0 The command completed successfully.
1 An error has occurred.
********
EXAMPLES
********
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*\ :
.. code-block:: perl
chkkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
********
SEE ALSO
********
lskit(1)|lskit.1, addkit(1)|addkit.1, rmkit(1)|rmkit.1, addkitcomp(1)|addkitcomp.1, rmkitcomp(1)|rmkitcomp.1

View File

@ -1,250 +0,0 @@
#######
lskit.1
#######
.. highlight:: perl
****
NAME
****
\ **lskit**\ - Lists information for one or more Kits.
********
SYNOPSIS
********
\ **lskit**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] [\ **-F**\ | \ **-**\ **-framework**\ \ *kitattr_names*\ ] [\ **-x**\ | \ **-**\ **-xml**\ | \ **-**\ **-XML**\ ] [\ **-K**\ | \ **-**\ **-kitattr**\ \ *kitattr_names*\ ] [\ **-R**\ | \ **-**\ **-repoattr**\ \ *repoattr_names*\ ] [\ **-C**\ | \ **-**\ **-compattr**\ \ *compattr_names*\ ] [\ *kit_names*\ ]
\ **lskit**\ [\ **-?**\ | \ **-h**\ | \ **-**\ **-help**\ | \ **-v**\ | \ **-**\ **-version**\ ]
\ **lskit**\ [\ **-F**\ | \ **-**\ **-framework**\ \ *kit_path_name*\ ]
***********
DESCRIPTION
***********
The \ **lskit**\ command is used to list information for one or more kits. A kit is a special kind of package that is used to install a software product on one or more nodes in an xCAT cluster.
Note: The xCAT support for Kits is only available for Linux operating systems.
The \ **lskit**\ command outputs the following info for each kit: the kit's basic info, the kit's repositories, and the kit's components. The command outputs the info in two formats: human-readable format (default), and XML format. Use the -x option to view the info in XML format.
Input to the command can specify any number or combination of the input options.
*******
OPTIONS
*******
\ **-F|-**\ **-framework**\ \ *kit_path_name*\
Use this option to display the framework values of the specified Kit tarfile. This information is retreived directly from the tarfile and can be done before the Kit has been defined in the xCAT database. This option cannot be combined with other options.
\ **-K|-**\ **-kitattr**\ \ *kitattr_names*\
Where \ *kitattr_names*\ is a comma-delimited list of kit attribute names. The names correspond to attribute names in the \ **kit**\ table. The \ **lskit**\ command will only display the specified kit attributes.
\ **-R|-**\ **-repoattr**\ \ *repoattr_names*\
Where \ *repoattr_names*\ is a comma-delimited list of kit repository attribute names. The names correspond to attribute names in the \ **kitrepo**\ table. The \ **lskit**\ command will only display the specified kit repository attributes.
\ **-C|-**\ **-compattr**\ \ *compattr_names*\
where \ *compattr_names*\ is a comma-delimited list of kit component attribute names. The names correspond to attribute names in the \ **kitcomponent**\ table. The \ **lskit**\ command will only display the specified kit component attributes.
\ *kit_names*\
is a comma-delimited list of kit names. The \ **lskit**\ command will only display the kits matching these names.
\ **-x|-**\ **-xml|-**\ **-XML**\
Need XCATXMLTRACE=1 env when using -x|--xml|--XML, for example: XCATXMLTRACE=1 lskit -x testkit-1.0.0
Return the output with XML tags. The data is returned as:
.. code-block:: perl
<data>
<kitinfo>
...
</kitinfo>
</data>
...
<data>
<kitinfo>
...
</kitinfo>
</data>
Each <kitinfo> tag contains info for one kit. The info inside <kitinfo> is structured as follows:
.. code-block:: perl
The <kit> sub-tag contains the kit's basic info.
The <kitrepo> sub-tags store info about the kit's repositories.
The <kitcomponent> sub-tags store info about the kit's components.
The data inside <kitinfo> is returned as:
.. code-block:: perl
<kitinfo>
<kit>
...
</kit>
<kitrepo>
...
</kitrepo>
...
<kitcomponent>
...
</kitcomponent>
...
</kitinfo>
\ **-V|-**\ **-verbose**\
Display additional progress and error messages.
\ **-v|-**\ **-version**\
Command Version.
\ **-?|-h|-**\ **-help**\
Display usage message.
************
RETURN VALUE
************
0 The command completed successfully.
1 An error has occurred.
********
EXAMPLES
********
1. To list all kits, enter:
.. code-block:: perl
lskit
2. To list the kit "kit-test1-1.0-Linux", enter:
.. code-block:: perl
lskit kit-test1-1.0-Linux
3. To list the kit "kit-test1-1.0-Linux" for selected attributes, enter:
.. code-block:: perl
lskit -K basename,description -R kitreponame -C kitcompname kit-test1-1.0-Linux
4. To list the framework value of a Kit tarfile.
.. code-block:: perl
lskit -F /myhome/mykits/pperte-1.3.0.2-0-x86_64.tar.bz2
Output is similar to:
.. code-block:: perl
Extracting the kit.conf file from /myhome/mykits/pperte-1.3.0.2-0-x86_64.tar.bz2. Please wait.
kitframework=2
compatible_kitframeworks=0,1,2
5. To list kit "testkit-1.0-1" with XML tags, enter:
.. code-block:: perl
XCATXMLTRACE=1 lskit -x testkit-1.0-1
*****
FILES
*****
/opt/xcat/bin/lskit
********
SEE ALSO
********
lskitcomp(1)|lskitcomp.1, lskitdeployparam(1)|lskitdeployparam.1, addkit(1)|addkit.1, rmkit(1)|rmkit.1, addkitcomp(1)|addkitcomp.1, rmkitcomp(1)|rmkitcomp.1

View File

@ -1,247 +0,0 @@
###########
lskitcomp.1
###########
.. highlight:: perl
****
NAME
****
\ **lskitcomp**\ - Used to list information for one or more kit components.
********
SYNOPSIS
********
\ **lskitcomp**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] [\ **-x**\ | \ **-**\ **-xml**\ | \ **-**\ **-XML**\ ] [\ **-C**\ | \ **-**\ **-compattr**\ \ *compattr_names*\ ] [\ **-O**\ | \ **-**\ **-osdistro**\ \ *os_distro*\ ] [\ **-S**\ | \ **-**\ **-serverrole**\ \ *server_role*\ ] [\ *kitcomp_names*\ ]
\ **lskitcomp**\ [\ **-?**\ | \ **-h**\ | \ **-**\ **-help**\ | \ **-v**\ | \ **-**\ **-version**\ ]
***********
DESCRIPTION
***********
The \ **lskitcomp**\ command is used to list information for one or more kit components. A kit is made up of one or more kit components. Each kit component is a meta package used to install a software product component on one or more nodes in an xCAT cluster.
The \ **lskitcomp**\ command outputs the kit component info in two formats: human-readable format (default), and XML format. Use the -x option to view the info in XML format.
Input to the command can specify any number or combination of the input options.
Note: The xCAT support for Kits is only available for Linux operating systems.
*******
OPTIONS
*******
\ **-C|-**\ **-compattr**\ \ *compattr_names*\
where \ *compattr_names*\ is a comma-delimited list of kit component attribute names. The names correspond to attribute names in the \ **kitcomponent**\ table. The \ **lskitcomp**\ command will only display the specified kit component attributes.
\ **-O|-**\ **-osdistro**\ \ *os_distro*\
where \ *os_distro*\ is the name of an osdistro in \ **osdistro**\ table. The \ **lskitcomp**\ command will only display the kit components matching the specified osdistro.
\ **-S|-**\ **-serverrole**\ \ *server_role*\
where \ *server_role*\ is the name of a server role. The typical server roles are: mgtnode, servicenode, computenode, loginnode, storagennode. The \ **lskitcomp**\ command will only display the kit components matching the specified server role.
\ *kitcomp_names*\
is a comma-delimited list of kit component names. The \ **lskitcomp**\ command will only display the kit components matching the specified names.
\ **-x|-**\ **-xml|-**\ **-XML**\
Need XCATXMLTRACE=1 env when using -x|--xml|--XML.
Return the output with XML tags. The data is returned as:
.. code-block:: perl
<data>
<kitinfo>
...
</kitinfo>
</data>
...
<data>
<kitinfo>
...
</kitinfo>
</data>
Each <kitinfo> tag contains info for a group of kit components belonging to the same kit. The info inside <kitinfo> is structured as follows:
.. code-block:: perl
The <kit> sub-tag contains the kit's name.
The <kitcomponent> sub-tags store info about the kit's components.
The data inside <kitinfo> is returned as:
.. code-block:: perl
<kitinfo>
<kit>
...
</kit>
<kitcomponent>
...
</kitcomponent>
...
</kitinfo>
\ **-V|-**\ **-verbose**\
Display additional progress and error messages.
\ **-v|-**\ **-version**\
Command Version.
\ **-?|-h|-**\ **-help**\
Display usage message.
************
RETURN VALUE
************
0 The command completed successfully.
1 An error has occurred.
********
EXAMPLES
********
1.
To list all kit components, enter:
.. code-block:: perl
lskitcomp
2.
To list the kit component "comp-server-1.0-1-rhels-6-x86_64", enter:
.. code-block:: perl
lskitcomp comp-server-1.0-1-rhels-6-x86_64
3.
To list the kit component "comp-server-1.0-1-rhels-6-x86_64" for selected kit component attributes, enter:
.. code-block:: perl
lskitcomp -C kitcompname,desc comp-server-1.0-1-rhels-6-x86_64
4.
To list kit components compatible with "rhels-6.2-x86_64" osdistro, enter:
.. code-block:: perl
lskitcomp -O rhels-6.2-x86_64
5.
To list kit components compatible with "rhels-6.2-x86_64" osdistro and "computenode" server role, enter:
.. code-block:: perl
lskitcomp -O rhels-6.2-x86_64 -S computenode
6.
To list the kit component "testkit-compute-1.0-1-ubuntu-14.04-ppc64el" with XML tags, enter:
.. code-block:: perl
XCATXMLTRACE=1 lskitcomp -x testkit-compute-1.0-1-ubuntu-14.04-ppc64el
*****
FILES
*****
/opt/xcat/bin/lskitcomp
********
SEE ALSO
********
lskit(1)|lskit.1, lskitdeployparam(1)|lskitdeployparam.1, addkit(1)|addkit.1, rmkit(1)|rmkit.1, addkitcomp(1)|addkitcomp.1, rmkitcomp(1)|rmkitcomp.1

View File

@ -1,162 +0,0 @@
##################
lskitdeployparam.1
##################
.. highlight:: perl
****
NAME
****
\ **lskitdeployparam**\ - Lists the deployment parameters for one or more Kits or Kit components
********
SYNOPSIS
********
\ **lskitdeployparam**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] [\ **-x**\ | \ **-**\ **-xml**\ | \ **-**\ **-XML**\ ] [\ **-k**\ | \ **-**\ **-kitname**\ \ *kit_names*\ ] [\ **-c**\ | \ **-**\ **-compname**\ \ *comp_names*\ ]
\ **lskitdeployparam**\ [\ **-?**\ | \ **-h**\ | \ **-**\ **-help**\ | \ **-v**\ | \ **-**\ **-version**\ ]
***********
DESCRIPTION
***********
The \ **lskitdeployparam**\ command is used to list the kit deployment parameters for one or more kits, or one or more kit components. Kit deployment parameters are used to customize the installation or upgrade of kit components.
The \ **lskitdeployparam**\ command outputs the kit component information in two formats: human-readable format (default), and XML format. Use the -x option to view the information in XML format.
Input to the command can specify any combination of the input options.
Note: The xCAT support for Kits is only available for Linux operating systems.
*******
OPTIONS
*******
\ **-k|-**\ **-kitname**\ \ *kit_names*\
Where \ *kit_names*\ is a comma-delimited list of kit names. The \ **lskitdeployparam**\ command will only display the deployment parameters for the kits with the matching names.
\ **-c|-**\ **-compname**\ \ *comp_names*\
Where \ *comp_names*\ is a comma-delimited list of kit component names. The \ **lskitdeployparam**\ command will only display the deployment parameters for the kit components with the matching names.
\ **-x|-**\ **-xml|-**\ **-XML**\
Return the output with XML tags. The data is returned as:
.. code-block:: perl
<data>
<kitdeployparam>
<name>KIT_KIT1_PARAM1</name>
<value>value11</value>
</kitdeployparam>
</data>
<data>
<kitdeployparam>
<name>KIT_KIT1_PARAM2</name>
<value>value12</value>
</kitdeployparam>
</data>
...
\ **-V|-**\ **-verbose**\
Display additional progress and error messages.
\ **-v|-**\ **-version**\
Command Version.
\ **-?|-h|-**\ **-help**\
Display usage message.
************
RETURN VALUE
************
0 The command completed successfully.
1 An error has occurred.
********
EXAMPLES
********
1.
To list kit deployment parameters for kit "kit-test1-1.0-Linux", enter:
.. code-block:: perl
lskitdeployparam -k kit-test1-1.0-Linux
2.
To list kit deployment parameters for kit component "comp-server-1.0-1-rhels-6-x86_64", enter:
.. code-block:: perl
lskitdeployparam -c comp-server-1.0-1-rhels-6-x86_64
*****
FILES
*****
/opt/xcat/bin/lskitdeployparam
********
SEE ALSO
********
lskit(1)|lskit.1, lskitcomp(1)|lskitcomp.1, addkit(1)|addkit.1, rmkit(1)|rmkit.1, addkitcomp(1)|addkitcomp.1, rmkitcomp(1)|rmkitcomp.1

View File

@ -1,151 +0,0 @@
#######
rmkit.1
#######
.. highlight:: perl
****
NAME
****
\ **rmkit**\ - Remove Kits from xCAT
********
SYNOPSIS
********
\ **rmkit**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ]
\ **rmkit**\ [\ **-V | -**\ **-verbose**\ ] [\ **-f | -**\ **-force**\ ] [\ **-t | -**\ **-test**\ ] \ *kitlist*\
***********
DESCRIPTION
***********
The \ **rmkit**\ command removes kits on the xCAT management node from kit names.
Note: The xCAT support for Kits is only available for Linux operating systems.
*******
OPTIONS
*******
\ **-h|-**\ **-help**\
Display usage message.
\ **-V|-**\ **-verbose**\
Verbose mode.
\ **-v|-**\ **-version**\
Command version.
\ **-f|-**\ **-force**\
Remove this kit even there is any component in this kit is listed by osimage.kitcomponents. If this option is not specified, this kit will not be removed if any kit components listed in an osimage.kitcomponents
\ **-t|-**\ **-test**\
Test if kitcomponents in this kit are used by osimage
\ *kitlist*\
A comma delimited list of kits that are to be removed from the xCAT cluster. Each entry can be a kitname or kit basename. For kit basename, rmkit command will remove all the kits that have that kit basename.
************
RETURN VALUE
************
0 The command completed successfully.
1 An error has occurred.
********
EXAMPLES
********
1. To remove two kits from tarball files.
.. code-block:: perl
rmkit kit-test1,kit-test2
Output is similar to:
.. code-block:: perl
Kit kit-test1-1.0-Linux,kit-test2-1.0-Linux was successfully removed.
2. To remove two kits from tarball files even the kit components in them are still being used by osimages.
.. code-block:: perl
rmkit kit-test1,kit-test2 --force
Output is similar to:
.. code-block:: perl
Kit kit-test1-1.0-Linux,kit-test2-1.0-Linux was successfully removed.
3. To list kitcomponents in this kit used by osimage
.. code-block:: perl
rmkit kit-test1,kit-test2 -t
Output is similar to:
.. code-block:: perl
kit-test1-kitcomp-1.0-Linux is being used by osimage osimage-test
Following kitcomponents are in use: kit-test1-kitcomp-1.0-Linux
********
SEE ALSO
********
lskit(1)|lskit.1, addkit(1)|addkit.1, addkitcomp(1)|addkitcomp.1, rmkitcomp(1)|rmkitcomp.1, chkkitcomp(1)|chkkitcomp.1

View File

@ -1,162 +0,0 @@
###########
rmkitcomp.1
###########
.. highlight:: perl
****
NAME
****
\ **rmkitcomp**\ - Remove Kit components from an xCAT osimage.
********
SYNOPSIS
********
\ **rmkitcomp**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ]
\ **rmkitcomp**\ [\ **-V | -**\ **-verbose**\ ] [\ **-u | -**\ **-uninstall**\ ] [\ **-f | -**\ **-force**\ ] [\ **-**\ **-noscripts**\ ] \ **-i**\ \ *osimage*\ \ *kitcompname_list*\
***********
DESCRIPTION
***********
The \ **rmkitcomp**\ command removes kit components from an xCAT osimage. All the kit component attribute values that are contained in the osimage will be removed, and the kit component meta rpm and package rpm could be uninstalled by \ **-u|-**\ **-uninstall**\ option.
Note: The xCAT support for Kits is only available for Linux operating systems.
*******
OPTIONS
*******
\ **-u|-**\ **-uninstall**\
All the kit component meta rpms and package rpms in otherpkglist will be uninstalled during genimage for stateless image and updatenode for stateful nodes.
\ **-h|-**\ **-help**\
Display usage message.
\ **-V|-**\ **-verbose**\
Verbose mode.
\ **-v|-**\ **-version**\
Command version.
\ **-f|-**\ **-force**\
Remove this kit component from osimage no matter it is a dependency of other kit components.
\ **-**\ **-noscripts**\
Do not remove kitcomponent's postbootscripts from osimage
\ **-i**\ \ *osimage*\
osimage name that include this kit component.
\ *kitcompname_list*\
A comma-delimited list of valid full kit component names or kit component basenames that are to be removed from the osimage. If a basename is specified, all kitcomponents matching that basename will be removed from the osimage.
************
RETURN VALUE
************
0 The command completed successfully.
1 An error has occurred.
********
EXAMPLES
********
1. To remove a kit component from osimage
.. code-block:: perl
rmkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
.. code-block:: perl
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
2. To remove a kit component even it is still used as a dependency of other kit component.
.. code-block:: perl
rmkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
.. code-block:: perl
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
3. To remove a kit component from osimage and also remove the kit component meta RPM and package RPM. So in next genimage for statelss image and updatenode for stateful nodes, the kit component meta RPM and package RPM will be uninstalled.
.. code-block:: perl
rmkitcomp -u -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
.. code-block:: perl
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
********
SEE ALSO
********
lskit(1)|lskit.1, addkit(1)|addkit.1, rmkit(1)|rmkit.1, addkitcomp(1)|addkitcomp.1, chkkitcomp(1)|chkkitcomp.1

File diff suppressed because it is too large Load Diff

View File

@ -1,285 +0,0 @@
=head1 NAME
B<buildkit> - Used to build a software product Kit which may be used to install software in an xCAT cluster.
=head1 SYNOPSIS
B<buildkit> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
To build a new Kit
B<buildkit> [B<-V>|B<--verbose]> I<subcommand> [I<kit_name>] [I<repo_name> | B<all>] [B<-l>|B<--kitloc> I<kit_location>]
To add packages to an existing Kit.
B<buildkit> [B<-V>|B<--verbose>] I<addpkgs> I<kit_tarfile> [B<-p>|B<--pkgdir> I<package_directory_list>] [B<-k>|B<--kitversion> I<version>] [B<-r>|B<--kitrelease> I<release>] [B<-l>|B<--kitloc> I<kit_location>]
=head1 DESCRIPTION
The B<buildkit> command provides a collection of utilities that may be used to package a software product as a Kit tarfile that can be used to install software on the nodes of an xCAT cluster. A Kit contains the product software packages, configuration and control information, and install and customization scripts.
Note: The xCAT support for Kits is only available for Linux operating systems.
You will need to run the B<buildkit> command several times with different subcommands to step through the process of building a kit:
By default the B<buildkit> subcommands will operate in the current working directory, (ie. look for files, create directories etc.). You could specify a different location by using the "B<-l | --kitloc> I<kit_location>" option.
The I<kit_location> is the full path name of the directory that contains the kit files. You would use the same location value for all the buildkit subcommands.
For example, to create a new kit named "prodkit" in the directory /home/mykits/ I<either> run:
=over 4
=item 1.
If no location is provided then the command will create a subdirectory called "prodkit" in the current directory "/home/mykits" and the new kit files will be created there.
B<cd /home/mykits>
B<buildkit create prodkit>
or
=item 2.
If a location is provided then the Kit files will be created there. Note that the Kit name does not necessarily have to be the directory name where the kit files are located.
B<buidkit create prodkit -l /home/mykits/prodkit>
=back
In both cases the /home/mykits/prodkit directory is created and the inital files for the kit are created in that directory.
The following example illustrates the basic process for building a new Kit. In this example we are building a Kit named "mytstkit".
=over 4
=item 1.
Change to the directory where you wish to create the Kit.
=item 2.
Create a template directory for your kit:
B<buildkit create mytstkit>
=item 3.
Change directory to the new "mytstkit" subdirectory that was just created.
B<cd mytstkit>
=item 4.
Edit the buildkit configuration file for your kit:
B<vi buildkit.conf>
(See xCAT Kit documentation for details.)
=item 5.
Create all required files, scripts, plugins, and packages for your kit.
=item 6.
Validate your kit build configuration and fix any errors that are reported:
B<buildkit chkconfig>
=item 7.
List the repos defined in your buildkit configuration file:
B<buildkit listrepo>
=item 8.
For each repo name listed, build the repository. Note that if you need to build repositories for OS distributions, versions, or architectures that do not match the current system, you may need to copy your kit template directory to an appropriate server to build that repository, and then copy the results back to your main build server. For example, to build a repo named "rhels6.3" you would run the following command.
B<buildkit buildrepo rhels6.3>
or, you can build all of the repos at one time if there are no OS or architecture dependencies for kitcomponent package builds or kitpackage builds:
B<buildkit buildrepo all>
=item 9.
Build the kit tar file:
B<buildkit buildtar>
=back
=head1 OPTIONS
=over 10
=item B<-h |--help>
Display usage message.
=item B<-k|--kitversion> I<version>
Product version.
=item B<-l|--kitloc> I<kit_location>
The directory location of the Kit files.
=item B<-p|--pkgdir> I<package_directory_list>
A comma-separated list of directory locations for product RPMs.
=item B<-r|--kitrelease> I<release>
Product release.
=item B<-V |--verbose>
Verbose mode.
=item B<-v|--version>
Command version.
=back
=head1 SUB-COMMANDS
=over 10
=item B<create> I<kit_basename>
Creates a new kit build directory structure for kit I<kit_basename> using the location specified on the command line or the current directory. The sample kit files from /opt/xcat/share/xcat/kits/kit_template are copied over, and the buildkit.conf file is modified for the specified I<kit_basename>.
=item B<chkconfig>
Reads the buildkit.conf file, verifies that the file syntax is correct and that all specified files exist.
=item B<listrepo>
Reads the buildkit.conf file, lists all Kit package repositories listed in the file, and reports the build status for each repository.
=item B<buildrepo> {I<repo_name> | B<all>}
Reads the buildkit.conf file, and builds the specified Kit package repository. The built packages are placed in the directory <kit_location>/build/kit_repodir/I<repo_name>. If B<all> is specified, all kit repositories are built.
=item B<cleanrepo> {I<repo_name> | B<all>}
Reads the buildkit.conf file, and deletes all the package files and package meta data files from the <kit_location>/build/kit_repodir/I<repo_name> directory. If B<all> is specified, all kit repository files are deleted.
=item B<buildtar>
Reads the buildkit.conf file, validates that all kit repositories have been built, and builds the Kit tar file <kit_location>/I<kitname>.tar.bz2.
=item B<cleantar>
Reads the <kit_location>/buildkit.conf file and I<deletes> the following:
=over 4
- Kit tar files matching <kit_location>/I<kit_name*.tar.bz2>.
- <kit_location>/build/I<kit_name>
- <kit_location>/rpmbuild
- <kit_location>/tmp
- <kit_location>/debbuild
=back
Caution: Make sure you back up any tar files you would like to keep before running this subcommand.
=item B<cleanall>
Equivalent to running B<buildkit cleanrepo all> and B<buildkit cleantar>.
=item B<addpkgs>
I<kit_tarfile> {B<-p> | B<--pkgdir> I<package_directory_list>} [B<-k> | B<--kitversion> I<version>] [B<-r> | B<--kitrelease> I<release>]
Add product package rpms to a previously built kit tar file. This is used for partial product kits that are built and shipped separately from the product packages, and are identified with a I<kit_tarfile> name of I<kitname>.B<NEED_PRODUCT_PKGS.tar.bz2>. Optionally, change the kit release and version values when building the new kit tarfile. If kitcomponent version and/or release values are defaulted to the kit values, those will also be changed and new kitcomponent rpms will be built. If kit or kitcomponent scripts, plugins, or other files specify name, release, or version substitution strings, these will all be replaced with the new values when built into the new complete kit tarfile I<kit_location>/I<new_kitname>.B<tar.bz2>.
=back
=head1 RETURN VALUE
=over 3
=item <B>0
The command completed successfully.
=item <B>1
An error has occurred.
=back
=head1 EXAMPLES
=over 3
=item 1.
To create the sample kit shipped with the xCAT-buildkit rpm on a RHELS 6.3 server and naming it B<mykit>, run the following commands:
B<cd /home/myuserid/kits>
B<buildkit create mykit>
B<cd mykit>
B<vi buildkit.conf>
B<buildkit chkconfig>
B<buildkit listrepo>
B<buildkit buildrepo all>
B<buildkit buildtar>
=item 2.
To clean up a kit repository directory after build failures on a RHELS 6.3 server to prepare for a new kit repository build, run:
B<buildkit cleanrepo rhels6.3>
=item 3.
To clean up all kit build files, including a previously built kit tar file, run
B<buildkit cleanall>
=item 4.
To create a kit named "tstkit" located in /home/foobar/tstkit instead of the current working directory.
B<buildkit create tstkit -l /home/foobar/tstkit>
=back
=head1 FILES
/opt/xcat/bin/buildkit
/opt/xcat/share/xcat/kits/kit_template
/opt/xcat/share/xcat/kits/kitcomponent.spec.template
<kit location>/buildkit.conf
<kit location>/build/I<kitname>/kit.conf
<kit location>/I<kitname>.tar.bz2
=head1 SEE ALSO
addkit(1), lskit(1), rmkit(1), addkitcomp(1), rmkitcomp(1), chkkitcomp(1)

View File

@ -35,8 +35,6 @@ xCAT-buildkit provides the buildkit tool and sample kit files to build an xCAT k
# Convert pods to man pages and html pages
mkdir -p share/man/man1
mkdir -p share/doc/man1
pod2man pods/man1/buildkit.1.pod > share/man/man1/buildkit.1
pod2html pods/man1/buildkit.1.pod > share/doc/man1/buildkit.1.html
%install
rm -rf $RPM_BUILD_ROOT
@ -46,30 +44,18 @@ mkdir -p $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT
mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/man/man1
mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/man1
# These were built dynamically in the build phase
cp share/man/man1/* $RPM_BUILD_ROOT/%{prefix}/share/man/man1
chmod 444 $RPM_BUILD_ROOT/%{prefix}/share/man/man1/*
cp share/doc/man1/* $RPM_BUILD_ROOT/%{prefix}/share/doc/man1
chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/doc/man1/*
%ifos linux
cp -aR share/xcat/kits/* $RPM_BUILD_ROOT/%{prefix}/share/xcat/kits/
#chmod -R 644 $RPM_BUILD_ROOT/%{prefix}/share/xcat/kits/*
find $RPM_BUILD_ROOT/%{prefix}/share/xcat/kits -type d -exec chmod 755 {} \;
find $RPM_BUILD_ROOT/%{prefix}/share/xcat/kits -type f -exec chmod 644 {} \;
cp -a lib/perl/xCAT/* $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT
#chmod -R 644 $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT/*
find $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT -type d -exec chmod 755 {} \;
find $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT -type f -exec chmod 644 {} \;
cp -a bin/* $RPM_BUILD_ROOT/%{prefix}/bin/
chmod -R 755 $RPM_BUILD_ROOT/%{prefix}/bin/*
%else
cp -hpR share/xcat/kits/* $RPM_BUILD_ROOT/%{prefix}/share/xcat/kits/
chmod -R 644 $RPM_BUILD_ROOT/%{prefix}/share/xcat/kits/*
cp -hpR lib/perl/xCAT/* $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT/
chmod -R 755 $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT/*
cp -hpR bin/* $RPM_BUILD_ROOT/%{prefix}/bin/
chmod -R 755 $RPM_BUILD_ROOT/%{prefix}/bin/*
%endif
mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/packages/xCAT-buildkit

View File

@ -92,14 +92,6 @@ opt/xcat/bin/xcatclient opt/xcat/bin/lshwconn
opt/xcat/bin/xcatclientnnr opt/xcat/sbin/makeroutes
opt/xcat/bin/xcatclientnnr opt/xcat/sbin/snmove
opt/xcat/bin/xcatclientnnr opt/xcat/bin/lsxcatd
opt/xcat/bin/xcatclientnnr opt/xcat/bin/lskit
opt/xcat/bin/xcatclientnnr opt/xcat/bin/addkit
opt/xcat/bin/xcatclientnnr opt/xcat/bin/rmkit
opt/xcat/bin/xcatclientnnr opt/xcat/bin/lskitcomp
opt/xcat/bin/xcatclientnnr opt/xcat/bin/addkitcomp
opt/xcat/bin/xcatclientnnr opt/xcat/bin/rmkitcomp
opt/xcat/bin/xcatclientnnr opt/xcat/bin/chkkitcomp
opt/xcat/bin/xcatclientnnr opt/xcat/bin/lskitdeployparam
opt/xcat/bin/xcatclient opt/xcat/bin/postage
opt/xcat/bin/xcatclient opt/xcat/bin/cfghost
opt/xcat/bin/xcatclientnnr opt/xcat/bin/cfgve

View File

@ -1,79 +0,0 @@
=head1 NAME
B<addkit> - Adds product software Kits to an xCAT cluster environmnet.
=head1 SYNOPSIS
B<addkit> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<addkit> [B<-i>|B<--inspection>] I<kitlist>
B<addkit> [B<-V>|B<--verbose>] [B<-p>|B<--path> I<path>] I<kitlist>
=head1 DESCRIPTION
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.
B<Note:> xCAT Kit support is ONLY available for Linux operating systems.
=head1 OPTIONS
=over 10
=item B<-h|--help>
Display usage message.
=item B<-V|--verbose>
Verbose mode.
=item B<-v|--version>
Command version.
=item B<-i|--inspection>
Show the summary of the given kits
=item B<-p|--path> I<path>
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 I<kitlist>
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
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To add kits from tarball files:
addkit kit-test1.tar.bz2,kit-test2.tar.bz2
2. To add kits from directories:
addkit kit-test1,kit-test2
3. To add kits from tarball I<kit-test1.tar.bz2> to target path I</install/test>:
addkit -p /install/test kit-test1.tar.bz2
4. To see general information about kit I<kit-test1.tar.bz2> without adding the kit to xCAT:
addkit -i kit-test1.tar.bz2
=head1 SEE ALSO
L<lskit(1)|lskit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>

View File

@ -1,90 +0,0 @@
=head1 NAME
B<addkitcomp> - Assign Kit components to an xCAT osimage.
=head1 SYNOPSIS
B<addkitcomp> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<addkitcomp> [B<-V>|B<--verbose>] [B<-a>|B<--adddeps>] [B<-f>|B<--force>] [B<-n>|B<--noupgrade>] [B<--noscripts>] B<-i> I<osimage> I<kitcompname_list>
=head1 DESCRIPTION
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.
B<Note:> xCAT Kit support is ONLY available for Linux operating systems.
=head1 OPTIONS
=over 10
=item B<-a|--adddeps>
Assign kitcomponent dependencies to the osimage.
=item B<-h|--help>
Display usage message.
=item B<-V|--verbose>
Verbose mode.
=item B<-v|--version>
Command version.
=item B<-f|--force>
Add kit component to osimage even if there is a mismatch in OS, version, arch, serverrole, or kitcompdeps
=item B<-i> I<osimage>
The osimage name that the kit component is assigning to.
=item B<-n|--noupgrade>
1. Allow multiple versions of kitcomponent to be installed into the osimage, instead of kitcomponent upgrade.
2. Kit components added by addkitcomp -n will be installed separately behind all other ones which have been added.
=item B<--noscripts>
Do not add kitcomponent's postbootscripts to osimage
=item I<kitcompname_list>
A comma-delimited list of valid full kit component names or kit component basenames that are to be added to the osimage.
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
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
2. To add a kit component to osimage with dependencies, use the -a (addeps) option:
addkitcomp -a -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
3. To add a kit component to osimage with incompatable osarch, osversion or ostype, use the -f (force) option:
addkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
4. To add a new version of kit component to osimage without upgrade, use the -n (noupgrade) option:
addkitcomp -n -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
=head1 SEE ALSO
L<lskit(1)|lskit.1>, L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<rmkitcomp(1)|rmkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>

View File

@ -1,61 +0,0 @@
=head1 NAME
B<chkkitcomp> - Check if Kit components are compatible with an xCAT osimage.
=head1 SYNOPSIS
B<chkkitcomp> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<chkkitcomp> [B<-V>|B<--verbose>] B<-i> I<osimage> I<kitcompname_list>
=head1 DESCRIPTION
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 check if the kitcompname_list is compatible with the osimage and kit component dependencies.
B<Note:> xCAT Kit support is ONLY available for Linux operating systems.
=head1 OPTIONS
=over 10
=item B<-h|--help>
Display usage message.
=item B<-V|--verbose>
Verbose mode.
=item B<-v|--version>
Command version.
=item B<-i> I<osimage>
The name of the osimage to check against.
=item I<kitcompname_list>
A comma-delimited list of valid full kit component names or kit component basenames that are to be checked against the osimage.
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
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
=head1 SEE ALSO
L<lskit(1)|lskit.1>, L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>

View File

@ -1,168 +0,0 @@
=head1 NAME
B<lskit> - Lists information for one or more Kits.
=head1 SYNOPSIS
B<lskit> [B<-V> | B<--verbose>] [B<-F> | B<--framework> I<kitattr_names>] [B<-x> | B<--xml> | B<--XML>] [B<-K> | B<--kitattr> I<kitattr_names>] [B<-R> | B<--repoattr> I<repoattr_names>] [B<-C> | B<--compattr> I<compattr_names>] [I<kit_names>]
B<lskit> [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>]
B<lskit> [B<-F> | B<--framework> I<kit_path_name>]
=head1 DESCRIPTION
The B<lskit> command is used to list information for one or more kits. A kit is a special kind of package that is used to install a software product on one or more nodes in an xCAT cluster.
Note: The xCAT support for Kits is only available for Linux operating systems.
The B<lskit> command outputs the following info for each kit: the kit's basic info, the kit's repositories, and the kit's components. The command outputs the info in two formats: human-readable format (default), and XML format. Use the -x option to view the info in XML format.
Input to the command can specify any number or combination of the input options.
=head1 OPTIONS
=over 10
=item B<-F|--framework> I<kit_path_name>
Use this option to display the framework values of the specified Kit tarfile. This information is retreived directly from the tarfile and can be done before the Kit has been defined in the xCAT database. This option cannot be combined with other options.
=item B<-K|--kitattr> I<kitattr_names>
Where I<kitattr_names> is a comma-delimited list of kit attribute names. The names correspond to attribute names in the B<kit> table. The B<lskit> command will only display the specified kit attributes.
=item B<-R|--repoattr> I<repoattr_names>
Where I<repoattr_names> is a comma-delimited list of kit repository attribute names. The names correspond to attribute names in the B<kitrepo> table. The B<lskit> command will only display the specified kit repository attributes.
=item B<-C|--compattr> I<compattr_names>
where I<compattr_names> is a comma-delimited list of kit component attribute names. The names correspond to attribute names in the B<kitcomponent> table. The B<lskit> command will only display the specified kit component attributes.
=item I<kit_names>
is a comma-delimited list of kit names. The B<lskit> command will only display the kits matching these names.
=item B<-x|--xml|--XML>
Need XCATXMLTRACE=1 env when using -x|--xml|--XML, for example: XCATXMLTRACE=1 lskit -x testkit-1.0.0
Return the output with XML tags. The data is returned as:
<data>
<kitinfo>
...
</kitinfo>
</data>
...
<data>
<kitinfo>
...
</kitinfo>
</data>
Each <kitinfo> tag contains info for one kit. The info inside <kitinfo> is structured as follows:
The <kit> sub-tag contains the kit's basic info.
The <kitrepo> sub-tags store info about the kit's repositories.
The <kitcomponent> sub-tags store info about the kit's components.
The data inside <kitinfo> is returned as:
<kitinfo>
<kit>
...
</kit>
<kitrepo>
...
</kitrepo>
...
<kitcomponent>
...
</kitcomponent>
...
</kitinfo>
=item B<-V|--verbose>
Display additional progress and error messages.
=item B<-v|--version>
Command Version.
=item B<-?|-h|--help>
Display usage message.
=back
=head1 RETURN VALUE
=over 3
=item 0
The command completed successfully.
=item 1
An error has occurred.
=back
=head1 EXAMPLES
=over 3
=item 1.
To list all kits, enter:
lskit
=item 2.
To list the kit "kit-test1-1.0-Linux", enter:
lskit kit-test1-1.0-Linux
=item 3.
To list the kit "kit-test1-1.0-Linux" for selected attributes, enter:
lskit -K basename,description -R kitreponame -C kitcompname kit-test1-1.0-Linux
=item 4.
To list the framework value of a Kit tarfile.
lskit -F /myhome/mykits/pperte-1.3.0.2-0-x86_64.tar.bz2
Output is similar to:
Extracting the kit.conf file from /myhome/mykits/pperte-1.3.0.2-0-x86_64.tar.bz2. Please wait.
kitframework=2
compatible_kitframeworks=0,1,2
=item 5.
To list kit "testkit-1.0-1" with XML tags, enter:
XCATXMLTRACE=1 lskit -x testkit-1.0-1
=back
=head1 FILES
/opt/xcat/bin/lskit
=head1 SEE ALSO
L<lskitcomp(1)|lskitcomp.1>, L<lskitdeployparam(1)|lskitdeployparam.1>, L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>

View File

@ -1,156 +0,0 @@
=head1 NAME
B<lskitcomp> - Used to list information for one or more kit components.
=head1 SYNOPSIS
B<lskitcomp> [B<-V> | B<--verbose>] [B<-x> | B<--xml> | B<--XML>] [B<-C> | B<--compattr> I<compattr_names>] [B<-O> | B<--osdistro> I<os_distro>] [B<-S> | B<--serverrole> I<server_role>] [I<kitcomp_names>]
B<lskitcomp> [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
The B<lskitcomp> command is used to list information for one or more kit components. A kit is made up of one or more kit components. Each kit component is a meta package used to install a software product component on one or more nodes in an xCAT cluster.
The B<lskitcomp> command outputs the kit component info in two formats: human-readable format (default), and XML format. Use the -x option to view the info in XML format.
Input to the command can specify any number or combination of the input options.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
=over 10
=item B<-C|--compattr> I<compattr_names>
where I<compattr_names> is a comma-delimited list of kit component attribute names. The names correspond to attribute names in the B<kitcomponent> table. The B<lskitcomp> command will only display the specified kit component attributes.
=item B<-O|--osdistro> I<os_distro>
where I<os_distro> is the name of an osdistro in B<osdistro> table. The B<lskitcomp> command will only display the kit components matching the specified osdistro.
=item B<-S|--serverrole> I<server_role>
where I<server_role> is the name of a server role. The typical server roles are: mgtnode, servicenode, computenode, loginnode, storagennode. The B<lskitcomp> command will only display the kit components matching the specified server role.
=item I<kitcomp_names>
is a comma-delimited list of kit component names. The B<lskitcomp> command will only display the kit components matching the specified names.
=item B<-x|--xml|--XML>
Need XCATXMLTRACE=1 env when using -x|--xml|--XML.
Return the output with XML tags. The data is returned as:
<data>
<kitinfo>
...
</kitinfo>
</data>
...
<data>
<kitinfo>
...
</kitinfo>
</data>
Each <kitinfo> tag contains info for a group of kit components belonging to the same kit. The info inside <kitinfo> is structured as follows:
The <kit> sub-tag contains the kit's name.
The <kitcomponent> sub-tags store info about the kit's components.
The data inside <kitinfo> is returned as:
<kitinfo>
<kit>
...
</kit>
<kitcomponent>
...
</kitcomponent>
...
</kitinfo>
=item B<-V|--verbose>
Display additional progress and error messages.
=item B<-v|--version>
Command Version.
=item B<-?|-h|--help>
Display usage message.
=back
=head1 RETURN VALUE
=over 3
=item 0
The command completed successfully.
=item 1
An error has occurred.
=back
=head1 EXAMPLES
=over 3
=item 1.
To list all kit components, enter:
lskitcomp
=item 2.
To list the kit component "comp-server-1.0-1-rhels-6-x86_64", enter:
lskitcomp comp-server-1.0-1-rhels-6-x86_64
=item 3.
To list the kit component "comp-server-1.0-1-rhels-6-x86_64" for selected kit component attributes, enter:
lskitcomp -C kitcompname,desc comp-server-1.0-1-rhels-6-x86_64
=item 4.
To list kit components compatible with "rhels-6.2-x86_64" osdistro, enter:
lskitcomp -O rhels-6.2-x86_64
=item 5.
To list kit components compatible with "rhels-6.2-x86_64" osdistro and "computenode" server role, enter:
lskitcomp -O rhels-6.2-x86_64 -S computenode
=item 6.
To list the kit component "testkit-compute-1.0-1-ubuntu-14.04-ppc64el" with XML tags, enter:
XCATXMLTRACE=1 lskitcomp -x testkit-compute-1.0-1-ubuntu-14.04-ppc64el
=back
=head1 FILES
/opt/xcat/bin/lskitcomp
=head1 SEE ALSO
L<lskit(1)|lskit.1>, L<lskitdeployparam(1)|lskitdeployparam.1>, L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>

View File

@ -1,107 +0,0 @@
=head1 NAME
B<lskitdeployparam> - Lists the deployment parameters for one or more Kits or Kit components
=head1 SYNOPSIS
B<lskitdeployparam> [B<-V> | B<--verbose>] [B<-x> | B<--xml> | B<--XML>] [B<-k> | B<--kitname> I<kit_names>] [B<-c> | B<--compname> I<comp_names>]
B<lskitdeployparam> [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
The B<lskitdeployparam> command is used to list the kit deployment parameters for one or more kits, or one or more kit components. Kit deployment parameters are used to customize the installation or upgrade of kit components.
The B<lskitdeployparam> command outputs the kit component information in two formats: human-readable format (default), and XML format. Use the -x option to view the information in XML format.
Input to the command can specify any combination of the input options.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
=over 10
=item B<-k|--kitname> I<kit_names>
Where I<kit_names> is a comma-delimited list of kit names. The B<lskitdeployparam> command will only display the deployment parameters for the kits with the matching names.
=item B<-c|--compname> I<comp_names>
Where I<comp_names> is a comma-delimited list of kit component names. The B<lskitdeployparam> command will only display the deployment parameters for the kit components with the matching names.
=item B<-x|--xml|--XML>
Return the output with XML tags. The data is returned as:
<data>
<kitdeployparam>
<name>KIT_KIT1_PARAM1</name>
<value>value11</value>
</kitdeployparam>
</data>
<data>
<kitdeployparam>
<name>KIT_KIT1_PARAM2</name>
<value>value12</value>
</kitdeployparam>
</data>
...
=item B<-V|--verbose>
Display additional progress and error messages.
=item B<-v|--version>
Command Version.
=item B<-?|-h|--help>
Display usage message.
=back
=head1 RETURN VALUE
=over 3
=item 0
The command completed successfully.
=item 1
An error has occurred.
=back
=head1 EXAMPLES
=over 3
=item 1.
To list kit deployment parameters for kit "kit-test1-1.0-Linux", enter:
lskitdeployparam -k kit-test1-1.0-Linux
=item 2.
To list kit deployment parameters for kit component "comp-server-1.0-1-rhels-6-x86_64", enter:
lskitdeployparam -c comp-server-1.0-1-rhels-6-x86_64
=back
=head1 FILES
/opt/xcat/bin/lskitdeployparam
=head1 SEE ALSO
L<lskit(1)|lskit.1>, L<lskitcomp(1)|lskitcomp.1>, L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>

View File

@ -1,83 +0,0 @@
=head1 NAME
B<rmkit> - Remove Kits from xCAT
=head1 SYNOPSIS
B<rmkit> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<rmkit> [B<-V>|B<--verbose>] [B<-f>|B<--force>] [B<-t>|B<--test>] I<kitlist>
=head1 DESCRIPTION
The B<rmkit> command removes kits on the xCAT management node from kit names.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
=over 10
=item B<-h|--help>
Display usage message.
=item B<-V|--verbose>
Verbose mode.
=item B<-v|--version>
Command version.
=item B<-f|--force>
Remove this kit even there is any component in this kit is listed by osimage.kitcomponents. If this option is not specified, this kit will not be removed if any kit components listed in an osimage.kitcomponents
=item B<-t|--test>
Test if kitcomponents in this kit are used by osimage
=item I<kitlist>
A comma delimited list of kits that are to be removed from the xCAT cluster. Each entry can be a kitname or kit basename. For kit basename, rmkit command will remove all the kits that have that kit basename.
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To remove two kits from tarball files.
rmkit kit-test1,kit-test2
Output is similar to:
Kit kit-test1-1.0-Linux,kit-test2-1.0-Linux was successfully removed.
2. To remove two kits from tarball files even the kit components in them are still being used by osimages.
rmkit kit-test1,kit-test2 --force
Output is similar to:
Kit kit-test1-1.0-Linux,kit-test2-1.0-Linux was successfully removed.
3. To list kitcomponents in this kit used by osimage
rmkit kit-test1,kit-test2 -t
Output is similar to:
kit-test1-kitcomp-1.0-Linux is being used by osimage osimage-test
Following kitcomponents are in use: kit-test1-kitcomp-1.0-Linux
=head1 SEE ALSO
L<lskit(1)|lskit.1>, L<addkit(1)|addkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>

View File

@ -1,90 +0,0 @@
=head1 NAME
B<rmkitcomp> - Remove Kit components from an xCAT osimage.
=head1 SYNOPSIS
B<rmkitcomp> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<rmkitcomp> [B<-V>|B<--verbose>] [B<-u>|B<--uninstall>] [B<-f>|B<--force>] [B<--noscripts>] B<-i> I<osimage> I<kitcompname_list>
=head1 DESCRIPTION
The B<rmkitcomp> command removes kit components from an xCAT osimage. All the kit component attribute values that are contained in the osimage will be removed, and the kit component meta rpm and package rpm could be uninstalled by B<-u|--uninstall> option.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
=over 10
=item B<-u|--uninstall>
All the kit component meta rpms and package rpms in otherpkglist will be uninstalled during genimage for stateless image and updatenode for stateful nodes.
=item B<-h|--help>
Display usage message.
=item B<-V|--verbose>
Verbose mode.
=item B<-v|--version>
Command version.
=item B<-f|--force>
Remove this kit component from osimage no matter it is a dependency of other kit components.
=item B<--noscripts>
Do not remove kitcomponent's postbootscripts from osimage
=item B<-i> I<osimage>
osimage name that include this kit component.
=item I<kitcompname_list>
A comma-delimited list of valid full kit component names or kit component basenames that are to be removed from the osimage. If a basename is specified, all kitcomponents matching that basename will be removed from the osimage.
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To remove a kit component from osimage
rmkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
2. To remove a kit component even it is still used as a dependency of other kit component.
rmkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
3. To remove a kit component from osimage and also remove the kit component meta RPM and package RPM. So in next genimage for statelss image and updatenode for stateful nodes, the kit component meta RPM and package RPM will be uninstalled.
rmkitcomp -u -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
=head1 SEE ALSO
L<lskit(1)|lskit.1>, L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>

View File

@ -249,14 +249,6 @@ ln -sf ../bin/xcatclient $RPM_BUILD_ROOT/%{prefix}/bin/cfghost
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/cfgve
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/lsve
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/rmosdistro
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/lskit
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/addkit
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/rmkit
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/lskitcomp
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/addkitcomp
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/rmkitcomp
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/chkkitcomp
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/lskitdeployparam
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/lskmodules
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/nodeimport
ln -sf ../bin/xcatclientnnr $RPM_BUILD_ROOT/%{prefix}/bin/nodediscoverstart