PrepulledImage

pydantic model controller.models.v1.prepuller.PrepulledImage

Used to display available images.

Parameters:

data (Any)

Show JSON schema

{
   "title": "PrepulledImage",
   "description": "Used to display available images.",
   "type": "object",
   "properties": {
      "reference": {
         "description": "Reference of image, which includes the registry host name, the normally-two-part image name within that registry, and the tag or hash of the specific version of that image.",
         "examples": [
            "lighthouse.ceres/library/sketchbook:latest_daily"
         ],
         "title": "Docker reference of image",
         "type": "string"
      },
      "tag": {
         "description": "Tag portion of the image reference",
         "examples": [
            "w_2023_04"
         ],
         "title": "Image tag",
         "type": "string"
      },
      "name": {
         "description": "Tag of the image formatted for humans",
         "examples": [
            "Latest Daily (Daily 2077_10_23)"
         ],
         "title": "Human-readable tag",
         "type": "string"
      },
      "digest": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Full digest of image if known",
         "examples": [
            "sha256:e693782192ecef4f7846ad2b21b1574682e700747f94c5a256b5731331a2eec2"
         ],
         "title": "Digest of image"
      },
      "aliases": {
         "default": [],
         "description": "Other tags that reference the same image",
         "examples": [
            [
               "recommended",
               "latest_weekly"
            ]
         ],
         "items": {
            "type": "string"
         },
         "title": "Other aliases",
         "type": "array"
      },
      "prepulled": {
         "default": false,
         "description": "Whether the image has been prepulled to all eligible nodes",
         "examples": [
            true
         ],
         "title": "Whether image is prepulled",
         "type": "boolean"
      }
   },
   "required": [
      "reference",
      "tag",
      "name"
   ]
}

Fields:

• aliases (Annotated[list[str], Field(title='Other aliases', description='Other tags that reference the same image', examples=[['recommended', 'latest_weekly']])])

• digest ()

• name ()

• prepulled (Annotated[bool, Field(title='Whether image is prepulled', description='Whether the image has been prepulled to all eligible nodes', examples=[True])])

• reference ()

• tag ()

field aliases: Annotated[list[str], Field(title='Other aliases', description='Other tags that reference the same image', examples=[['recommended', 'latest_weekly']])] = []

Other tags that reference the same image

field digest: Annotated[str | None, Field(title='Digest of image', description='Full digest of image if known', examples=['sha256:e693782192ecef4f7846ad2b21b1574682e700747f94c5a256b5731331a2eec2'])] = None

Full digest of image if known

field name: Annotated[str, Field(title='Human-readable tag', description='Tag of the image formatted for humans', examples=['Latest Daily (Daily 2077_10_23)'])] [Required]

Tag of the image formatted for humans

field prepulled: Annotated[bool, Field(title='Whether image is prepulled', description='Whether the image has been prepulled to all eligible nodes', examples=[True])] = False

Whether the image has been prepulled to all eligible nodes

field reference: Annotated[str, Field(title='Docker reference of image', description='Reference of image, which includes the registry host name, the normally-two-part image name within that registry, and the tag or hash of the specific version of that image.', examples=['lighthouse.ceres/library/sketchbook:latest_daily'])] [Required]

Reference of image, which includes the registry host name, the normally-two-part image name within that registry, and the tag or hash of the specific version of that image.

field tag: Annotated[str, Field(title='Image tag', description='Tag portion of the image reference', examples=['w_2023_04'])] [Required]

Tag portion of the image reference

classmethod from_rsp_image(image, nodes)

Convert from an RSPImage.

Parameters:

• image (RSPImage) – Source image.

• nodes (set[str]) – Nodes this image must be on to count as prepulled.

Returns:

Converted image.

Return type:

PrepulledImage