Cloud API Overview > @adpt/cloud > docker

docker namespace

Docker library for Adapt.

Classes

Class	Description
default	Component to instantiate an image container with docker
DockerContainer	Component to instantiate an image container with docker
DockerImage	(BETA) Abstract component representing a Docker image that can be used to create containers.
LocalDockerImage	Locally builds a docker image
RegistryDockerImage	Represents a Docker image in a registry.
ServiceContainerSet	A component for mapping a group of abstract Containers and NetworkServices to Docker DockerContainers and docker.NetworkService()s.

Functions

Function	Description
LocalDockerRegistry(props)	Runs a Docker registry in a container.
NetworkService(props)	Docker network service component, compatible with the abstract NetworkService component.

Interfaces

Interface	Description
BindMount	Describes bind mount filesystems to be mounted in a container.
DockerBuildOptions	Options for performing Docker image builds.
DockerContainerProps	Props for docker.DockerContainer
DockerContainerStatus
DockerGlobalOptions	Options for interacting with Docker Engine that apply to all operations.
DockerImageInstance	Components that provide a Docker image can implement this interface to allow other components to get information about the Docker image.
DockerImageProps	(BETA) Props for docker.DockerImage.
DockerPushableImageInstance	Components that provide a Docker image can implement this interface to allow other components to get information about the Docker image and to be able to push the image to a registry.
DockerRegistryInstance
DockerSplitRegistryInfo	(BETA) Represents a split registry, with pushes going to external and pulls going to internal
File	A dynamically-created file that can be used during the build of a Docker image.
ImageInfo	Information about a specific instance of a Docker image, as identified by its image ID.
LocalDockerImageProps	Props for docker.LocalDockerImage
LocalDockerRegistryProps	Props for docker.LocalDockerRegistry()
RegistryDockerImageProps	Props for docker.RegistryDockerImage
ServiceContainerSetProps	Props for docker.ServiceContainerSet
Stage	A stage to be added to a multi-stage Docker build.

Type Aliases

Type Alias	Description
ImageIdString	Docker image ID, in the form algorithm:hex.
ImageNameString	A string reference to a Docker image that contains a repo name, and may contain an optional registry and optionally either a tag or a repo digest.
Mount	Describes filesystems to be mounted in a container.
NameTagString	A string reference to a Docker image that contains a repo name, and may contain an optional registry and optional tag.
RegistryString	A string that references a Docker registry that contains a hostname and may optionally contain a port and/or path.
RepoDigestString	A string that contains both a Docker repo and a registry digest.