distro_const Command

The full syntax for the distro_const command is as follows:

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

The distro_const command options are described in the following table.

Table 3-1 distro_const Command Options

How to Build an Image in One Step

1. Download the distribution-constructor package.
2. Select a manifest for your image.
3. (Optional) If needed, customize the manifest, adding references to your custom scripts.
4. Become the root role.
5. Issue the basic distro_const command without options.

   # distro_const build manifest.xml

   Replace manifest with the name of the manifest file to be used as the blueprint for your image.

   For example:

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

   The distribution constructor pulls the needed packages for the image, and builds the image to the specifications that you set up in the manifest file.

6. (Optional) After the build is complete, you can view a log file reporting on the build process.

   The build output displays the location of log files.

How to Build an Image in Stages

You can use the options provided in the distro_const command to stop and restart the build process at various checkpoints in the image-generation process, in order to check and debug your selection of files, packages, and scripts for the image that is being built.

1. Download the distribution-constructor package.
2. Select manifest for your image.
3. (Optional) If needed, customize the manifest, adding references to your custom scripts.
4. Become the root role.
5. Review the valid checkpoints at which you can choose to pause or resume the build.

   # distro_const build -l manifest.xml

   This command displays the valid checkpoints at which you can pause or resume building an image. Use the checkpoint names provided by this command as valid values for the other checkpointing command options.

   For example, the following command confirms which checkpoints are available for a manifest file named dc_livecd.xml.

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

   Checkpoint        Resumable Description
   --------------    --------- -------------
   transfer-ips-install X Transfer package contents from IPS
   set-ips-attributes   X Set post-installation 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 archiving
   grub-setup             Set up the GRUB menu
   pkg-img-mod            Package image area modifications
   create-iso             ISO image creation

   ---

   Note - In this sample command output, an “X” in the resumable field indicates that you can restart the build from this checkpoint.

   ---

6. Build the image and pause building the image at the specified checkpoint.

   # distro_const build -p checkpoint manifest

   For example, the following command starts building an image and pauses the build before ba-arch modifies the image area:

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

7. Resume building the image from a specified checkpoint.

   # distro_const build -r checkpoint manifest

   ---

   Note - The specified checkpoint must be either the checkpoint at which the previous build stopped executing, or an earlier checkpoint. A later checkpoint is not valid.

   ---

   For example, the following command resumes building the image at the ba-arch stage.

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

   ---

   Note - You can combine the pause and resume options in a build command.

   ---

8. (Optional) After the build is complete, you can view a log file reporting on the build process.

   The build output displays the location of log files.