outputArtifacts type

This is a preview feature. Its API and behavior is subject to change. You must enable this feature by specifying output-artifacts in the previewFeatures API.

Specifies the configuration for the output directory containing the generated artifacts, including UKI PE images, shim, systemd-boot, and Verity hash files.

After Image Customizer outputs the selected artifacts, it will also generate a helper configuration file named inject-files.yaml under the same directory of output artifacts. This file can later be used to inject signed artifacts back into an image. For more details, see the injectFilesConfig documentation.

Example:

output:
  artifacts:
    items: 
    - ukis
    - shim
    - systemd-boot
    - verity-hash
    path: ./output
previewFeatures:
- output-artifacts

Added in v0.14.

path [string]

Required.

Specifies the directory path where Image Customizer will output the selected artifacts.

Added in v0.14.

items [string[]]

Required.

Specifies the artifacts that will be output after the image customization.

Supported values:

• ukis – UKI PE images (vmlinuz-<version>.efi).
• shim – Bootloader shim executable (boot<arch>.efi).
• systemd-boot – Systemd-boot executable (systemd-boot<arch>.efi).
• verity-hash – Verity hash files associated with dm-verity protected partitions. Added in v0.16.

The output.artifacts field must be used with the output-artifacts enabled in previewFeatures.

These artifacts are generated in an unsigned format and must be signed externally if required.

Supported architectures for shim and systemd-boot include x64 and arm64, reflected in the <arch> portion of the filenames.

The verity-hash artifact will only be output if the corresponding Verity entry defines a hashSignaturePath. If the hashSignaturePath is not configured, Image Customizer will skip generating the hash file for that Verity device. For more details, see the verity documentation.

Added in v0.14.