Cloud API Overview > @adpt/cloud > docker
docker namespace
Docker library for Adapt.
Classes
Class | Description |
---|---|
BuildKitImage | Locally builds a docker image |
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 |
MutableImageRef | A mutable reference to a container image that can be used to parse, construct, and modify an image reference, as well as to hold information about the image and how to access it. |
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 |
---|---|
hasId(o) | Type guard for determining whether a given object has a non-null id property. |
imageRef(ref, normalize) | Factory function for creating a docker.ImageRef or cloning an existing one. |
imageRef(info) | Factory function for creating a docker.ImageRef or cloning an existing one. |
isImageRefDockerhost(ref) | A type guard for determining whether a docker.ImageRef is a docker.ImageRefDockerHost. |
isImageRefDockerhostWithId(ref) | A type guard for determining whether a docker.ImageRef is a docker.ImageRefDockerHost that has the id property set. |
isImageRefRegistry(ref) | A type guard for determining whether a docker.ImageRef is a docker.ImageRefRegistry. |
isImageRefRegistryWithId(ref) | A type guard for determining whether a docker.ImageRef is a docker.ImageRefRegistry that has the id property set. |
LocalDockerRegistry(props) | Runs a Docker registry in a container. |
mutableImageRef(ref, normalize) | Factory function for creating a docker.MutableImageRef. |
mutableImageRef(info) | Factory function for creating a docker.MutableImageRef. |
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. |
BuildKitImageProps | Props for docker.BuildKitImage |
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. |
ImageRef | An immutable reference to a container image, including all information known about the image. |
ImageRefData | The most basic components that make up a docker.ImageRef. All other properties of a docker.ImageRef can be computed from these. |
ImageRefDockerHost | A more specific type of docker.ImageRef that contains sufficient information to uniquely identify an image on a specific Docker host (daemon). |
ImageRefRegistry | A more specific type of docker.ImageRef that contains sufficient information to uniquely identify an image on a container registry. |
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. |
ImageRefType | The type of an image reference indicates how the image can be accessed, currently either through a Docker host (daemon) or directly to a container registry via its API. |
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. |
WithId | Helper type that augments a base type to indicate that the id field is present and has a valid image ID. |