Skip to content

Container image

The container-image kind represents an existing container image reference in a project. Its required image field is the image URI or registry reference. The backend may populate metadata such as the digest, media type, size, tags, and manifest information.

Creating a Containerimage entity records the reference; it does not build or push the image.

Create

New

new_containerimage

Create a new container image entity in the backend.

Parameters:

Name Type Description Default
project str

Project name.

required
name str

Entity name.

required
kind str

Entity kind.

required
uuid str

Entity identifier.

None
version str

Entity version.

None
description str

Human-readable entity description.

None
labels list[str]

Entity labels.

None
embedded bool

Whether to embed the entity specification in the project specification.

False
image str

Container image URI or registry reference.

None
**kwargs dict

Additional entity specification parameters.

{}

Returns:

Type Description
Containerimage

Created container image entity.

Examples:

Create an entity for an existing image reference:

import digitalhub as dh

image = dh.new_containerimage(
    project="my-project",
    name="my-image",
    kind="container-image",
    image="registry.example.com/my-image:latest",
)

Methods

The container-image kind adds no instance methods. See Use a container image for the common methods.