--- a/usr/src/cmd/distro_const/docs/bootimage.html Mon Feb 15 15:49:15 2010 -0700
+++ b/usr/src/cmd/distro_const/docs/bootimage.html Wed Feb 17 10:37:53 2010 -0800
@@ -3,7 +3,7 @@
<!-- -->
<head>
-<!-- GenHTML revision 23224-->
+<!-- GenHTML revision 23436-->
<meta http-equiv="Content-type" content="text/html; charset=iso-8859-1">
<title>Get an AI Boot Image - OpenSolaris 2010.03 Distribution Constructor Guide</title>
<meta name="robots" content="index,follow">
@@ -101,17 +101,25 @@
name="prepare-image"
message="prepare bootable ai image"/>
<argslist>
+ <!-- Path to bootable AI image ISO -->
"/export/home/name_of_bootable_ai_image"
- </argslist>
+ <!-- What AI client manifest to use for installation.
+ "default" will use the existing AI client manifest
+ included on the AI media. To use a custom
+ AI client manifest, provide a path to your custom manifest -->
+ "default"
+ </argslist>
</script></pre><p>This field above references the <tt>prepare_ai_image</tt> finalizer script. This script finds and prepares
-the specified boot image for installation into the virtual machine.</p><p>The following line from this script provides a default path to an
-AI image, using a variable, <tt>name_of_bootable_ai_image</tt>, in place of an actual filename.</p><pre>"/export/home/name_of_bootable_ai_image"</pre><p>In this line, change the variable, <tt>name_of_bootable_ai_image</tt>, to the name of the
-AI image that you have previously downloaded. And, modify the full path to
-point to the file location where your image is stored. For example,</p><pre>"/export/home/myimage.iso"</pre>
+the specified boot image for installation into the virtual machine and provides an
+option to specify a custom AI client manifest.</p><p>The following line from this script provides a default path to an
+AI image, using a placeholder, <tt>name_of_bootable_ai_image</tt>, in place of an actual filename.</p><pre>"/export/home/name_of_bootable_ai_image"</pre><p>Change this line to point to the location on your local system,
+using your filename, for the AI image that you downloaded in the prior
+step. For example,</p><pre>"/export/home/myimage.iso"</pre>
<hr><p><b>Note - </b>The file location is provided within quotes. Do not remove the quotes. The
quotes are used to delineate each argument in the field.</p>
<hr>
-</li></ol>
+<p>You have the option to further modify this <tt>prepare_ai_image</tt> field to point
+to a custom AI client manifest as described in the next section.</p></li></ol>
</div>
</td>
</tr>
--- a/usr/src/cmd/distro_const/docs/customvmc.html Mon Feb 15 15:49:15 2010 -0700
+++ b/usr/src/cmd/distro_const/docs/customvmc.html Wed Feb 17 10:37:53 2010 -0800
@@ -3,7 +3,7 @@
<!-- -->
<head>
-<!-- GenHTML revision 23224-->
+<!-- GenHTML revision 23436-->
<meta http-equiv="Content-type" content="text/html; charset=iso-8859-1">
<title>Optional: Customize Build Specifications - OpenSolaris 2010.03 Distribution Constructor Guide</title>
<meta name="robots" content="index,follow">
@@ -107,29 +107,44 @@
<td align="left" valign="top" scope="row"><p>The <tt>finalizer</tt> section contains
a list of references to the finalizer scripts that are run when the
virtual machine is built. These scripts are used to customize the image and
-are run in the order listed in this manifest. The scripts have arguments
-that can be edited as described below.</p></td>
+are run in the order listed in this manifest.</p><p>As shown in the following
+script entries, each script field includes a required <tt>checkpoint</tt> field with a name
+for the checkpoint. The checkpoint marks the stage during the virtual machine build
+when this script is run. The checkpoint field also contains a checkpoint message.
+When the script runs, the message will display.</p><p>Each script also includes a field,
+<tt>argslist</tt>, that provides any arguments that are required for that particular script to
+run. You can edit these arguments as described in this table.</p>
+<hr><p><b>Note - </b>The arguments are
+provided within quotes. Do not remove the quotes. The quotes are used to
+delineate each argument in the field.</p>
+<hr>
+</td>
</tr>
<tr><td align="left" valign="top" scope="row"><pre><script name="/usr/share/distro_const/vmc/prepare_ai_image">
<checkpoint
name="prepare-image"
message="prepare bootable ai image"/>
<argslist>
+ <!-- Path to bootable AI image ISO -->
"/export/home/name_of_bootable_ai_image"
- </argslist>
-</script></pre></td>
-<td align="left" valign="top" scope="row"><p>The <tt>prepare_ai_image</tt> script finds and prepares the specified
-boot image for installation into the virtual machine</p><p>Each script field includes a
-required <tt>checkpoint</tt> field with a name for the checkpoint. The checkpoint marks the
-stage during the virtual machine build when this script is run. For this
-script, the checkpoint is named “prepare-image.” The checkpoint field also contains a checkpoint message.
-When the <tt>prepare_ai_image</tt> script runs, the default message, “prepare bootable ai image,” will
-display.</p><p>Each script also includes a field, <tt>argslist</tt>, that provides any arguments that are
-required for that particular script to run. You can edit these arguments as
-described in this table. For example, the <tt>prepare_ai_image</tt> script has an argument
-that provides the location of the boot image that will be used for
-the virtual machine build. You have already edited the default location, <tt>/export/home/name_of_bootable_ai_image</tt>,
-to point to the boot image that you will be using.</p></td>
+ <!-- What AI client manifest to use for installation.
+ "default" will use the existing AI client manifest
+ included on the AI media. To use a custom
+ AI client manifest, provide a path to
+ your custom manifest -->
+ "default"
+ </argslist>
+</script></pre><pre></pre></td>
+<td align="left" valign="top" scope="row"><p>In the prior section, you modified this
+<tt>prepare_ai_image</tt> script reference to point to the AI image that you have
+downloaded. You can, also, in this field, provide a pointer to a custom
+AI client manifest. By providing a custom AI client manifest, you can change
+the default installation specifications such as defining a particular installation target or changing the
+list of packages to be installed with the operating system.</p><p>Change the variable,
+<tt>"default"</tt>, to the path for your custom AI client manifest. The path will
+be a file path on the system where you are running the distribution
+constructor, as shown in this example.</p><pre><tt>"home/user/mymanifest.xml"</tt></pre><p>For instructions about creating a custom AI
+client manifest, see <a href="http://docs.sun.com/doc/820-6566/bootablemanifest?a=view">Creating a Custom Manifest in <i>OpenSolaris 2010.03 Automated Installer Guide</i></a>.</p></td>
</tr>
<tr><td align="left" valign="top" scope="row"><pre><script name="/usr/share/distro_const/vmc/create_vm">
<checkpoint
@@ -141,16 +156,16 @@
"opensolaris"
</argslist>
</script></pre></td>
-<td align="left" valign="top" scope="row"><p>The <tt>create_vm</tt>
-script builds and configures the virtual machine. The <tt>argslist</tt> field provides 3 arguments
-for the script. You can edit these arguments as follows.</p>
+<td align="left" valign="top" scope="row"><p>The <tt>create_vm</tt> script builds and configures the virtual machine. The
+<tt>argslist</tt> field provides 3 arguments for the script. You can edit these arguments
+as follows.</p>
<ul><li><p>Virtual machine disk size – The default is 16000 MB. Values between 12000 and 99.999.999 are valid.</p></li>
<li><p>Virtual machine ram size – The default is 1536 MB. Values between 1000 and 16,384 MB are valid.</p></li>
<li><p>Virtual machine type – The default is <tt>opensolaris</tt> for a 32–bit virtual machine. Or, use <tt>opensolaris_64</tt> for a 64–bit virtual machine.</p></li></ul>
-<hr><p><b>Note - </b>The <tt>create_vm</tt> script and
-its arguments affect the virtual machine specifically while it is being created. See
-the <tt>post_install_vm_config</tt> script below for arguments that affect the postinstallation virtual machine.</p>
+<hr><p><b>Note - </b>The <tt>create_vm</tt> script and its arguments affect the virtual machine specifically while
+it is being created. See the <tt>post_install_vm_config</tt> script below for arguments that
+affect the postinstallation virtual machine.</p>
<hr>
</td>
</tr>
@@ -159,8 +174,8 @@
name="install-vm"
message="Boot and Install virtual machine"/>
</script></pre></td>
-<td align="left" valign="top" scope="row"><p>The <tt>install_vm</tt>
-script boots and installs the virtual machine in the build area.</p></td>
+<td align="left" valign="top" scope="row"><p>The <tt>install_vm</tt> script boots and installs the virtual machine in
+the build area.</p></td>
</tr>
<tr><td align="left" valign="top" scope="row"><pre><script name="/usr/share/distro_const/vmc/
post_install_vm_config">
@@ -174,9 +189,9 @@
"on"
</argslist>
</script></pre></td>
-<td align="left" valign="top" scope="row"><p>The <tt>post_install_vm_config</tt> script
-performs postinstallation configuration on the virtual machine. The <tt>argslist</tt> field provides 3 arguments for
-the script. You can edit these arguments as follows.</p>
+<td align="left" valign="top" scope="row"><p>The <tt>post_install_vm_config</tt> script performs postinstallation configuration on the virtual machine. The
+<tt>argslist</tt> field provides 3 arguments for the script. You can edit these arguments
+as follows.</p>
<ul><li><p>Virtual machine ram size – The default is 1024 MB. Values between 1000 and 16,394 are valid.</p></li>
<li><p>Virtual machine number of CPUs – The default is 1 CPU. Values between 1 and 32 are valid.</p></li>
<li><p>Virtual machine VT-x/AMD—V support – Valid options are on or off.</p></li></ul>
@@ -190,17 +205,16 @@
"esx"
</argslist>
</script></pre></td>
-<td align="left" valign="top" scope="row"><p>The <tt>export_esx</tt> script converts
-the virtual machine into a set of ESX files that are ready for
-import. If you want your virtual machine files to be set up in
-ESX format, use this script. Otherwise, comment out this script.</p><p>For example, if you
-want to comment out the following field:</p><pre><sample_script>example</sample_script></pre><p>Enclose it as follows:</p><pre><!--
+<td align="left" valign="top" scope="row"><p>The <tt>export_esx</tt> script converts the virtual machine into a set of ESX
+files that are ready for import. If you want your virtual machine files
+to be set up in ESX format, use this script. Otherwise, comment out
+this script.</p><p>For example, if you want to comment out the following field:</p><pre><sample_script>example</sample_script></pre><p>Enclose
+it as follows:</p><pre><!--
<sample_script>example</sample_script>
---></pre><p>The ESX virtual
-machine will consist of a set of files in the <tt>build_area/media/esx</tt> folder.</p>
-<hr><p><b>Note - </b>If
-you use both the <tt>export_esx</tt> and <tt>export_ovf</tt> scripts, identical virtual machines for
-each format are created.</p>
+--></pre><p>The ESX virtual machine will consist of a set of
+files in the <tt>build_area/media/esx</tt> folder.</p>
+<hr><p><b>Note - </b>If you use both the <tt>export_esx</tt> and <tt>export_ovf</tt>
+scripts, identical virtual machines for each format are created.</p>
<hr>
</td>
</tr>
@@ -212,11 +226,12 @@
"ovf"
</argslist>
</script></pre></td>
-<td align="left" valign="top" scope="row"><p>The <tt>export_ovf</tt> script converts the virtual machine into a set of
-OVF files that are ready for import. If you want your
-virtual machine files to be set up in OVF format, use this script.
-Otherwise, comment out this script, so it will not be run.</p><p>The OVF virtual
-machine will consist of a set of files in the <tt>build_area/media/ovf</tt> folder.</p></td>
+<td align="left" valign="top" scope="row"><p>The <tt>export_ovf</tt> script converts the
+virtual machine into a set of OVF files that are ready for import.
+ If you want your virtual machine files to be set up in
+OVF format, use this script. Otherwise, comment out this script, so it will
+not be run.</p><p>The OVF virtual machine will consist of a set of
+files in the <tt>build_area/media/ovf</tt> folder.</p></td>
</tr>
</table>
</div>
--- a/usr/src/cmd/distro_const/docs/distro_const.html Mon Feb 15 15:49:15 2010 -0700
+++ b/usr/src/cmd/distro_const/docs/distro_const.html Wed Feb 17 10:37:53 2010 -0800
@@ -3,7 +3,7 @@
<!-- -->
<head>
-<!-- GenHTML revision 23224-->
+<!-- GenHTML revision 23436-->
<meta http-equiv="Content-type" content="text/html; charset=iso-8859-1">
<title>Building an Image - OpenSolaris 2010.03 Distribution Constructor Guide</title>
<meta name="robots" content="index,follow">
@@ -76,7 +76,7 @@
<li><p>Build an image, but pause and restart the build as needed to examine the content of the image and debug the finalizer scripts during the build process.</p></li></ul>
<p>The full syntax for this command is as follows:</p><pre>Syntax: <tt>distro_const build [<tt>-R</tt>] [<tt>-r</tt> <i>step</i>] [<tt>-p</tt> <i>step</i>] [<tt>-l</tt>] <i>manifest</i></tt></pre>
-<a name="gentextid-532"></a><h4>Building an Image in One Step</h4>
+<a name="gentextid-538"></a><h4>Building an Image in One Step</h4>
<p>To run a complete build of an image without pausing, use the
basic <tt>distro_const</tt> command without options as follows:</p><pre># <tt>distro_const build <i>manifest</i></tt></pre><p>Replace <i>manifest</i> with the name of the manifest file to be used as
the blueprint for your image. The <tt>build</tt> subcommand is required. When you
--- a/usr/src/cmd/distro_const/docs/manifest.html Mon Feb 15 15:49:15 2010 -0700
+++ b/usr/src/cmd/distro_const/docs/manifest.html Wed Feb 17 10:37:53 2010 -0800
@@ -3,7 +3,7 @@
<!-- -->
<head>
-<!-- GenHTML revision 23224-->
+<!-- GenHTML revision 23436-->
<meta http-equiv="Content-type" content="text/html; charset=iso-8859-1">
<title>Customize Your Image by Editing the Manifests - OpenSolaris 2010.03 Distribution Constructor Guide</title>
<meta name="robots" content="index,follow">
@@ -74,7 +74,7 @@
<ul><li><p>Names of the packages to be included in the image</p></li>
<li><p>Network location of the repository to access to retrieve packages for the image</p></li>
<li><p>Name and location of scripts used to finalize the creation of the new image</p></li></ul>
-<p>The default manifest files included in the <tt>SUNWdistro-const</tt> package are:</p><a name="manifesttbl"></a><h6>Table 2-2 Default Manifests</h6><table><col width="22%"><col width="38%"><col width="38%"><tr><th align="left" valign="top" scope="column"><p>Manifest Type</p></th>
+<p>The default manifest files included in the <tt>distribution-constructor</tt> package are:</p><a name="manifesttbl"></a><h6>Table 2-2 Default Manifests</h6><table><col width="22%"><col width="38%"><col width="38%"><tr><th align="left" valign="top" scope="column"><p>Manifest Type</p></th>
<th align="left" valign="top" scope="column"><p>Manifest Location</p></th>
<th align="left" valign="top" scope="column"><p>Description</p></th>
</tr>
--- a/usr/src/cmd/distro_const/docs/overview.html Mon Feb 15 15:49:15 2010 -0700
+++ b/usr/src/cmd/distro_const/docs/overview.html Wed Feb 17 10:37:53 2010 -0800
@@ -3,7 +3,7 @@
<!-- -->
<head>
-<!-- GenHTML revision 23224-->
+<!-- GenHTML revision 23436-->
<meta http-equiv="Content-type" content="text/html; charset=iso-8859-1">
<title>What is the Distribution Constructor? - OpenSolaris 2010.03 Distribution Constructor Guide</title>
<meta name="robots" content="index,follow">
@@ -66,13 +66,14 @@
<p>The distribution constructor is a command-line tool for building preconfigured OpenSolaris images and
virtual machine images. The tool takes an XML manifest file as input, and
builds an ISO image or virtual machine image that is based on the
-parameters specified in the manifest file. Optionally, a USB image can be created,
-based on a generated ISO image. Depending on the image configuration, these ISO
-or USB images can be bootable. They can be installed on a
-system or run in a live media environment. An ISO image can be
-burned to a CD or DVD. A USB image can be copied to
-a flash drive. Both ISO images and USB images can be distributed on
-the Internet.</p>
+parameters specified in the manifest file. An ISO image is an archive file,
+also known as a disc image, of an optical disc in a
+format defined by the International Organization for Standardization (ISO).</p><p>Optionally, a USB image can be created, based on a generated ISO
+image. Depending on the image configuration, these ISO or USB images can be
+bootable. They can be installed on a system or run in a live
+media environment. An ISO image can be burned to a CD or DVD.
+A USB image can be copied to a flash drive. Both ISO images
+and USB images can be distributed on the Internet.</p>
<hr><p><b>Note - </b>The Distribution Constructor creates a USB image that could work in various types
of flash memory devices, if those devices have driver support provided by the
OpenSolaris release. The <tt>usbcopy</tt> utility is the only utility that can be used
--- a/usr/src/cmd/distro_const/docs/sysreq.html Mon Feb 15 15:49:15 2010 -0700
+++ b/usr/src/cmd/distro_const/docs/sysreq.html Wed Feb 17 10:37:53 2010 -0800
@@ -3,7 +3,7 @@
<!-- -->
<head>
-<!-- GenHTML revision 23224-->
+<!-- GenHTML revision 23436-->
<meta http-equiv="Content-type" content="text/html; charset=iso-8859-1">
<title>System Requirements - OpenSolaris 2010.03 Distribution Constructor Guide</title>
<meta name="robots" content="index,follow">
@@ -88,11 +88,15 @@
</tr>
<tr><td align="left" valign="top" scope="row"><p>Required
packages</p></td>
-<td align="left" valign="top" scope="row"><p>Install the <tt>SUNWdistro-const</tt> package, which contains the distribution constructor application, on your system.</p><p>You
-can use the Package Manager tool to install the required package. The Package
-Manager is available on the menu bar on the desktop of the
-OpenSolaris operating system. On the menu bar, go to System>Administration>Package Manager.</p><p>Alternately, use IPS
-commands such as the following to install this package:</p><pre># <tt>pkg install SUNWdistro-const</tt></pre></td>
+<td align="left" valign="top" scope="row"><p>Install the <tt>distribution-constructor</tt> package, which contains the distribution constructor application, on your system.</p>
+<hr><p><b>Note - </b><b>Starting with the OpenSolaris 2010.03 release</b>,
+the <tt>SUNWdistro-const</tt> package has been renamed as the <tt>distribution-constructor</tt> package. Both the old and
+new names are usable.</p>
+<hr>
+<p>You can use the Package Manager tool to install
+the required package. The Package Manager is available on the menu bar on
+the desktop of the OpenSolaris operating system. On the menu bar, go to
+System>Administration>Package Manager.</p><p>Alternately, use IPS commands such as the following to install this package:</p><pre># <tt>pkg install distribution-constructor</tt></pre></td>
</tr>
</table>
</div>
--- a/usr/src/cmd/distro_const/docs/troublevm.html Mon Feb 15 15:49:15 2010 -0700
+++ b/usr/src/cmd/distro_const/docs/troublevm.html Wed Feb 17 10:37:53 2010 -0800
@@ -3,7 +3,7 @@
<!-- -->
<head>
-<!-- GenHTML revision 23224-->
+<!-- GenHTML revision 23436-->
<meta http-equiv="Content-type" content="text/html; charset=iso-8859-1">
<title>Troubleshooting During the Build - OpenSolaris 2010.03 Distribution Constructor Guide</title>
<meta name="robots" content="index,follow">
@@ -93,8 +93,6 @@
Invoking: VBoxHeadless startvm OpenSolaris_VM
VirtualBox Headless Interface 3.0.8
-(C) 2008-2009 Sun Microsystems, Inc.
-All rights reserved.
Listening on port 3389</pre><p>The last line in the log file states that the virtual machine
in question can be contacted on port 3389. Once you run the
--- a/usr/src/cmd/distro_const/docs/vmsysreq.html Mon Feb 15 15:49:15 2010 -0700
+++ b/usr/src/cmd/distro_const/docs/vmsysreq.html Wed Feb 17 10:37:53 2010 -0800
@@ -3,7 +3,7 @@
<!-- -->
<head>
-<!-- GenHTML revision 23224-->
+<!-- GenHTML revision 23436-->
<meta http-equiv="Content-type" content="text/html; charset=iso-8859-1">
<title>System Requirements for Building Virtual Machines - OpenSolaris 2010.03 Distribution Constructor Guide</title>
<meta name="robots" content="index,follow">
@@ -97,25 +97,28 @@
and an AI client manifest in order to perform an installation inside the
virtual machine. The host system running the distribution constructor needs to have
network access to an IPS repository, such as <a href="http://pkg.opensolaris.org">http://pkg.opensolaris.org</a>, that is specified
-in the AI client manifest. This manifest also provides a list of packages
-to be installed from the specified IPS repository.</p>
-<hr><p><b>Note - </b>You must run the distribution constructor
-as root on the host system.</p>
+in the AI client manifest.</p><p>You can use the default AI client manifest, or
+you can provide a custom AI client manifest as described in <a href="customvmc.html">Optional: Customize Build Specifications</a>. By
+creating a custom AI client manifest, you can change installation specifications such as
+defining a particular installation target or modifying the list of packages to be
+included in the operating system.</p>
+<hr><p><b>Note - </b>You must run the distribution constructor as root
+on the host system.</p>
<hr>
</td>
</tr>
<tr><td align="left" valign="top" scope="row"><p>VirtualBox, version 3.0.12</p></td>
-<td align="left" valign="top" scope="row"><p>You must have VirtualBox installed on
-the host system.</p></td>
+<td align="left" valign="top" scope="row"><p>You must have VirtualBox installed on the host
+system.</p></td>
</tr>
-<tr><td align="left" valign="top" scope="row"><p><tt>SUNWdistro-const</tt> package</p></td>
-<td align="left" valign="top" scope="row"><p>Install the most recent copy of the <tt>SUNWdistro-const</tt> package,
-which contains the distribution constructor application, on the host system.</p>
-<hr><p><b>Note - </b>You can use the
-Package Manager tool to install the required package. The Package Manager is available
-on the menu bar on the desktop of the OpenSolaris operating system. On
-the menu bar, go to System>Administration>Package Manager.</p><p>Alternately, use IPS commands such as
-the following to install this package:</p><pre># <tt>pkg install <i>SUNWdistro-const</i></tt></pre>
+<tr><td align="left" valign="top" scope="row"><p><tt>distribution-constructor</tt> package</p></td>
+<td align="left" valign="top" scope="row"><p>Install the most recent copy of the <tt>distribution-constructor</tt> package, which contains
+the distribution constructor application, on the host system.</p>
+<hr><p><b>Note - </b>You can use the Package Manager
+tool to install the required package. The Package Manager is available on the
+menu bar on the desktop of the OpenSolaris operating system. On the menu
+bar, go to System>Administration>Package Manager.</p><p>Alternately, use IPS commands such as the following
+to install this package:</p><pre># <tt>pkg install <i>distribution-constructor</i></tt></pre>
<hr>
</td>
</tr>
--- a/usr/src/man/dc_manifest.4.txt Mon Feb 15 15:49:15 2010 -0700
+++ b/usr/src/man/dc_manifest.4.txt Wed Feb 17 10:37:53 2010 -0800
@@ -1,4 +1,4 @@
-System Administration Commands dc_manifest(4)
+System Administration Commands ���������dc_manifest(4)
NAME
@@ -8,28 +8,29 @@
SYNOPSIS
- The following manifest files can be used to build
+� The following manifest files can be used to build
various OpenSolaris images. These manifests
- are included in the SUNWdistro_const package.
+ are included in the distribution-constructor
+ package.
- To build an x86 virtual machine image with
+ �To build an x86 virtual machine image with
OpenSolaris:
- /usr/share/distro_const/vmc/vmc_image.xml
+� /usr/share/distro_const/vmc/vmc_image.xml
- For x86 OpenSolaris OS images:
- /usr/share/distro_const/slim_cd/
+� For x86 OpenSolaris OS images:
+� /usr/share/distro_const/slim_cd/
all_lang_slim_cd_x86.xml
For x86 OpenSolaris OS image with limited
languages:
/usr/share/distro_const/slim_cd/slim_cd_x86.xml
- For SPARC automated installation images:
- /usr/share/distro_const/auto_install/
+ �For SPARC automated installation images:
+� /usr/share/distro_const/auto_install/
ai_sparc_image.xml
- For x86 automated installations images:
- /usr/share/distro_const/auto_install/
+ �For x86 automated installations images:
+� /usr/share/distro_const/auto_install/
ai_x86_image.xml
@@ -44,24 +45,24 @@
image that the distribution constructor builds. Per the
list above, use different manifests to build different
kinds of images.
-
+��
Use the distro_const command to build images,
referencing a manifest file in the command.
- If you want customize the image specifications,
+� If you want customize the image specifications,
copy a manifest file, customize the copy, and use
the copy as input for the distro_const command
when you build the image.
- Some of the more common fields to change in a
+ �Some of the more common fields to change in a
manifest include:
- * Names of the packages to be included in the image
- * Network location of the repository where packages
+� * Names of the packages to be included in the image
+� * Network location of the repository where packages
are stored
- * Name and location of scripts used to finalize the
- the new image
+� * Name and location of scripts used to finalize the
+��� the new image
- Note: When using the distribution constructor, you
+ �Note: When using the distribution constructor, you
can only create SPARC images on a SPARC system.
And, you can only create x86 images on an x86
system. And, the operating system release version
@@ -69,85 +70,85 @@
as the image that you are building.
-
+�
PRIMARY MANIFEST FIELDS
- All the manifests include the following editable
+� All the manifests include the following editable
fields.
- <distribution name="OpenSolaris">
-
- This field provides the name of OpenSolaris
- for the distribution, that is, the image, that you plan to
- build. You can leave this name or type a unique
- name for your distribution.
+�<distribution name="OpenSolaris">
+����
+ �This field provides the name of OpenSolaris
+����for the distribution, that is, the image, that you plan to
+����build. You can leave this name or type a unique
+����name for your distribution.
-
+�
<build_area>
This field specifies the area where the image will
- be created. You must check that the path specified
+����be created. You must check that the path specified
is valid for your system and revise as needed.
- If you want to use checkpointing, you must specify a
- ZFS dataset, or a mount point that correlates to a
+����If you want to use checkpointing, you must specify a
+����ZFS dataset, or a mount point that correlates to a
ZFS dataset, as your build area. If the ZFS dataset
does not exist, it will be created. The zpool that you
specify, however, must already exist.
- If you do not want to use checkpointing, you can use
- either a regular mount point or a ZFS or UFS file system.
+����If you do not want to use checkpointing, you can use
+����either a regular mount point or a ZFS or UFS file system.
- Note - After an image has been created, the build area
- for that image has the following structure.
+����Note - After an image has been created, the build area
+����for that image has the following structure.
- <build_area>/build_data/pkg_image
- Package image area.
- <build_area>/build_data/boot_archive
- boot archive build area.
- <build_area>/build_data/tmp
- Temporary directory used by the distribution
- constructor and by finalizer scripts.
- <build_area>/media
- Area where the output images are placed.
- <build_area>/logs
- Area that holds log files which record the steps
- executed by the application and the output from
- all commands. The "simple" log, named
- simple-log-YYYY-MM-DD-HH-Mi-SS,
- contains only errors (stderr). The "detail" log,
+������<build_area>/build_data/pkg_image
+�����������Package image area.
+������<build_area>/build_data/boot_archive
+�����������boot archive build area.
+�����<build_area>/build_data/tmp
+�����������Temporary directory used by the distribution
+�����������constructor and by finalizer scripts.
+�����<build_area>/media
+�����������Area where the output images are placed.
+�����<build_area>/logs
+�����������Area that holds log files which record the steps
+�����������executed by the application and the output from
+�����������all commands. The "simple" log, named
+�����������simple-log-YYYY-MM-DD-HH-Mi-SS,
+�����������contains only errors (stderr). The "detail" log,
named detail-log-YYYY-MM-DD-HH-Mi-SS,
- contains informational output (stdout) and
+�����������contains informational output (stdout) and
errors. The console echos information in the
- "simple" log file.
+�����������"simple" log file.
- <distro_constr_flags>
- <stop_on_error>true</stop_on_error>
- <checkpoint_enable>
- true
- </checkpoint_enable>
- </distro_constr_flags>
- The <stop_on_error> field controls whether the build
- should stop if there is an error. The value is set at
+�<distro_constr_flags>
+������<stop_on_error>true</stop_on_error>
+�� <checkpoint_enable>
+��������������true
+������</checkpoint_enable>
+�</distro_constr_flags> �
+������The <stop_on_error> field controls whether the build
+������should stop if there is an error. The value is set at
true.
- Use checkpointing to insert optional pauses between
+������Use checkpointing to insert optional pauses between
the steps of building an image.The value, true, in the
<checkpoint_enable> field enables checkpointing.
- Note: Checkpointing requires ZFS file systems.
+������Note: Checkpointing requires ZFS file systems.
- The <resume_from> attribute subfield for
- the <checkpoint_enable> field lets you specify
+������The <resume_from> attribute subfield for
+������the <checkpoint_enable> field lets you specify
the step to resume the build from. This value would
be overridden by the distro_const command with
the -r option.
-
+�����
Valid values for the <resume_from> field are the step
- names. Use the distro_const command with the -l
- option to list available step names.
+�����names. Use the distro_const command with the -l
+�����option to list available step names.
@@ -157,74 +158,74 @@
manifest, include the following editable fields.
- <pkg_repo_default_authority>
- <main url="http://pkg.opensolaris.org/release"
- authname="opensolaris.org"/>
- </pkg_repo_default_authority>
+�<pkg_repo_default_authority>
+������<main url="http://pkg.opensolaris.org/release"
+��� authname="opensolaris.org"/>
+�</pkg_repo_default_authority>
- This field specifies the location of an IPS repository.
+������This field specifies the location of an IPS repository.
The repository is made available by an IPS publisher,
also called an authority. The distribution constructor
retrieves packages from the repository when it builds
an image.
- The repository location above is set at:
- http://pkg.opensolaris.org/release
+�����The repository location above is set at:
+�����http://pkg.opensolaris.org/release
- And, the authority (publisher) is set as opensolaris.org.
+�����And, the authority (publisher) is set as opensolaris.org.
- Modify the URL and authname fields to point to a
+������Modify the URL and authname fields to point to a
different repository, if needed.
- Note: If you want to use an OpenSolaris development
+������Note: If you want to use an OpenSolaris development
build, change /release to /dev.
- If you want to use one or more mirrors for an authority,
- or publisher, uncomment the mirror subfield, and specify
- the mirror urls in this field:
- <mirror url="" />
+������If you want to use one or more mirrors for an authority,
+������or publisher, uncomment the mirror subfield, and specify
+������the mirror urls in this field: �����
+������<mirror url="" />
- <pkg_repo_addl_authority>
+�<pkg_repo_addl_authority>
- This field specifies a repository to be used when the
+������This field specifies a repository to be used when the
main repository is unavailable. This field uses the
same format as the main repository field.
- <packages>
- <pkg name="entire"/>
- <pkg name="SUNWcsd"/>
- <pkg name="SUNWcs"/>
- <pkg name="slim_install"/>
- <pkg name="SUNWslim-utils"/>
- </packages>
+�<packages>
+�� <pkg name="entire"/>
+�� <pkg name="SUNWcsd"/>
+�� <pkg name="SUNWcs"/>
+�� <pkg name="slim_install"/>
+�� <pkg name="SUNWslim-utils"/>
+�</packages>
- This field lists the packages to be included in the
- image. The packages provided will build the
+������This field lists the packages to be included in the
+������image. The packages provided will build the
OpenSolaris Live CD image. If you have packages
that you want to add to the image, list your packages
in this field, one package per line.
- Note: “entire” is an incorporation. “slim_install” is
+ Note: "entire" is an incorporation. "slim_install" is
a cluster. Both contain many packages.
- Note: Due to dependency issues, SUNWcsd and
- SUNWcs must be listed first in the package list, and
- SUNWcsd must precede SUNWcs.
+������Note: Due to dependency issues, SUNWcsd and
+������SUNWcs must be listed first in the package list, and
+������SUNWcsd must precede SUNWcs.
- The latest build available in the specified IPS
+������The latest build available in the specified IPS
repository will be installed. If another build is
required, the build number has to be appended
to 'entire' in following form:
- <pkg_name="[email protected]#/>
+�����������<pkg_name="[email protected]#/>
- <post_install_remove_packages>
- <pkg name="babel_install"/>
- <pkg name=”slim_install”/>
- </post_install_remove_packages>
-
+�<post_install_remove_packages>
+������<pkg name="babel_install"/>
+ <pkg name="slim_install"/>
+�</post_install_remove_packages>
+������
If you want to remove individual packages from a
cluster, list the individual packages in this field,
one package per line.
@@ -242,37 +243,37 @@
once installation of packages is completed. The
default manifest removes the cluster definition,
so that further customization of the packages can
- be done.
slim_install is another cluster. And,
+ be done. slim_install is another cluster. And,
slim_install is part of babel_install which is installed
by the default manifest. The default manifest then
uninstalls slim_install, in order to permit customization.
- <live_img_compression type="lzma"/>
+�<live_img_compression type="lzma"/>
- Use this field to specify how the solarismisc.zlib
+������Use this field to specify how the solarismisc.zlib
archive will be compressed. Valid compression
types are lzma, gzip, and none.
- <grub_menu_modifications>
+�<grub_menu_modifications>
- You can edit the GRUB menu contents here
- and add a custom title to the menu. See the
+������You can edit the GRUB menu contents here
+������and add a custom title to the menu. See the
comments in the manifest file for details.
- <boot_archive_contents>
- This section lists the files and directories that
- will be included in the boot archive for the image that
+�<boot_archive_contents>
+������This section lists the files and directories that
+������will be included in the boot archive for the image that
is built. See the comments in the manifest file for
information.
- Files or directories that need to be excluded from
+������Files or directories that need to be excluded from
the image are specified with the base_exclude
tag.
- Caution – Modifying the boot archive contents could
+������Caution - Modifying the boot archive contents could
render the system unbootable. If you do add files or
directories, use the base_include tag as show in
the manifest and these examples:
@@ -285,21 +286,21 @@
kernel
</base_include>
- The boot archive for x86 images differs from the boot
- archive for SPARC images. The whole boot archive
+������The boot archive for x86 images differs from the boot
+������archive for SPARC images. The whole boot archive
for x86 images is a UFS filesystem,
- compressed by using gzip. The SPARC platform does
- not support the compression of the whole boot archive
- in this way. Instead, SPARC boot archives use DCFS,
- which compress each file individually. These
- individually compressed files might require specific
- handling in the manifest.
+������compressed by using gzip. The SPARC platform does
+������not support the compression of the whole boot archive
+������in this way. Instead, SPARC boot archives use DCFS,
+������which compress each file individually. These
+������individually compressed files might require specific
+������handling in the manifest.
- During boot time, some of the files in the boot archive
- need to be modified. But, compressed files cannot be
- modified. Therefore, for SPARC images, you need to
- specify in the manifest which files should not be
- compressed. See the boot_archive_archive.py script,
+������During boot time, some of the files in the boot archive
+������need to be modified. But, compressed files cannot be
+������modified. Therefore, for SPARC images, you need to
+������specify in the manifest which files should not be
+������compressed. See the boot_archive_archive.py script,
referenced in the finalizer section of the manifest,
for the default list of boot_archive files which are not
compressed. You must explicitly list any file that needs
@@ -312,52 +313,53 @@
FINALIZER SECTION
In all manifests, the <finalizer> section lists the
- finalizer scripts that the distribution constructor
- invokes when building an image, and the order in
- which the distribution constructor invokes them.
+� finalizer scripts that the distribution constructor
+� invokes when building an image, and the order in
+� which the distribution constructor invokes them.
- Finalizer scripts transform the image into a
- media-specific distribution. A set of finalizer
- scripts are provided in the SUNWdistro_const
- package.
+ �Finalizer scripts transform the image into a
+� media-specific distribution. A set of finalizer
+� scripts are provided in the SUNWdistro_const
+� package.
- All finalizer scripts are passed a standard set of five
+ �All finalizer scripts are passed a standard set of five
arguments as their first arguments. See a finalizer
script header for more information. Some scripts,
such as those used to build virtual machine images,
require additional arguments. The are defined in the
- <argslist> field within the <script_name> field.
- These arguments are passed to the scripts beginning
- as the sixth argument.
+ <argslist> field within the <script_name> field, as
+ shown in the sample below. These arguments are
+ passed to the scripts beginning as the sixth argument.
You do have the option to write and add your own
scripts. If you do create new scripts, modify the
manifest to point to them.
- You do not need to edit the <finalizer> section
+� You do not need to edit the <finalizer> section
unless you add new finalizer scripts, or you
change the name or the argslist of existing scripts.
- The basic format for each script reference in the
- <finalizer> section is as follows:
+� The basic format for each script reference in the
+� <finalizer> section is as follows:
- <finalizer>
+� <finalizer>
...
- <script name="/usr/share/distro_const/im_pop.py">
- <checkpoint
- name="im-pop"
- message="Image area creation"/>
- <argslist>
- "16000"
- "1536"
- "opensolaris"
- </argslist>
- </script>
+ <script name="/usr/share/distro_const/vmc/create_vm">
+ <checkpoint
+ name="create-vm"
+ message="create and configure a
+ virtual machine"/>
+ <argslist>
+ "16000"
+ "1536"
+ "opensolaris"
+ </argslist>
+ </script>�����
...
- </finalizer>
-
+� </finalizer>
+����������
The <script name> field provides the name and
- the location of a script.
+� the location of a script.
The <checkpoint> field specifies a checkpoint
name and is required. This field is used to specify
@@ -365,60 +367,65 @@
The checkpoint name corresponds to the point in
the build just before the script associated with that
checkpoint is run. See the distro_const(1M) man
- page.
+ page.������
- The checkpoint message attribute is optional. The
- checkpoint message is displayed when the step is
+� The checkpoint message attribute is optional. The
+� checkpoint message is displayed when the step is
run.
- For information about the existing finalizer scripts,
+ The <argslist> field provides arguments that are
+ required for that particular script to run. You can
+ edit these arguments.
+
+ �For information about the existing finalizer scripts,
creating and using custom finalizer scripts, and
- editing script arguments, see
- http://dlc.sun.com/osol/docs/content/dev/
+� editing script arguments, see
+� http://dlc.sun.com/osol/docs/content/dev/
DistroConst/scripts.html
-
+�����
KEY VALUE PAIRS FIELD
- <key_value_pairs>
+�<key_value_pairs>
...
- <pair key="iso_sort"
- value="/usr/share/distro_const/slim_cd/
- slimcd_iso.sort"/>
- </key_value_pairs>
-
+������<pair key="iso_sort"
+�����������value="/usr/share/distro_const/slim_cd/
+�����������slimcd_iso.sort"/>
+�</key_value_pairs>
+�������
This field provides additional specifications that
- are needed by the distribution constructor or by
- finalizer scripts.
+� are needed by the distribution constructor or by
+�� finalizer scripts.
- You do not need to edit the key-value pairs
+������You do not need to edit the key-value pairs
except to add new ones that will be recognized by
new or customized finalizer scripts.
- For information about using key-value pairs, see
- http://dlc.sun.com/osol/docs/content/dev/DistroConst/
+������For information about using key-value pairs, see
+������http://dlc.sun.com/osol/docs/content/dev/DistroConst/
scripts.html
ATTRIBUTES
- /usr/share/man/man4/dc_manifest4
+��/usr/share/man/man4/dc_manifest4
- ATTRIBUTE TYPE ATTRIBUTE VALUE
+��ATTRIBUTE TYPE �������ATTRIBUTE VALUE
- Availability SUNWdistro-const
+��Availability ���������distribution-constructor
+ package
- Interface Stability In Development
+��Interface Stability ��In Development
SEE ALSO
- distro_const(1M) man page
+�distro_const(1M) man page
- OpenSolaris Distribution Constructor Guide
- at /usr/share/doc/distro_const/index.html or at
- http://dlc.sun.com/osol/docs/content/dev/DistroConst/
+� OpenSolaris Distribution Constructor Guide
+��at /usr/share/doc/distro_const/index.html or at
+��http://dlc.sun.com/osol/docs/content/dev/DistroConst/
-OpenSolaris 2010.03 Last Changed February 7, 2010
+OpenSolaris 2010.03 �Last Changed February 16, 2010