title | parent | nav_order |
---|---|---|
Command line |
API |
1 |
Displays the tool's quick help.
Required.
The directory where the tool will place its temporary files.
Required.
The base image file to customize.
This file is typically one of the standard Azure Linux core images. But it can also be an Azure Linux image that has been customized.
Supported image file formats: vhd, vhdx, qcow2, and raw.
Required.
The file path to write the final customized image to.
The image format of the the final customized image.
Options: vhd, vhd-fixed, vhdx, qcow2, raw, iso, and cosi.
At least one of --output-image-format
and --output-split-partitions-format
is
required.
The vhd-fixed option outputs a fixed size VHD image. This is the required format for VMs in Azure.
When the output image format is set to iso, the generated image is a LiveOS iso image. For more details on this format, see: Image Customizer ISO Support.
Format of partition files. If specified, disk partitions will be extracted as separate files and a json file with partition metadata will be produced. For more details on the json file format, see: Partition Metadata JSON Format.
Options: raw, raw-zst.
Enable shrinking of partition filesystems to their minimum size.
Currently only supports ext2/ext3/ext4 filesystems.
Can only be specified if --output-split-partitions-format
is, and
cannot be specified with --output-image-format
.
Required.
The file path of the YAML (or JSON) configuration file that specifies how to customize the image.
For documentation on the supported configuration options, see: Image Customizer configuration
A resource that provides RPM files to be used during package installation.
Can be one of:
-
Directory path: A path to a directory containing RPM files.
The RPMs may either be in the directory itself or any subdirectories.
-
*.repo
file path: A path to a RPM repo definition file.The file name extension must be
.repo
.Note: This file is not installed in the image during customization. If that is also needed, then use
AdditionalFiles
to place the repo file within the image.
This option can be specified multiple times.
RPM sources are specified in the order or priority from lowest to highest.
If --disable-base-image-rpm-repos
is not specified, then the in-built RPM repos are
given the lowest priority.
See, Building custom packages for a guide on how to build your own packages for Azure Linux.
See, Cloning an RPM repo for how to clone or download
RPMs from a existing RPM repo (such as packages.microsoft.com). Using a cloned repo with
--rpm-source
can help your builds avoid dependencies on external resources.
Disable the base image's installed RPM repos as a source of RPMs during package installation.
Create a folder containing the artifacts to be used for PXE booting.
For an overview of Image Customizer support for PXE, see the PXE support page.
Default: info
The verbosity of logs the tool outputs.
Higher levels of logging may be useful for debugging what the tool is doing.
The levels from lowest to highest level of verbosity are: panic
, fatal
, error
,
warn
, info
, debug
, and trace
.