DockerSourceOptions¶
- pydantic model controller.models.v1.prepuller.DockerSourceOptions¶
Docker Registry from which to get images.
- Parameters:
data (
Any
)
Show JSON schema
{ "title": "DockerSourceOptions", "description": "Docker Registry from which to get images.", "type": "object", "properties": { "type": { "const": "docker", "enum": [ "docker" ], "title": "Type of image source", "type": "string" }, "registry": { "default": "docker.io", "description": "Hostname and optional port of the Docker registry holding lab images", "examples": [ "lighthouse.ceres" ], "title": "Docker registry", "type": "string" }, "repository": { "description": "Docker repository path to the lab image, without tags or digests. This is sometimes called the image name.", "examples": [ "library/sketchbook" ], "title": "Docker repository (image name)", "type": "string" }, "credentials_path": { "default": "/etc/secrets/.dockerconfigjson", "description": "Path to a file containing a JSON-encoded dictionary of Docker credentials for various registries, in the same format as the Docker configuration file and the value of a Kubernetes pull secret", "format": "path", "title": "Path to Docker API credentials", "type": "string" } }, "required": [ "type", "repository" ] }
- field credentials_path: Annotated[Path, Field(title='Path to Docker API credentials', description='Path to a file containing a JSON-encoded dictionary of Docker credentials for various registries, in the same format as the Docker configuration file and the value of a Kubernetes pull secret', exclude=True)] = PosixPath('/etc/secrets/.dockerconfigjson')¶
Path to a file containing a JSON-encoded dictionary of Docker credentials for various registries, in the same format as the Docker configuration file and the value of a Kubernetes pull secret
- field registry: Annotated[str, Field(title='Docker registry', description='Hostname and optional port of the Docker registry holding lab images', examples=['lighthouse.ceres'])] = 'docker.io'¶
Hostname and optional port of the Docker registry holding lab images
- field repository: Annotated[str, Field(title='Docker repository (image name)', description='Docker repository path to the lab image, without tags or digests. This is sometimes called the image name.', examples=['library/sketchbook'])] [Required]¶
Docker repository path to the lab image, without tags or digests. This is sometimes called the image name.
- field type: Annotated[Literal['docker'], Field(title='Type of image source')] [Required]¶