kitloc and misc updates
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@16554 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
nott
parent
4d28e9fbe6
commit
0c5c11b541
@ -2,59 +2,53 @@
|
||||
|
||||
B<buildkit> - build a product Kit to package software for installation in an xCAT cluster.
|
||||
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
B<buildkit> [B<-V> | B<--verbose>] B<create> I<kit_basename> [B<-w> | B<--workdir> I<directory>]
|
||||
B<buildkit> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
|
||||
|
||||
B<buildkit> [B<-V> | B<--verbose>] B<chkconfig> [B<-w> | B<--workdir> I<directory>]
|
||||
To build a new Kit
|
||||
|
||||
B<buildkit> [B<-V> | B<--verbose>] B<listrepo> [B<-w> | B<--workdir> I<directory>]
|
||||
B<buildkit> [B<-V>|B<--verbose]> I<subcommand> [I<kit_name>] [I<repo_name>|B<all>] [B<-l>|B<--kitloc> I<directory>]
|
||||
|
||||
B<buildkit> [B<-V> | B<--verbose>] B<buildrepo> {I<repo_name> | B<all>} [B<-w> | B<--workdir> I<directory>]
|
||||
|
||||
B<buildkit> [B<-V> | B<--verbose>] B<cleanrepo> {I<repo_name> | B<all>} [B<-w> | B<--workdir> I<directory>]
|
||||
|
||||
B<buildkit> [B<-V> | B<--verbose>] B<buildtar> [B<-w> | B<--workdir> I<directory>]
|
||||
|
||||
B<buildkit> [B<-V> | B<--verbose>] B<cleantar> [B<-w> | B<--workdir> I<directory>]
|
||||
|
||||
B<buildkit> [B<-V> | B<--verbose>] B<cleanall> [B<-w> | B<--workdir> I<directory>]
|
||||
|
||||
B<buildkit> [B<-V> | B<--verbose>] B<addpkgs> I<kit_tarfile> {B<-p> | B<--pkgdir>} {B<-k> | B<--kitversion> I<version>} {B<-r> | B<--kitrelease> I<release>} I<package_directory> [B<-w> | B<--workdir> I<directory>]
|
||||
|
||||
B<command> [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>]
|
||||
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>] [B<-k>|B<--kitversion> I<version>] [B<-r>|B<--kitrelease> I<release>] [B<-l>|B<--kitloc> I<directory>]
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<buildkit> command is a collection of utilities to package a product as a Kit that can be installed on an xCAT cluster. A Kit is a tarfile containing the product software packages, configuration and control information, and install and customization scripts.
|
||||
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.
|
||||
|
||||
You will need to run the buildkit command several times with different subcommands to step through the process of building a kit:
|
||||
You will need to run the B<buildkit> command several times with different subcommands to step through the process of building a kit:
|
||||
|
||||
The following example illustrates the basic process for building a new Kit. It assumes that each subcommand will operate in the current working directory. You could specify a different location by using the "B<-l>|B<--kitloc> I<directory>" option.
|
||||
|
||||
In this example we are building a Kit named "mytstkit".
|
||||
|
||||
=over 4
|
||||
|
||||
=item 1.
|
||||
|
||||
cd to your work directory
|
||||
Change to the directory where you wish to create the Kit.
|
||||
|
||||
=item 2.
|
||||
|
||||
Create a template directory for your kit:
|
||||
|
||||
buildkit create kit_basename
|
||||
B<buildkit create mytstkit>
|
||||
|
||||
=item 3.
|
||||
|
||||
cd to the new template directory:
|
||||
Change directory to the new "mytstkit" subdirectory that was just created.
|
||||
|
||||
cd kit_basename
|
||||
B<cd mytstkit>
|
||||
|
||||
=item 4.
|
||||
|
||||
Edit the buildkit configuration file for your kit:
|
||||
|
||||
vi buildkit.conf
|
||||
B<vi buildkit.conf>
|
||||
|
||||
(See xCAT Kit documentation for details.)
|
||||
|
||||
=item 5.
|
||||
|
||||
@ -62,31 +56,31 @@ Create all required files, scripts, plugins, and packages for your kit.
|
||||
|
||||
=item 6.
|
||||
|
||||
Validate your kit build configuration, fixing any errors that are reported:
|
||||
Validate your kit build configuration and fix any errors that are reported:
|
||||
|
||||
buildkit chkconfig
|
||||
B<buildkit chkconfig>
|
||||
|
||||
=item 7.
|
||||
|
||||
List the repos defined in your buildkit configuration file:
|
||||
|
||||
buildkit listrepo
|
||||
B<buildkit listrepo>
|
||||
|
||||
=item 8.
|
||||
|
||||
For each reponame 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 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 repo_name
|
||||
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:
|
||||
|
||||
buildkit buildrepo all
|
||||
B<buildkit buildrepo all>
|
||||
|
||||
=item 9.
|
||||
|
||||
Build the kit tar file:
|
||||
|
||||
buildkit buildtar
|
||||
B<buildkit buildtar>
|
||||
|
||||
|
||||
=back
|
||||
@ -99,17 +93,25 @@ Build the kit tar file:
|
||||
|
||||
Display usage message.
|
||||
|
||||
=item B<-k|--kitversion> I<version>
|
||||
|
||||
Product version.
|
||||
|
||||
=item B<-l|--kitloc>
|
||||
|
||||
The location of the Kit (including the Kit name).
|
||||
|
||||
=item B<-r|--kitrelease> I<release>
|
||||
|
||||
Product release.
|
||||
|
||||
=item B<-V |--verbose>
|
||||
|
||||
Verbose mode.
|
||||
|
||||
=item B<-v|--version>
|
||||
|
||||
Command Version.
|
||||
|
||||
=item B<-w|--workdir>
|
||||
|
||||
The location to perform the buildkit subcommand.
|
||||
Command version.
|
||||
|
||||
=back
|
||||
|
||||
@ -149,13 +151,14 @@ Reads the buildkit.conf file from the current directory, deletes the Kit tar <cw
|
||||
|
||||
Equivalent to running B<buildkit cleanrepo all> and B<buildkit cleantar>.
|
||||
|
||||
=item B<addpkgs> I<kit_tarfile> {B<-p> | B<--pkgdir>} {B<-k> | B<--kitversion> I<version>} {B<-r> | B<--kitrelease> I<release>} I<package_directory>
|
||||
=item B<addpkgs>
|
||||
|
||||
I<kit_tarfile> {B<-p> | B<--pkgdir> I<package_directory>} [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 incomplete 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<cwd>/I<new_kitname>.B<tar.bz2>.
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head1 RETURN VALUE
|
||||
|
||||
=over 3
|
||||
@ -170,7 +173,6 @@ An error has occurred.
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
=over 3
|
||||
@ -179,36 +181,42 @@ An error has occurred.
|
||||
|
||||
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:
|
||||
|
||||
cd /home/myuserid/kits
|
||||
buildkit create mykit
|
||||
cd mykit
|
||||
vi buildkit.conf
|
||||
buildkit chkconfig
|
||||
buildkit listrepo
|
||||
buildkit buildrepo all
|
||||
buildkit buildtar
|
||||
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:
|
||||
|
||||
buildkit cleanrepo rhels6.3
|
||||
B<buildkit cleanrepo rhels6.3>
|
||||
|
||||
=item 3.
|
||||
|
||||
To clean up all kit build files, including a previously built kit tar file, run
|
||||
|
||||
buildkit cleanall
|
||||
B<buildkit cleanall>
|
||||
|
||||
=item 4.
|
||||
|
||||
To create the sample kit in the working directory /home/foobar instead of the current working directory.
|
||||
To create the sample kit located in /home/foobar/tstkit instead of the current working directory.
|
||||
|
||||
buildkit create mykit -w /home/foobar
|
||||
B<buildkit create mykit -l /home/foobar/tstkit>
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head1 FILES
|
||||
|
||||
/opt/xcat/bin/buildkit
|
||||
@ -217,14 +225,14 @@ To create the sample kit in the working directory /home/foobar instead of the cu
|
||||
|
||||
/opt/xcat/share/xcat/kits/kitcomponent.spec.template
|
||||
|
||||
<cwd>/buildkit.conf
|
||||
<kit location>/buildkit.conf
|
||||
|
||||
<cwd>/build/I<kitname>/kit.conf
|
||||
<kit location>/build/I<kitname>/kit.conf
|
||||
|
||||
<cwd>/I<kitname>.tar.bz2
|
||||
<kit location>/I<kitname>.tar.bz2
|
||||
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
|
||||
addkit(1), lskit(1), rmkit(1), addkitcomp(1), rmkitcomp(1), chkkitcomp(1)
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user