docker

Docker 🔗

Docker module for building and publishing container images. This class provides methods to build container images from Dockerfiles and push them to various container registries with proper authentication and validation. Attributes: None - This module is stateless and thread-safe. Example: # Build an image docker = Docker() container = docker.build(context=src_dir) # Build and push to Docker Hub result = await docker.push( context=src_dir, image_name="myuser/myapp", username="myuser", password=token, tags=["latest", "v1.0.0"] )

buildAndPush() 🔗

Build and push a container image to a registry.

This is the main function for building and publishing images to any registry. Orchestrate multiple registries in your CI/CD (GitHub Actions, GitLab CI, etc.).

Args: context: Directory containing the Dockerfile and build context. image_name: Name of the image (e.g., “myorg/myapp” or “org/app” for GHCR). username: Registry username for authentication. password: Registry password/token secret for authentication. registry: Registry URL (default: “docker.io”). Examples: - “docker.io” (Docker Hub) - “ghcr.io” (GitHub Container Registry) - “registry.gitlab.com” (GitLab) - “gcr.io” (Google Container Registry) tags: List of tags to apply (default: [“latest”]). dockerfile: Path to the Dockerfile relative to context (default: “Dockerfile”).

Returns: Published image references with digests (one per line).

Raises: ValueError: If validation fails for any parameter. RuntimeError: If push operation fails.

Example: # Docker Hub with multiple tags result = await docker.push( context=src_dir, image_name=“user/app”, username=“user”, password=dockerhub_token, registry=“docker.io”, tags=[“latest”, “v1.0.0”, “stable”] )

# GHCR with custom Dockerfile
result = await docker.push(
    context=src_dir,
    image_name="org/app",
    username="github_user",
    password=github_token,
    registry="ghcr.io",
    dockerfile="Dockerfile.production",
    tags=["latest"]
)

Note: For multi-stage builds, build arguments, and platform specifications, configure these directly in your Dockerfile using standard Docker syntax.

Return Type

String !

Arguments

dagger -m github.com/broadsage/dagger-modules/modules/docker@0d23f76b089363c2bf5de43862ebfe71a69789e3 call \
 build-and-push --context DIR_PATH --image-name string --username string --password env:MYSECRET --registry string --dockerfile stringcontent_copy Copied! 

func (m *MyModule) Example(ctx context.Context, context *dagger.Directory, imageName string, username string, password *dagger.Secret, registry string, dockerfile string) string  {
	return dag.
			Docker().
			BuildAndPush(ctx, context, imageName, username, password, registry, dockerfile)
}content_copy Copied!

@function
async def example(context: dagger.Directory, image_name: str, username: str, password: dagger.Secret, registry: str, dockerfile: str) -> str:
	return await (
		dag.docker()
		.build_and_push(context, image_name, username, password, registry, dockerfile)
	)content_copy Copied!

@func()
async example(context: Directory, imageName: string, username: string, password: Secret, registry: string, dockerfile: string): Promise<string> {
	return dag
		.docker()
		.buildAndPush(context, imageName, username, password, registry, dockerfile)
}content_copy Copied!