config type

The top-level type of the configuration.

Added in v0.3.

input [input]

Specifies the configuration for the input image.

Added in v0.13.0.

storage [storage]

Contains the options for provisioning disks, partitions, and file systems.

Added in v0.3.

iso [iso]

Optionally specifies the configuration for the generated ISO media.

Added in v0.3.

pxe [pxe]

Optionally specifies the PXE-specific configuration for the generated OS artifacts.

Added in v0.8.

os [os]

Contains the configuration options for the OS.

Example:

os:
  hostname: example-image

Added in v0.3.

scripts [scripts]

Specifies custom scripts to run during the customization process.

Added in v0.3.

previewFeatures [string[]]

Enables experimental and preview features that are not yet generally available. Features listed under previewFeatures must be explicitly included in the Image Customizer configuration to enable their usage.

Supported options:

  • uki: Enables the Unified Kernel Image (UKI) feature.

    When this option is specified, the os.uki configuration becomes available. A valid os.bootloader.reset value of hard-reset is required when os.uki is configured.

    Added in v0.8.

    Example:

    os:
      bootloader:
        resetType: hard-reset
      uki:
        kernels: auto
    previewFeatures:
    - uki
    
  • output-artifacts: Enables the configuration for the output directory containing the generated artifacts.

    When this option is specified, the output.artifacts configuration becomes available.

    See Output Artifacts for more details.

    Added in v0.14.

  • inject-files: Enables support for injecting files into specific partitions using a configuration file.

    When this option is specified, the inject-files.yaml configuration becomes available. This file can be generated using the output.artifacts API and later consumed via the inject-files CLI command.

    See injectFilesConfig for more details.

    Added in v0.14.

output [output]

Specifies the configuration for the output image and artifacts.

Added in v0.13.