Container

No description

No description

Turn the container into a Service.

Be sure to set any exposed ports before this conversion.

Package the container state as an OCI image, and return it as a tar archive

The combined buffered standard output and standard error stream of the last executed command

Returns an error if no command was executed

Return the container's default arguments.

Retrieve a directory from the container's root filesystem

Mounts are included.

Retrieves this container's configured docker healthcheck.

Return the container's OCI entrypoint.

Retrieves the value of the specified persistent environment variable.

Retrieves the list of persistent environment variables configured on the container.

check if a file or directory exists

The exit code of the last executed command

Returns an error if no command was executed

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.

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.

Writes the container as an OCI tarball to the destination file path on the host.

It can also export platform variants.

Exports the container as an image to the host's container image store.

Retrieves the list of exposed ports.

This includes ports already exposed by the image, even if not explicitly added with dagger.

Retrieves a file at the given path.

Mounts are included.

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.

Reads the container from an OCI tarball.

Retrieves the value of the specified label.

Retrieves the list of labels passed to container.

Returns the image layer or configuration blob with the given digest as a File.

Computes and returns the manifest for this container as a File.

Retrieves the list of paths where a directory is mounted.

The platform this container executes and publishes as.

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

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.

Return file status

The buffered standard error stream of the last executed command

Returns an error if no command was executed

The buffered standard output stream of the last executed command

Returns an error if no command was executed

Forces evaluation of the pipeline in the engine.

It doesn't run the default command if no exec has been set.

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.

Be sure to set any exposed ports before calling this api.

Retrieves the user to be set for all commands.

Retrieves this container plus the given OCI annotation.

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

Retrieves this container with the specificed docker healtcheck command set.

Set an OCI-style entrypoint. It will be included in the container's OCI configuration. Note, withExec ignores the entrypoint by default.

Export environment variables from an env-file to the container.

Set a new environment variable in the container.

Raise an error.

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)

Exposed ports serve two purposes:

• For health checks and introspection, when running services

• For setting the EXPOSE OCI field when publishing the container

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 the given label.

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.

Retrieves this container plus a volume mounted at the given path.

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.

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.

Return a snapshot with a symlink

Retrieves this container plus a socket forwarded to the given Unix socket path.

Retrieves this container with a different command user.

Set a new non-secret environment variable for future execs without invalidating exec cache when only its value changes.

This is an expert-only escape hatch. If a volatile value affects observable exec results, stale cached results may be reused.

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

Retrieves this container without a configured docker healtcheck command.

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.

Should default to root.

Retrieves this container minus the given volatile environment variable.

Unset the container's working directory.

Should default to "/".

Retrieves the working directory for all commands.