EnvImageApi

Abstraction of image-related operations for virtualization frameworks.

In the context of this virtualization API, "images" refer to prepackaged system images which can be used as a base to spin up new containers. Examples include Docker images and Vagrant boxes.

Parameters

RepT

Class representation for an image.

Functions

Link copied to clipboard
abstract suspend fun create(inFile: Path): RepT

Creates an instance of a virtualization image.

Link copied to clipboard
abstract suspend fun inspect(image: RepT): Any?
Link copied to clipboard
abstract suspend fun list(): List<RepT>

Lists all images by their represented type.

Link copied to clipboard
abstract suspend fun pull(imageId: String): RepT

Pulls a virtualization image from a remote repository.

Link copied to clipboard
abstract suspend fun remove(image: RepT): Boolean

Removes an image with the given image from the local registry.