From d3043285f22b0d65ee33c1d969d85e76cca3cae2 Mon Sep 17 00:00:00 2001
From: mellor <mellor@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Tue, 2 Apr 2013 17:54:01 +0000
Subject: [PATCH] update kit template with various changes

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@15790 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 .../xcat/kits/kit_template/buildkit.conf      | 37 +++++++++++++------
 .../xcat/kits/kit_template/docs/index.html    | 10 +++++
 2 files changed, 35 insertions(+), 12 deletions(-)
 create mode 100644 xCAT-buildkit/share/xcat/kits/kit_template/docs/index.html

diff --git a/xCAT-buildkit/share/xcat/kits/kit_template/buildkit.conf b/xCAT-buildkit/share/xcat/kits/kit_template/buildkit.conf
index f7582efa5..365aef867 100644
--- a/xCAT-buildkit/share/xcat/kits/kit_template/buildkit.conf
+++ b/xCAT-buildkit/share/xcat/kits/kit_template/buildkit.conf
@@ -12,6 +12,7 @@
 #    basename        (mandatory) Kit base name. e.g., kit-lsf
 #    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.
 #    isinternal      (optional)  PCM use only.
@@ -28,6 +29,7 @@ kit:
    basename=<<<INSERT_kitbasename_HERE>>>
    description=description for <<<INSERT_kitbasename_HERE>>>
    version=1.0
+   release=1
    ostype=Linux
    kitdeployparams=sample/kitdeployparams.lst
    kitlicense=EPL
@@ -76,8 +78,10 @@ kitrepo:
 # kitcomponent attributes:
 #    basename        (mandatory) Kit component base name
 #    description     (optional)  Kit component description
-#    version         (mandatory) Kit component version
-#    release         (mandatory) Kit component release
+#    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
@@ -93,11 +97,19 @@ kitrepo:
 #                       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)  TBD -- NOT SUPPORTED YET!
+#    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 
-#                       <Kit Build Directory>/source_packages 
+#                       <Kit Build Directory>/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 
+#                         /opt/xcat/kits/<kitbasename>/<kitcomponent_name>
+#                       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
@@ -114,15 +126,14 @@ kitrepo:
 kitcomponent:
     basename=<<<INSERT_kitcomponent_basename_HERE>>>
     description=description for component <<<INSERT_kitcomponent_basename_HERE>>>
-    version=1.0
-    release=1
     serverroles=compute
     kitrepoid=<<<INSERT_kitrepoid_HERE>>>
     #kitcompdeps=
     #ospkgdeps=
     kitpkgdeps=pkg1
     #kitpkgdeps=pkg1,pkg2,pkg2,pkg4
-    #non_native_pkgs= 
+    #non_native_pkgs=a_kitcomponent.file
+    #non_native_pkgs=EXTERNALPKGS:a_kitcomponent.file
     #driverpacks=
     exlist=sample/exclude.lst 
     preinstall=sample/pre.sh
@@ -151,11 +162,11 @@ kitcomponent:
 #                  which contains multiple kitrepoid lines.
 # 
 # kitpackage attributes:
-#    filename   (mandatory) Package filename
-#    kitrepoid  (mandatory) The repo(s) 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.
+#    filename   (mandatory) Package filename.  
+#    kitrepoid  (mandatory) A comma-separated list of kit reponames 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
@@ -165,6 +176,8 @@ kitcomponent:
 #                   <Kit Build Directory>/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,
diff --git a/xCAT-buildkit/share/xcat/kits/kit_template/docs/index.html b/xCAT-buildkit/share/xcat/kits/kit_template/docs/index.html
new file mode 100644
index 000000000..b00ea63c6
--- /dev/null
+++ b/xCAT-buildkit/share/xcat/kits/kit_template/docs/index.html
@@ -0,0 +1,10 @@
+<HTML>
+<HEAD>
+<TITLE>Product Documentation</TITLE>
+<!-- Replace the xCAT doc url with your product url   -->
+<meta http-equiv="REFRESH" content="0;url=http://sourceforge.net/apps/mediawiki/xcat/index.php?title=XCAT_Documentation"></HEAD>
+<BODY>
+Redirecting to:
+http://sourceforge.net/apps/mediawiki/xcat/index.php?title=XCAT_Documentation
+</BODY>
+</HTML>