Container
class Container extends AbstractObject implements IdAble
An OCI-compatible container, also known as a Docker container.
Properties
$lastQuery | from AbstractObject |
Methods
No description
Turn the container into a Service.
Package the container state as an OCI image, and return it as a tar archive
Initializes this container from a Dockerfile build.
Return the container's default arguments.
Retrieve a directory from the container's root filesystem
Return the container's OCI entrypoint.
Retrieves the value of the specified environment variable.
Retrieves the list of environment variables passed to commands.
check if a file or directory exists
The exit code of the last executed command
EXPERIMENTAL API! Subject to change/removal at any time.
EXPERIMENTAL API! Subject to change/removal at any time.
Writes the container as an OCI tarball to the destination file path on the host.
Exports the container as an image to the host's container image store.
Retrieves the list of exposed ports.
Download a container image, and apply it to the container state. All previous state will be lost.
A unique identifier for this Container.
The unique image reference which can only be retrieved immediately after the 'Container.From' call.
Retrieves the value of the specified label.
Retrieves the list of labels passed to container.
Retrieves the list of paths where a directory is mounted.
Package the container state as an OCI image, and publish it to a registry
Return a snapshot of the container's root filesystem. The snapshot can be modified then written back using withRootfs. Use that method for filesystem modifications.
The buffered standard error stream of the last executed command
The buffered standard output stream of the last executed command
Forces evaluation of the pipeline in the engine.
Opens an interactive terminal for this container using its configured default terminal command if not overridden by args (or sh as a fallback default).
Starts a Service and creates a tunnel that forwards traffic from the caller's network to that service.
Retrieves the user to be set for all commands.
Retrieves this container plus the given OCI anotation.
Configures default arguments for future commands. Like CMD in Dockerfile.
Set the default command to invoke for the container's terminal API.
Return a new container snapshot, with a directory added to its filesystem
Set an OCI-style entrypoint. It will be included in the container's OCI configuration. Note, withExec ignores the entrypoint by default.
Set a new environment variable in the container.
Execute a command in the container, and return a new snapshot of the container state after execution.
Expose a network port. Like EXPOSE in Dockerfile (but with healthcheck support)
Return a container snapshot with a file added
Retrieves this container plus the contents of the given files copied to the given path.
Retrieves this container plus a cache volume mounted at the given path.
Retrieves this container plus a directory mounted at the given path.
Retrieves this container plus a file mounted at the given path.
Retrieves this container plus a secret mounted into a file at the given path.
Retrieves this container plus a temporary directory mounted at the given path. Any writes will be ephemeral to a single withExec call; they will not be persisted to subsequent withExecs.
Return a new container snapshot, with a file added to its filesystem with text content
Attach credentials for future publishing to a registry. Use in combination with publish
Change the container's root filesystem. The previous root filesystem will be lost.
Set a new environment variable, using a secret value
Establish a runtime dependency from a container to a network service.
Return a snapshot with a symlink
Retrieves this container plus a socket forwarded to the given Unix socket path.
Change the container's working directory. Like WORKDIR in Dockerfile.
Retrieves this container minus the given OCI annotation.
Remove the container's default arguments.
Return a new container snapshot, with a directory removed from its filesystem
Reset the container's OCI entrypoint.
Retrieves this container minus the given environment variable.
Unexpose a previously exposed port.
Retrieves this container with the file at the given path removed.
Return a new container spanshot with specified files removed
Retrieves this container minus the given environment label.
Retrieves this container after unmounting everything at the given path.
Retrieves this container without the registry authentication of a given address.
Retrieves this container minus the given environment variable containing the secret.
Retrieves this container with a previously added Unix socket removed.
Retrieves this container with an unset command user.
Unset the container's working directory.
Retrieves the working directory for all commands.
Details
in
AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
in
AbstractObject at line 19
protected null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
at line 21
Service
asService(array|null $args = null, bool|null $useEntrypoint = false, bool|null $experimentalPrivilegedNesting = false, bool|null $insecureRootCapabilities = false, bool|null $expand = false, bool|null $noInit = false)
Turn the container into a Service.
Be sure to set any exposed ports before this conversion.
at line 54
File
asTarball(array|null $platformVariants = null, ImageLayerCompression|null $forcedCompression = null, ImageMediaTypes|null $mediaTypes = null)
Package the container state as an OCI image, and return it as a tar archive
at line 75
Container
build(Directory $context, string|null $dockerfile = 'Dockerfile', string|null $target = '', array|null $buildArgs = null, array|null $secrets = null, bool|null $noInit = false)
Initializes this container from a Dockerfile build.
at line 106
array
defaultArgs()
Return the container's default arguments.
at line 117
Directory
directory(string $path, bool|null $expand = false)
Retrieve a directory from the container's root filesystem
Mounts are included.
at line 130
array
entrypoint()
Return the container's OCI entrypoint.
at line 139
string
envVariable(string $name)
Retrieves the value of the specified environment variable.
at line 149
array
envVariables()
Retrieves the list of environment variables passed to commands.
at line 158
bool
exists(string $path, ExistsType|null $expectedType = null, bool|null $doNotFollowSymlinks = false)
check if a file or directory exists
at line 176
int
exitCode()
The exit code of the last executed command
Returns an error if no command was executed
at line 189
Container
experimentalWithAllGPUs()
EXPERIMENTAL API! Subject to change/removal at any time.
Configures all available GPUs on the host to be accessible to this container.
This currently works for Nvidia devices only.
at line 202
Container
experimentalWithGPU(array $devices)
EXPERIMENTAL API! Subject to change/removal at any time.
Configures the provided list of devices to be accessible to this container.
This currently works for Nvidia devices only.
at line 214
string
export(string $path, array|null $platformVariants = null, ImageLayerCompression|null $forcedCompression = null, ImageMediaTypes|null $mediaTypes = null, bool|null $expand = false)
Writes the container as an OCI tarball to the destination file path on the host.
It can also export platform variants.
at line 241
void
exportImage(string $name, array|null $platformVariants = null, ImageLayerCompression|null $forcedCompression = null, ImageMediaTypes|null $mediaTypes = null)
Exports the container as an image to the host's container image store.
at line 266
array
exposedPorts()
Retrieves the list of exposed ports.
This includes ports already exposed by the image, even if not explicitly added with dagger.
at line 277
File
file(string $path, bool|null $expand = false)
Retrieves a file at the given path.
Mounts are included.
at line 290
Container
from(string $address)
Download a container image, and apply it to the container state. All previous state will be lost.
at line 300
AbstractId
id()
A unique identifier for this Container.
at line 309
string
imageRef()
The unique image reference which can only be retrieved immediately after the 'Container.From' call.
at line 318
Container
import(File $source, string|null $tag = '')
Reads the container from an OCI tarball.
at line 331
string
label(string $name)
Retrieves the value of the specified label.
at line 341
array
labels()
Retrieves the list of labels passed to container.
at line 350
array
mounts()
Retrieves the list of paths where a directory is mounted.
at line 359
Platform
platform()
The platform this container executes and publishes as.
at line 370
string
publish(string $address, array|null $platformVariants = null, ImageLayerCompression|null $forcedCompression = null, ImageMediaTypes|null $mediaTypes = null)
Package the container state as an OCI image, and publish it to a registry
Returns the fully qualified address of the published image, with digest
at line 393
Directory
rootfs()
Return a snapshot of the container's root filesystem. The snapshot can be modified then written back using withRootfs. Use that method for filesystem modifications.
at line 404
string
stderr()
The buffered standard error stream of the last executed command
Returns an error if no command was executed
at line 415
string
stdout()
The buffered standard output stream of the last executed command
Returns an error if no command was executed
at line 426
ContainerId
sync()
Forces evaluation of the pipeline in the engine.
It doesn't run the default command if no exec has been set.
at line 435
Container
terminal(array|null $cmd = null, bool|null $experimentalPrivilegedNesting = false, bool|null $insecureRootCapabilities = false)
Opens an interactive terminal for this container using its configured default terminal command if not overridden by args (or sh as a fallback default).
at line 458
void
up(bool|null $random = false, array|null $ports = null, array|null $args = null, bool|null $useEntrypoint = false, bool|null $experimentalPrivilegedNesting = false, bool|null $insecureRootCapabilities = false, bool|null $expand = false, bool|null $noInit = false)
Starts a Service and creates a tunnel that forwards traffic from the caller's network to that service.
Be sure to set any exposed ports before calling this api.
at line 499
string
user()
Retrieves the user to be set for all commands.
at line 508
Container
withAnnotation(string $name, string $value)
Retrieves this container plus the given OCI anotation.
at line 519
Container
withDefaultArgs(array $args)
Configures default arguments for future commands. Like CMD in Dockerfile.
at line 529
Container
withDefaultTerminalCmd(array $args, bool|null $experimentalPrivilegedNesting = false, bool|null $insecureRootCapabilities = false)
Set the default command to invoke for the container's terminal API.
at line 548
Container
withDirectory(string $path, Directory $directory, array|null $exclude = null, array|null $include = null, string|null $owner = '', bool|null $expand = false)
Return a new container snapshot, with a directory added to its filesystem
at line 577
Container
withEntrypoint(array $args, bool|null $keepDefaultArgs = false)
Set an OCI-style entrypoint. It will be included in the container's OCI configuration. Note, withExec ignores the entrypoint by default.
at line 590
Container
withEnvVariable(string $name, string $value, bool|null $expand = false)
Set a new environment variable in the container.
at line 604
Container
withExec(array $args, bool|null $useEntrypoint = false, string|null $stdin = '', string|null $redirectStdin = '', string|null $redirectStdout = '', string|null $redirectStderr = '', ReturnType|null $expect = null, bool|null $experimentalPrivilegedNesting = false, bool|null $insecureRootCapabilities = false, bool|null $expand = false, bool|null $noInit = false)
Execute a command in the container, and return a new snapshot of the container state after execution.
at line 661
Container
withExposedPort(int $port, NetworkProtocol|null $protocol = null, string|null $description = null, bool|null $experimentalSkipHealthcheck = false)
Expose a network port. Like EXPOSE in Dockerfile (but with healthcheck support)
Exposed ports serve two purposes:
-
For health checks and introspection, when running services
-
For setting the EXPOSE OCI field when publishing the container
at line 684
Container
withFile(string $path, File $source, int|null $permissions = null, string|null $owner = '', bool|null $expand = false)
Return a container snapshot with a file added
at line 709
Container
withFiles(string $path, array $sources, int|null $permissions = null, string|null $owner = '', bool|null $expand = false)
Retrieves this container plus the contents of the given files copied to the given path.
at line 734
Container
withLabel(string $name, string $value)
Retrieves this container plus the given label.
at line 745
Container
withMountedCache(string $path, CacheVolume $cache, Directory|null $source = null, CacheSharingMode|null $sharing = null, string|null $owner = '', bool|null $expand = false)
Retrieves this container plus a cache volume mounted at the given path.
at line 774
Container
withMountedDirectory(string $path, Directory $source, string|null $owner = '', bool|null $expand = false)
Retrieves this container plus a directory mounted at the given path.
at line 795
Container
withMountedFile(string $path, File $source, string|null $owner = '', bool|null $expand = false)
Retrieves this container plus a file mounted at the given path.
at line 816
Container
withMountedSecret(string $path, Secret $source, string|null $owner = '', int|null $mode = 256, bool|null $expand = false)
Retrieves this container plus a secret mounted into a file at the given path.
at line 841
Container
withMountedTemp(string $path, int|null $size = null, bool|null $expand = false)
Retrieves this container plus a temporary directory mounted at the given path. Any writes will be ephemeral to a single withExec call; they will not be persisted to subsequent withExecs.
at line 857
Container
withNewFile(string $path, string $contents, int|null $permissions = 420, string|null $owner = '', bool|null $expand = false)
Return a new container snapshot, with a file added to its filesystem with text content
at line 882
Container
withRegistryAuth(string $address, string $username, Secret $secret)
Attach credentials for future publishing to a registry. Use in combination with publish
at line 894
Container
withRootfs(Directory $directory)
Change the container's root filesystem. The previous root filesystem will be lost.
at line 904
Container
withSecretVariable(string $name, Secret $secret)
Set a new environment variable, using a secret value
at line 921
Container
withServiceBinding(string $alias, Service $service)
Establish a runtime dependency from a container to a network service.
The service will be started automatically when needed and detached when it is no longer needed, executing the default command if none is set.
The service will be reachable from the container via the provided hostname alias.
The service dependency will also convey to any files or directories produced by the container.
at line 932
Container
withSymlink(string $target, string $linkName, bool|null $expand = false)
Return a snapshot with a symlink
at line 946
Container
withUnixSocket(string $path, Socket $source, string|null $owner = '', bool|null $expand = false)
Retrieves this container plus a socket forwarded to the given Unix socket path.
at line 967
Container
withUser(string $name)
Retrieves this container with a different command user.
at line 977
Container
withWorkdir(string $path, bool|null $expand = false)
Change the container's working directory. Like WORKDIR in Dockerfile.
at line 990
Container
withoutAnnotation(string $name)
Retrieves this container minus the given OCI annotation.
at line 1000
Container
withoutDefaultArgs()
Remove the container's default arguments.
at line 1009
Container
withoutDirectory(string $path, bool|null $expand = false)
Return a new container snapshot, with a directory removed from its filesystem
at line 1022
Container
withoutEntrypoint(bool|null $keepDefaultArgs = false)
Reset the container's OCI entrypoint.
at line 1034
Container
withoutEnvVariable(string $name)
Retrieves this container minus the given environment variable.
at line 1044
Container
withoutExposedPort(int $port, NetworkProtocol|null $protocol = null)
Unexpose a previously exposed port.
at line 1057
Container
withoutFile(string $path, bool|null $expand = false)
Retrieves this container with the file at the given path removed.
at line 1070
Container
withoutFiles(array $paths, bool|null $expand = false)
Return a new container spanshot with specified files removed
at line 1083
Container
withoutLabel(string $name)
Retrieves this container minus the given environment label.
at line 1093
Container
withoutMount(string $path, bool|null $expand = false)
Retrieves this container after unmounting everything at the given path.
at line 1106
Container
withoutRegistryAuth(string $address)
Retrieves this container without the registry authentication of a given address.
at line 1116
Container
withoutSecretVariable(string $name)
Retrieves this container minus the given environment variable containing the secret.
at line 1126
Container
withoutUnixSocket(string $path, bool|null $expand = false)
Retrieves this container with a previously added Unix socket removed.
at line 1141
Container
withoutUser()
Retrieves this container with an unset command user.
Should default to root.
at line 1152
Container
withoutWorkdir()
Unset the container's working directory.
Should default to "/".
at line 1161
string
workdir()
Retrieves the working directory for all commands.