OpenSolaris 2008.11 Distribution Constructor Guide
Previous Next

distro_const Command Reference

The distribution constructor provides the ability to pause, or “checkpoint,” and resume at certain stages of the image-generation process. This checkpointing feature is enabled by default.


Note - You can disable checkpointing in the manifest file by setting the checkpoint_enable parameter to false.


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. Then use the checkpointing options in the distro_const command.

The following table summarizes the distro_const command options.

Table 2-3 distro_const Command

Command Options

Description

distro_const build manifest

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

distro_const build -l manifest

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


Note - Checkpointing is active by default, but requires ZFS filesystems.

Step values other than the first one correspond to finalizer script entries in the manifest file.


The default manifest file includes the following steps:

  • im-pop – Populate the image with packages

  • slim-im-mod – Slim CD image area modifications

  • br-init – Boot-root initialization

  • slim-br-config – Slim CD boot-root configuration

  • br-config – Boot-root configuration

  • br-arch – Boot-root archiving

  • slim-post-mod – Slim CD post-boot-root image area modifications

  • grub-setup – GRUB menu setup

  • post-mod – Post-boot-root image area modification

  • iso – ISO image creation

  • usb – USB image creation

When additional scripts are added, additional steps are added.


Note - Use meaningful names for steps instead of using step numbers. If new scripts are added, the new steps for those new scripts will throw off a prior numbered step order.


distro_const build -p step manifest

Builds an image and pauses building the image at the specified step if checkpointing is active. The step and manifest fields are required. The build subcommand is required.

distro_const build -r step manifest

Resumes building the image from the specified step if checkpointing is active. The specified step must be either the step at which the previous build stopped executing, or an earlier step. A later step is not valid. The step and manifest fields are required. The build subcommand is required.

distro_const build -R manifest

Resumes building the image from the last step executed if checkpointing is active. The manifest field is required. The build subcommand is required.

See also the distro_const(1M) man page.

Previous Next