| Name | Description | Accepted Values or Format |
|---|---|---|
| image_repo | Required. The name of this image’s repository. | A repository must be made up of slash-separated name components (e.g. my/repo/name or reponame, where each component is limited to the set of characters [a-z0-9_.-], except they may not start with a ., _ or -. The total length of a repo name, including slashes, must be less than 256 characters. |
| image_manifest_digest | Special*. Also known as the image digest, this is a SHA256 hash of the image’s manifest JSON (image_manifest field), represented as a hexadecimal encoding of 256 bits. | Must be a SHA256 hash beginning in sha256:, e.g., sha256:6c3c624b58dbbcd3c0dd82b4c53f04194d1247c6eebdaab7c610cf7d66709b3b. If the image_manifest is provided, this must match the SHA256 hash of that field. |
| image_config_digest | Special*. Also known as the image ID, this is a SHA256 hash of the image’s configuration JSON (image_config field), represented as a hexadecimal encoding of 256 bits. | Must be a SHA256 hash encoded in hexadecimal and beginning in sha256:, e.g., sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9. If the image_config is provided, this must match the SHA256 hash of that field. |
| image_tags | Special*. A list of tags that identify this image. | Each tag is limited to the set of characters [a-zA-Z0-9_.-], except they may not start with a . or - character. Tags are limited to 128 characters. |
| image_registry | Optional. The primary registry that this image is stored in. | Must be a DNS hostname and comply with DNS rules (e.g. ghcr.io or 123456789012.dkr.ecr.region.amazonaws.com). It may optionally be followed by a port number (e.g. :8080). |
| image_secondary_registries | Optional. A list of secondary registries that this image is stored in. | Same as image_registry. |
| image_distro | Optional. The distribution of the operating system which this image is built to run on. | N/A |
| image_platform_os | Optional. The name of the operating system which the image is built to run on. If left blank this defaults to unknown. | This must match values listed in the Go Language document for GOOS, or otherwise be unknown. |
| image_platform_arch | Optional. The CPU architecture which the binaries in this image are built to run on. If left blank this defaults to unknown. | This must match values listed in the Go Language document for GOARCH, or otherwise be unknown. |
| image_platform_os_version | Optional. The version of the operating system which the image is built to run on. | N/A |
| image_platform_os_features | Optional. An array of strings, each specifying a mandatory OS feature. | N/A |
| image_platform_arch_variant | Optional. The variant of the CPU architecture of this image. | Must be a variant listed in the Platform Variants table of the OCI Image Index Specification, corresponding to the image_platform_arch. |
| image_platform_arch_features | Optional. An array of strings, each specifying a feature of the architecture. | N/A |
| image_manifest | Optional. The image’s manifest represented by a JSON object as defined in the OCI Image Manifest Specification or the Docker Image Manifest V 2, Schema 2. | Must be a JSON object that matches the OCI or Docker Image Manifest Specifications for the media types application/vnd.oci.image.manifest.v1+json or application/vnd.docker.distribution.manifest.v2+json. |
| image_config | Optional. The image’s configuration represented by a JSON object as defined in the OCI Image Configuration Specificationor the Docker v1 Image JSON Specification. | Must be a JSON object that matches the OCI or Docker Image Configuration Specifications for the media types application/vnd.oci.image.config.v1+json or application/vnd.docker.container.image.v1+json. |
At least one of image_manifest_digest or image_config_digest is required for an image to be content-addressable (uniquely identifiable). Tags do not uniquely identify an image, however Nucleus will use best effort matching to match an image that only has tags provided.