From 1afea00f0864c079179dc65975f39440555fa95e Mon Sep 17 00:00:00 2001 From: nott Date: Mon, 23 Dec 2013 15:23:33 -0500 Subject: [PATCH] template cleanup --- .../xcat/kits/kit_template/buildkit.conf | 359 +++++++++--------- 1 file changed, 185 insertions(+), 174 deletions(-) diff --git a/xCAT-buildkit/share/xcat/kits/kit_template/buildkit.conf b/xCAT-buildkit/share/xcat/kits/kit_template/buildkit.conf index 6646ed82e..d4ddd8ac6 100644 --- a/xCAT-buildkit/share/xcat/kits/kit_template/buildkit.conf +++ b/xCAT-buildkit/share/xcat/kits/kit_template/buildkit.conf @@ -1,235 +1,246 @@ # Kit Build File # -# This file was initially auto-generated by the buildkit CLI command. -# To create a new kit, the user should modify this file accordingly. +# A unique version of this file is automatically generated for a new Kit +# when you run the buildkit command to create a new Kit. The basic template +# for this file is contained in the /opt/xcat/share/xcat/kits/kit_template +# directory. Once the initial version of this file is generated you will +# have to modify it by adding the details needed to build your new Kit. +# # Refer to the buildkit manpage for further details. # - -# kit: This section defines general info for the Kit. -# There must be exactly one kit section in a kit build file. -# +# kit: This stanza defines general information for the Kit. +# There must be exactly one kit stanza in a buildkit.conf file. +# # kit attributes: -# basename (mandatory) Kit base name. e.g., kit-lsf +# basename (mandatory) Kit base name. (ex. "myproduct") +# # description (optional) Kit description. -# version (mandatory) Kit version. e.g., 1.0 -# release (optional) Kit release. e.g., 1 -# ostype (mandatory) Kit OS type. Must be Linux. -# AIX is currently not supported. -# vendor (optional) The vendor tag is used to define the name of -# the entity that is responsible for packaging +# +# version (mandatory) Kit version. ( template default "1.0") +# +# release (optional) Kit release. (template default "1") +# +# ostype (mandatory) Kit OS type. (template default "Linux") +# (AIX is currently not supported.) +# +# vendor (optional) The vendor tag is used to define the name of +# the entity that is responsible for packaging # the software. -# packager (optional) The packager tag is used to hold the name and -# contact information for the person or persons +# +# packager (optional) The packager tag is used to hold the name and +# contact information for the person or persons # who built the package. -# url (optional) The url tag is used to provide a location to -# obtain additional information about the +# +# url (optional) The url tag is used to provide a location to +# obtain additional information about the # packaged software. -# osbasename (optional) OS distro base name. e.g., rhels. -# osmajorversion (optional) OS major version. e.g., 6 +# +# osbasename (optional) OS distro base name. (ex. "rhels") +# +# osmajorversion (optional) OS major version. (ex. "6") +# # osminorversion (optional) OS minor version. -# osarch (optional) OS architecture. e.g., x86_64 +# +# osarch (optional) OS architecture. (ex. "x86_64") +# # isinternal (optional) PCM use only. # Indicate if Kit is for internal use. # Use 1 for yes, 0 for no. Default: 0 +# # kitdeployparams (optional) Filename containing a list of kit deployment -# parameters, relative to -# /other_files +# parameters. The name should be the full path name of +# the file relative to /other_files +# # kitlicense (mandatory) Kit license string to be built into all -# kitcomponent packages +# kitcomponent packages. (template default "EPL") +# # kittarfilename (optional) Filename.tar.bz2 to be used for the generated -# kit. Default is -# ------.tar.bz2 +# kit. (ex. "myproduct-1.4.0.6-0-x86_64.tar.bz2") +# The default format is: +# ------.tar.bz2 +# kit: - basename=<<>> - description=description for <<>> - version=1.0 - release=1 - ostype=Linux - kitdeployparams=sample/kitdeployparams.lst - kitlicense=EPL - - -# kitrepo: This section defines a Kit Package Repository. -# There must be at least one kitrepo section in a kit build file. + basename=<<>> + description=description for <<>> + version=1.0 + release=1 + ostype=Linux + kitlicense=EPL + # vendor= + # packager= + # url= + # osbasename= + # osmajorversion= + # osminorversion= + # osarch= + # isinternal= + # kitdeployparams=sample/kitdeployparams.lst + # kittarfilename= +# +# kitrepo: This stanza defines a Kit Package Repository. +# There must be at least one kitrepo stanza in a kit build file. # If you want to support multiple OSes, you should create a separate -# repo for each OS. Also, no two repos can be defined with the same +# repo for each OS. Also, no two repos can be defined with the same # OS name, major/minor version and arch. For example, you cannot have # two repos for RHEL 6.2 x86_64 in the same kit. # # kitrepo attributes: -# kitrepoid (mandatory) Kit package repository ID. -# Must be unique within this file. -# osbasename (mandatory) OS distro base name. e.g., rhels. -# osmajorversion (mandatory) OS major version. e.g., 6 -# osminorversion (optional) OS minor version. -# osarch (mandatory) OS architecture. e.g., x86_64 -# compat_osbasenames (optional) Comma-separated list of compatible -# OS distro base names. e.g., centos - +# kitrepoid (mandatory) Kit package repository ID. Must be unique within +# this file. A typical name may be something like: +# "._". +# (ex. "rhels6.4_x86_64") +# +# osbasename (mandatory) OS distro base name. (ex. "rhels") +# +# osmajorversion (mandatory) OS major version. (ex. "6") +# +# osminorversion (optional) OS minor version. (ex. "4") +# +# osarch (mandatory) OS architecture. (ex. "x86_64") +# +# compat_osbasenames (optional) Comma-separated list of compatible +# OS distribution base names. (ex. "centos") kitrepo: - kitrepoid=<<>> - osbasename=<<>> - osmajorversion=<<>> - osminorversion=<<>> - osarch=<<>> - #compat_osbasenames= - - -# kitcomponent: This section defines one Kit Component. -# There can be zero or more kitcomponent sections. + kitrepoid=<<>> + osbasename=<<>> + osmajorversion=<<>> + osminorversion=<<>> + osarch=<<>> + # compat_osbasenames= +# +# kitcomponent: This stanza defines one Kit Component. +# There can be zero or more kitcomponent stanzas. # If you want to build a component which supports multiple OSes, -# you should create one kitcomponent section for each OS. +# you should create one kitcomponent section for each OS. # You can define multiple kit components with the same base name -# only if each kit component using this base name meets these +# only if each kit component using this base name meets these # requirements: # - Each kit component must be defined with the same version # and release number # - Each kit component must be defined with a unique kitrepoid - -# +# # kitcomponent attributes: -# basename (mandatory) Kit component base name +# basename (mandatory) Kit component base name +# (ex. "myproduct_compute") +# # description (optional) Kit component description -# version (optional) Kit component version. If not set, defaults -# to kit version -# release (optional) Kit component release. If not set, defaults -# to kit release. Error if both are not set. -# serverroles (mandatory) Comma-separated list of servers that this -# component can install on. Valid values: -# mgtnode,servicenode,compute,login,storage,utility +# +# version (optional) Kit component version. The default is +# the kit version. +# +# release (optional) Kit component release. The default is the +# kit release. +# +# serverroles (mandatory) Comma-separated list of node types that this +# component could be installed on. (Valid values: +# mgtnode,servicenode,compute,login,storage,utility) +# (template default: "compute") +# # kitrepoid (mandatory) The ID of the kit package repository this -# component belongs to +# component belongs to. +# # kitcompdeps (optional) Comma-separated list of kit component # dependencies. These kit components can be included in # this kit or in other kits. -# ospkgdeps (optional) Comma-separated list of OS package dependencies +# +# ospkgdeps (optional) Comma-separated list of OS RPM dependency +# basenames. # These packages must be shipped with the OS distro. -# kitpkgdeps (optional) Comma-separated list of kit package names that -# will be listed as "REQUIRES" when building this kit -# component. Each package must be defined in a separate -# kitpackage section. Each package must be in the same -# kitrepo as this kit component. -# non_native_pkgs (optional) -# Comma-separated list of non-native package -# paths that will be included as files in this kit -# component. All filenames are relative to +# +# kitpkgdeps (mandatory IF product RPMs will be included in this Kit) +# Comma-separated list of RPM basenames. Each RPM must +# be defined in a separate kitpackage stanza. Each RPM +# package must be in the same kitrepo as this kit component. +# +# non_native_pkgs (optional) +# Comma-separated list of non-native package +# paths that will be included as files in this kit +# component. All filenames are relative to # /source_packages and may contain # wildcards. If a filename is prefixed by 'EXTERNALPKGS:' # the file will not be built into the kit tarfile, but # will need to be added later with a 'buildkit addpkgs' -# command. -# Files will be placed in +# command. +# Files will be placed in # /opt/xcat/kits// -# when the kitcomponent package is deployed to an +# when the kitcomponent package is deployed to an # OS image. # Kit component deployment scripts must be specified # to manage these files. +# # driverpacks (optional) Comma-separated list of driver package filenames # Each driverpack must be defined in a separate kitpackage # section. +# # exlist (optional) Exclude list file for stateless image, relative # to /other_files -# Kit component deployment scripts (optional) Each attribute specifies +# +# Kit component deployment scripts (optional) Each attribute specifies # script path relative to /scripts # Script attributes: -# preinstall, postinstall, preuninstall, postuninstall, -# preupgrade, postupgrade, postbootscripts, +# preinstall, postinstall, preuninstall, postuninstall, +# preupgrade, postupgrade, postbootscripts, # genimage_postinstall kitcomponent: - basename=<<>> - description=description for component <<>> - serverroles=compute - kitrepoid=<<>> - #kitcompdeps= - #ospkgdeps= - kitpkgdeps=pkg1 - #kitpkgdeps=pkg1,pkg2,pkg2,pkg4 - #non_native_pkgs=a_kitcomponent.file - #non_native_pkgs=EXTERNALPKGS:a_kitcomponent.file - #driverpacks= - exlist=sample/exclude.lst - preinstall=sample/pre.sh - postinstall=sample/post.sh - preuninstall=sample/preun.sh - postuninstall=sample/postun.sh - preupgrade=sample/preup.sh - postupgrade=sample/postup.sh - postbootscripts=sample/postboot.sh - genimage_postinstall=sample/genimage_post.sh - - -# kitpackage: This section defines one Kit Package, and how to build it. -# There can be zero or more kitpackage sections. -# All filenames should be relative paths to -# /source_packages -# If you want to build a package which can run on multiple OSes, + basename=<<>> + description=description for component <<>> + serverroles=compute + kitrepoid=<<>> + kitpkgdeps=pkg1 + # kitcompdeps=myproduct_license + # ospkgdeps=dep1,dep2 + # non_native_pkgs=a_kitcomponent.file + # non_native_pkgs=EXTERNALPKGS:a_kitcomponent.file + # driverpacks= + # exlist=sample/exclude.lst + # preinstall=sample/pre.sh + # postinstall=sample/post.sh + # preuninstall=sample/preun.sh + # postuninstall=sample/postun.sh + # preupgrade=sample/preup.sh + # postupgrade=sample/postup.sh + # postbootscripts=sample/postboot.sh + # genimage_postinstall=sample/genimage_post.sh +# +# kitpackage: This stanza defines one Kit Package. +# There can be zero or more kitpackage stanzas. +# +# If you want to build a package which can run on multiple OSes, # you have two options: -# 1. Build a separate package for each OS you want to support. -# For this option, you need to define one kitpackage section +# 1. Build a separate package for each OS you want to support. +# For this option, you need to define one kitpackage stanza # per supported OS. -# 2. Build one package that can run on multiple OSes. -# If you are building an RPM package, you are responsible for -# creating an RPM spec file that can run on multiple OSes. -# For this option, you need to define one kitpackage section +# 2. Build one package that can run on multiple OSes. +# If you are building an RPM package, you are responsible for +# creating an RPM spec file that can run on multiple OSes. +# For this option, you need to define one kitpackage stanza # which contains multiple kitrepoid lines. -# +# +# # kitpackage attributes: -# filename (mandatory) Package filename. -# kitrepoid (mandatory) A comma-separated list of kit reponames this package +# filename (mandatory) Package filename. The filename may contain +# wildcards to avoid needing to +# specify an explicit package version-release filename. +# +# kitrepoid (mandatory) A comma-separated list of kit repo names this package # belongs to. If multiple repos are defined, the package will # be built for the first repo only. For the other repos, # a symlink is created to the package built for the first repo. -# Package build methods (optional) -# Define how to build the packages. -# If you don't specify a build method, the default behavior is -# to assume the package is pre-built under -# /source_packages -# All files in this section are relative to -# /source_packages -# There are four methods to build packages. -# 1. Use pre-built RPM package -# The filename may contain wildcards to avoid needing to -# specify an explicit package version-release filename. -# isexternalpkg: 'no'|'0', 'yes'|'1' (default: 'no') -# Indicates whether the RPM package will be added to the -# the kit tar file now as part of the kit build process, -# or whether the customer will need to separately -# obtain the RPM pacakage and add it to the kit tar file -# using 'buildkit addpkgs' -# rpm_prebuiltdir: If isexternalpkg=no, path to directory -# containing pre-built RPM package -# 2. Build RPM from spec + src dir -# rpm_spec: Path to spec file. -# rpm_srcdir: Path to source directory. -# 3. Build RPM from spec + src tarball -# rpm_spec: Path to spec file. -# rpm_srctarball: Path to source tarball. -# 4. Build RPM from source RPM -# rpm_srpm: Path to source RPM package. +# +# isexternalpkg (mandatory) Indicates if the package will be included +# in this kit or added later. +# 'no' or '0' means the package is included. +# 'yes' or '1' means the packages will be added later. +# The default if not set is 'no'. +# +# rpm_prebuiltdir (mandatory IF isexternalpkg=no) Path to the directory +# containing the pre-built RPMs relative to +# /source_packages directory. +# For example, if the file is +# "/source_packages/foobar/foo.rpm" +# then set "rpm_prebuiltdir=foobar". kitpackage: - filename=pkg1-1-1.noarch.rpm - kitrepoid=<<>> - # Method 1: Use pre-built RPM package - isexternalpkg=no - rpm_prebuiltdir=sample/pkg1 - -#kitpackage: -# filename=pkg2-1-1.noarch.rpm -# kitrepoid=<<>> -# # Method 2: Build RPM from spec + src dir -# rpm_spec=sample/pkg2/pkg2.spec -# rpm_srcdir=sample/pkg2/pkg2 -# -#kitpackage: -# filename=pkg3-1-1.noarch.rpm -# kitrepoid=<<>> -# # Method 3: Build RPM from spec + src tarball -# rpm_spec=sample/pkg3/pkg3.spec -# rpm_srctarball=sample/pkg3/pkg3.tar.gz -# -#kitpackage: -# filename=pkg4-1-1.noarch.rpm -# kitrepoid=<<>> -# # Method 4: Build RPM from source RPM -# rpm_srpm=sample/pkg4/pkg4-1-1.src.rpm -# + filename=pkg1-*.noarch.rpm + kitrepoid=<<>> + isexternalpkg=no + rpm_prebuiltdir=sample/pkg1