distro_const

- Utility for creating Oracle Solaris images and media

Synopsis

/usr/bin/distro_const

distro_const --help

distro_const build [-v] [-r checkpoint name] [-p checkpoint name] [-l] manifest

Description

The distro_const command enables users to create an image by using a specified manifest file as the blueprint for the image.

You can create a text installer image that can be used to install the Oracle Solaris operating system on either x86 systems or SPARC systems.

Or, you can create an ISO image that is comparable to a LiveCD image containing the Oracle Solaris operating system.

Alternately, you can create a SPARC AI ISO image that can be used for network installations of the Oracle Solaris OS on SPARC clients, or an x86 AI ISO image that can be used for network installations of the Oracle Solaris OS on x86 clients.

Or, you can create a custom ISO image.

The basic distro_const command with no options creates a full image in one step.

The command options enable users to pause and resume the image-creation process at various “checkpoints,” thus enabling users to review status of the image and to check for bugs at each stage. Checkpointing saves time during builds by allowing you to bypass lengthy steps which have already been done at least once.

Sub-commands

The distro_const command has the subcommand and options listed below. Also see the Examples section.

--help

Displays usage.

build

distro_const build manifest

The subcommand, “build”, is required.

Creates a full image, using the specified manifest file as the blueprint for that image. The manifest name is required.

-v distro_const build -v

Specifies the verbose mode.

-l distro_const build [-l] manifest

Lists all valid checkpoints at which you can choose to pause or resume building an image. This command option queries the manifest file for valid checkpoints. Use the names provided by this command as valid values for the other checkpointing command options. The build subcommand is required.

The checkpoint values depend on entries in the manifest file.

-p distro_const build [-p checkpoint] manifest

Builds an image, but pauses building the image at the specified checkpoint name. Use the -l option to find valid names. You can combine the -r option and the -p option. The checkpoint name and manifest name are required. The build subcommand is required.

-r distro_const build [-r checkpoint] manifest

Resumes building the image from the specified checkpoint name. The specified name must be either the checkpoint at which the previous build stopped executing, or an earlier checkpoint. A later checkpoint is not valid. Use the -l option to determine which checkpoints are resumable. The -p option can be combined with the -r option. The checkpoint name and manifest name are required. The build subcommand is required.

-h distro_const [-h]

Displays command usage.

Examples

Example 1 Create an Image Using Checkpoint Options

1. Check which checkpoints are available. The manifest name in this example is dc_livecd.xml.

   # distro_const build -l /usr/share/distro_const/dc_livecd.xml

   The valid checkpoint names are displayed, as in this sample output.

    
   
     Checkpoint           Resumable  Description
     --------------------------------------------
     transfer-ips-install X Transfer pkg contents from IPS
     set-ips-attributes   X Set post-install IPS attributes
     pre-pkg-img-mod      X Pre-package image modification
     ba-init              X Boot archive initialization
     ba-config            X Boot archive configuration
     ba-arch              X Boot archive archival
     grub-setup           X Set up GRUB menu
     pkg-img-mod          X Pkg image area modification
     create-iso             ISO media creation
     create-usb             USB media creation     

2. Start building the image and pause at the ba-init checkpoint.

   # distro_const build -p ba-init /usr/share/distro_const/dc_livecd.xml

3. Restart the build from the ba-init checkpoint. Finish creating the image.

   # distro_const build -r ba-init /usr/share/distro_const/dc_livecd.xml

Example 2 Create an Image in One Step

To run a complete build of an image without pausing, use the basic distro_const command without checkpointing options. The manifest file name is dc_livecd.xml.

# distro_const build /usr/share/distro_const/dc_livecd.xml

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

dc_manifest(4)

Creating a Custom Oracle Solaris 11 Installation Image in the OTN documentation library for the current release.