SpawnerImages#

pydantic model controller.models.v1.prepuller.SpawnerImages#

Images known to the Nublado controller and available for spawning.

This model is returned by the /spawner/v1/images route.

Parameters:

data (Any) –

Show JSON schema
{
   "title": "SpawnerImages",
   "description": "Images known to the Nublado controller and available for spawning.\n\nThis model is returned by the ``/spawner/v1/images`` route.",
   "type": "object",
   "properties": {
      "recommended": {
         "anyOf": [
            {
               "$ref": "#/$defs/PrepulledImage"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recommended image"
      },
      "latest_weekly": {
         "anyOf": [
            {
               "$ref": "#/$defs/PrepulledImage"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Latest weekly"
      },
      "latest_daily": {
         "anyOf": [
            {
               "$ref": "#/$defs/PrepulledImage"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Latest daily"
      },
      "latest_release": {
         "anyOf": [
            {
               "$ref": "#/$defs/PrepulledImage"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Latest release"
      },
      "all": {
         "items": {
            "$ref": "#/$defs/PrepulledImage"
         },
         "title": "All available images",
         "type": "array"
      }
   },
   "$defs": {
      "PrepulledImage": {
         "description": "Used to display available images.",
         "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"
         ],
         "title": "PrepulledImage",
         "type": "object"
      }
   },
   "required": [
      "all"
   ]
}

Fields:
field all: Annotated[list[PrepulledImage], Field(title='All available images')] [Required]#
field latest_daily: Annotated[PrepulledImage | None, Field(title='Latest daily')] = None#
field latest_release: Annotated[PrepulledImage | None, Field(title='Latest release')] = None#
field latest_weekly: Annotated[PrepulledImage | None, Field(title='Latest weekly')] = None#
field recommended: Annotated[PrepulledImage | None, Field(title='Recommended image')] = None#