ociImage type

A reference to an OCI artifact containing an OS image file.

The OCI artifact is expected to have a file with one of the following file extensions:

• .vhdx
• .vhd
• .qcow2
• .img
• .raw

If multiple such files exists in the artifact, then an error will occur.

Example:

input:
  image:
    oci:
      uri: mcr.microsoft.com/azurelinux/3.0/image/minimal-os:latest
      platform: linux/amd64

To use this feature, you must pass in a --image-cache-dir value when calling imagecustomizer.

This feature is in preview and may be subject to breaking changes. You may enable this feature by adding input-image-oci to the previewfeatures API.

When using official Azure Linux images from the Microsoft Artifact Registry (MCR), it is recommended that you use the dedicated input.image.azureLinux API.

Added in v1.1.

uri [string]

The URI of the OCI artifact containing the image to use as the base image.

This value is required.

Added in v1.1.

platform [ociPlatform]

Specifies the platform to use when the uri value points to a multi-platform artifact.

This value is optional. When platform is not specified, then if the uri value points to a multi-platform artifact, then os is set to linux and architecture is set to the system’s CPU architecture.

If platform is specified and the uri value does not point to a multi-platform artifact, then an error occurs.

As syntactic sugar, this value can be specified as a string with the following format:

OS[/ARCH]

Where:

• OS: The OS value.
• ARCH: The CPU architecture. If not specified, then it defaults to the system’s CPU architecture.

Added in v1.1.