docker

Dagger-native Docker and OCI image helpers.

Installation

dagger install github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90

Entrypoint

Return Type

Docker !

Arguments

Name	Type	Default Value	Description
registryAuths	[RegistryAuth ! ]	null	No description provided

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \

func (m *MyModule) Example() *dagger.Docker  {
	return dag.
			Docker()
}

@function
def example() -> dagger.Docker:
	return (
		dag.docker()
	)

@func()
example(): Docker {
	return dag
		.docker()
}

Types

RegistryAuth 🔗

Registry authentication configuration.

address() 🔗

Return the registry address.

Return Type

String !

Example

Function DockerRegistryAuth.address is not accessible from the docker module

Function DockerRegistryAuth.address is not accessible from the docker module

Function DockerRegistryAuth.address is not accessible from the docker module

Function DockerRegistryAuth.address is not accessible from the docker module

username() 🔗

Return the registry username.

Return Type

String !

Example

Function DockerRegistryAuth.username is not accessible from the docker module

Function DockerRegistryAuth.username is not accessible from the docker module

Function DockerRegistryAuth.username is not accessible from the docker module

Function DockerRegistryAuth.username is not accessible from the docker module

BakeTarget 🔗

Resolved Docker Buildx Bake target metadata.

buildArgs() 🔗

Return resolved build arguments.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 resolve-bake-target --bake-path string \
 build-args

func (m *MyModule) Example(ctx context.Context, bakePath string) []string  {
	return dag.
			Docker().
			ResolveBakeTarget(bakePath).
			BuildArgs(ctx)
}

@function
async def example(bake_path: str) -> List[str]:
	return await (
		dag.docker()
		.resolve_bake_target(bake_path)
		.build_args()
	)

@func()
async example(bakePath: string): Promise<string[]> {
	return dag
		.docker()
		.resolveBakeTarget(bakePath)
		.buildArgs()
}

contextPath() 🔗

Return the resolved build context path.

Return Type

String !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 resolve-bake-target --bake-path string \
 context-path

func (m *MyModule) Example(ctx context.Context, bakePath string) string  {
	return dag.
			Docker().
			ResolveBakeTarget(bakePath).
			ContextPath(ctx)
}

@function
async def example(bake_path: str) -> str:
	return await (
		dag.docker()
		.resolve_bake_target(bake_path)
		.context_path()
	)

@func()
async example(bakePath: string): Promise<string> {
	return dag
		.docker()
		.resolveBakeTarget(bakePath)
		.contextPath()
}

dockerfilePath() 🔗

Return the resolved Dockerfile path.

Return Type

String !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 resolve-bake-target --bake-path string \
 dockerfile-path

func (m *MyModule) Example(ctx context.Context, bakePath string) string  {
	return dag.
			Docker().
			ResolveBakeTarget(bakePath).
			DockerfilePath(ctx)
}

@function
async def example(bake_path: str) -> str:
	return await (
		dag.docker()
		.resolve_bake_target(bake_path)
		.dockerfile_path()
	)

@func()
async example(bakePath: string): Promise<string> {
	return dag
		.docker()
		.resolveBakeTarget(bakePath)
		.dockerfilePath()
}

imageRefs() 🔗

Return resolved OCI image references.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 resolve-bake-target --bake-path string \
 image-refs

func (m *MyModule) Example(ctx context.Context, bakePath string) []string  {
	return dag.
			Docker().
			ResolveBakeTarget(bakePath).
			ImageRefs(ctx)
}

@function
async def example(bake_path: str) -> List[str]:
	return await (
		dag.docker()
		.resolve_bake_target(bake_path)
		.image_refs()
	)

@func()
async example(bakePath: string): Promise<string[]> {
	return dag
		.docker()
		.resolveBakeTarget(bakePath)
		.imageRefs()
}

labels() 🔗

Return resolved image labels in KEY=VALUE form.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 resolve-bake-target --bake-path string \
 labels

func (m *MyModule) Example(ctx context.Context, bakePath string) []string  {
	return dag.
			Docker().
			ResolveBakeTarget(bakePath).
			Labels(ctx)
}

@function
async def example(bake_path: str) -> List[str]:
	return await (
		dag.docker()
		.resolve_bake_target(bake_path)
		.labels()
	)

@func()
async example(bakePath: string): Promise<string[]> {
	return dag
		.docker()
		.resolveBakeTarget(bakePath)
		.labels()
}

platforms() 🔗

Return resolved target platforms.

Return Type

[Scalar ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 resolve-bake-target --bake-path string \
 platforms

func (m *MyModule) Example(bakePath string) []  {
	return dag.
			Docker().
			ResolveBakeTarget(bakePath).
			Platforms()
}

@function
def example(bake_path: str) -> List[]:
	return (
		dag.docker()
		.resolve_bake_target(bake_path)
		.platforms()
	)

@func()
example(bakePath: string): [] {
	return dag
		.docker()
		.resolveBakeTarget(bakePath)
		.platforms()
}

tags() 🔗

Return resolved image tags.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 resolve-bake-target --bake-path string \
 tags

func (m *MyModule) Example(ctx context.Context, bakePath string) []string  {
	return dag.
			Docker().
			ResolveBakeTarget(bakePath).
			Tags(ctx)
}

@function
async def example(bake_path: str) -> List[str]:
	return await (
		dag.docker()
		.resolve_bake_target(bake_path)
		.tags()
	)

@func()
async example(bakePath: string): Promise<string[]> {
	return dag
		.docker()
		.resolveBakeTarget(bakePath)
		.tags()
}

target() 🔗

Return the resolved Dockerfile target, if configured.

Return Type

String !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 resolve-bake-target --bake-path string \
 target

func (m *MyModule) Example(ctx context.Context, bakePath string) string  {
	return dag.
			Docker().
			ResolveBakeTarget(bakePath).
			Target(ctx)
}

@function
async def example(bake_path: str) -> str:
	return await (
		dag.docker()
		.resolve_bake_target(bake_path)
		.target()
	)

@func()
async example(bakePath: string): Promise<string> {
	return dag
		.docker()
		.resolveBakeTarget(bakePath)
		.target()
}

Build 🔗

Container image build result.

buildArgs() 🔗

Return configured build arguments.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 build-args

func (m *MyModule) Example(ctx context.Context, bakePath string) []string  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			BuildArgs(ctx)
}

@function
async def example(bake_path: str) -> List[str]:
	return await (
		dag.docker()
		.build_from_bake(bake_path)
		.build_args()
	)

@func()
async example(bakePath: string): Promise<string[]> {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.buildArgs()
}

container() 🔗

Return the built container.

Return Type

Container !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 container

func (m *MyModule) Example(bakePath string) *dagger.Container  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			Container()
}

@function
def example(bake_path: str) -> dagger.Container:
	return (
		dag.docker()
		.build_from_bake(bake_path)
		.container()
	)

@func()
example(bakePath: string): Container {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.container()
}

contextPath() 🔗

Return the build context path.

Return Type

String !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 context-path

func (m *MyModule) Example(ctx context.Context, bakePath string) string  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			ContextPath(ctx)
}

@function
async def example(bake_path: str) -> str:
	return await (
		dag.docker()
		.build_from_bake(bake_path)
		.context_path()
	)

@func()
async example(bakePath: string): Promise<string> {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.contextPath()
}

dockerfilePath() 🔗

Return the Dockerfile path.

Return Type

String !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 dockerfile-path

func (m *MyModule) Example(ctx context.Context, bakePath string) string  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			DockerfilePath(ctx)
}

@function
async def example(bake_path: str) -> str:
	return await (
		dag.docker()
		.build_from_bake(bake_path)
		.dockerfile_path()
	)

@func()
async example(bakePath: string): Promise<string> {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.dockerfilePath()
}

imageRefs() 🔗

Return the full OCI image references.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 image-refs

func (m *MyModule) Example(ctx context.Context, bakePath string) []string  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			ImageRefs(ctx)
}

@function
async def example(bake_path: str) -> List[str]:
	return await (
		dag.docker()
		.build_from_bake(bake_path)
		.image_refs()
	)

@func()
async example(bakePath: string): Promise<string[]> {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.imageRefs()
}

labels() 🔗

Return the configured image labels in KEY=VALUE form.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 labels

func (m *MyModule) Example(ctx context.Context, bakePath string) []string  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			Labels(ctx)
}

@function
async def example(bake_path: str) -> List[str]:
	return await (
		dag.docker()
		.build_from_bake(bake_path)
		.labels()
	)

@func()
async example(bakePath: string): Promise<string[]> {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.labels()
}

platformVariants() 🔗

Return platform-specific container variants.

Return Type

[Container ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 platform-variants

func (m *MyModule) Example(bakePath string) []*dagger.Container  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			PlatformVariants()
}

@function
def example(bake_path: str) -> List[dagger.Container]:
	return (
		dag.docker()
		.build_from_bake(bake_path)
		.platform_variants()
	)

@func()
example(bakePath: string): Container[] {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.platformVariants()
}

platforms() 🔗

Return configured target platforms.

Return Type

[Scalar ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 platforms

func (m *MyModule) Example(bakePath string) []  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			Platforms()
}

@function
def example(bake_path: str) -> List[]:
	return (
		dag.docker()
		.build_from_bake(bake_path)
		.platforms()
	)

@func()
example(bakePath: string): [] {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.platforms()
}

publish() 🔗

Publish the built image to explicit or build-configured OCI image references.

Return Type

Image !

Arguments

Name	Type	Default Value	Description
imageRefs	[String ! ]	null	Optional OCI image references to publish

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 publish

func (m *MyModule) Example(bakePath string) *dagger.DockerImage  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			Publish()
}

@function
def example(bake_path: str) -> dagger.DockerImage:
	return (
		dag.docker()
		.build_from_bake(bake_path)
		.publish()
	)

@func()
example(bakePath: string): DockerImage {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.publish()
}

tags() 🔗

Return the configured image tags.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 tags

func (m *MyModule) Example(ctx context.Context, bakePath string) []string  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			Tags(ctx)
}

@function
async def example(bake_path: str) -> List[str]:
	return await (
		dag.docker()
		.build_from_bake(bake_path)
		.tags()
	)

@func()
async example(bakePath: string): Promise<string[]> {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.tags()
}

target() 🔗

Return the build target, if configured.

Return Type

String !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 target

func (m *MyModule) Example(ctx context.Context, bakePath string) string  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			Target(ctx)
}

@function
async def example(bake_path: str) -> str:
	return await (
		dag.docker()
		.build_from_bake(bake_path)
		.target()
	)

@func()
async example(bakePath: string): Promise<string> {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.target()
}

withPublishDryRun() 🔗

Return a build that validates publish inputs without pushing.

Return Type

Build !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 with-publish-dry-run

func (m *MyModule) Example(bakePath string) *dagger.DockerBuild  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			WithPublishDryRun()
}

@function
def example(bake_path: str) -> dagger.DockerBuild:
	return (
		dag.docker()
		.build_from_bake(bake_path)
		.with_publish_dry_run()
	)

@func()
example(bakePath: string): DockerBuild {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.withPublishDryRun()
}

withSmokeCheck() 🔗

Run a smoke command in the built container.

Return Type

Build !

Arguments

Name	Type	Default Value	Description
command	[String ! ] !	-	Command to run in the built container

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string \
 with-smoke-check --command string1 --command string2

func (m *MyModule) Example(bakePath string, command []string) *dagger.DockerBuild  {
	return dag.
			Docker().
			BuildFromBake(bakePath).
			WithSmokeCheck(command)
}

@function
def example(bake_path: str, command: List[str]) -> dagger.DockerBuild:
	return (
		dag.docker()
		.build_from_bake(bake_path)
		.with_smoke_check(command)
	)

@func()
example(bakePath: string, command: string[]): DockerBuild {
	return dag
		.docker()
		.buildFromBake(bakePath)
		.withSmokeCheck(command)
}

Image 🔗

Published image result.

imageRef() 🔗

Return the published image reference.

Return Type

String !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 image --image-ref string \
 image-ref

func (m *MyModule) Example(ctx context.Context, imageRef string) string  {
	return dag.
			Docker().
			Image(imageRef).
			ImageRef(ctx)
}

@function
async def example(image_ref: str) -> str:
	return await (
		dag.docker()
		.image(image_ref)
		.image_ref()
	)

@func()
async example(imageRef: string): Promise<string> {
	return dag
		.docker()
		.image(imageRef)
		.imageRef()
}

imageRefs() 🔗

Return all published image references.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 image --image-ref string \
 image-refs

func (m *MyModule) Example(ctx context.Context, imageRef string) []string  {
	return dag.
			Docker().
			Image(imageRef).
			ImageRefs(ctx)
}

@function
async def example(image_ref: str) -> List[str]:
	return await (
		dag.docker()
		.image(image_ref)
		.image_refs()
	)

@func()
async example(imageRef: string): Promise<string[]> {
	return dag
		.docker()
		.image(imageRef)
		.imageRefs()
}

Docker 🔗

Docker module entrypoint.

build() 🔗

Build a container image from a Dockerfile context.

Return Type

Build !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Source directory containing the Docker build context
contextPath	String !	"."	Build context path relative to source
dockerfilePath	String !	"Dockerfile"	Dockerfile path relative to context
target	String	null	Optional Docker build target
buildArgs	[String ! ]	null	Optional build arguments in KEY=VALUE form
platforms	[Scalar ! ]	null	Optional target platforms
tags	[String ! ]	null	Optional image tags
labels	[String ! ]	null	Optional image labels in KEY=VALUE form

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build --context-path string --dockerfile-path string

func (m *MyModule) Example(contextPath string, dockerfilePath string) *dagger.DockerBuild  {
	return dag.
			Docker().
			Build(contextPath, dockerfilePath)
}

@function
def example(context_path: str, dockerfile_path: str) -> dagger.DockerBuild:
	return (
		dag.docker()
		.build(context_path, dockerfile_path)
	)

@func()
example(contextPath: string, dockerfilePath: string): DockerBuild {
	return dag
		.docker()
		.build(contextPath, dockerfilePath)
}

buildFromBake() 🔗

Build a container image from a Docker Buildx Bake target.

Return Type

Build !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Source directory containing the Docker build context and Bake file
target	String	null	Optional Bake target to build; omit when the manifest contains exactly one target
bakePath	String !	"docker-bake.json"	Path to the Bake file relative to source
variableOverrides	[String ! ]	null	Optional Bake variable overrides in KEY=VALUE form

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 build-from-bake --bake-path string

func (m *MyModule) Example(bakePath string) *dagger.DockerBuild  {
	return dag.
			Docker().
			BuildFromBake(bakePath)
}

@function
def example(bake_path: str) -> dagger.DockerBuild:
	return (
		dag.docker()
		.build_from_bake(bake_path)
	)

@func()
example(bakePath: string): DockerBuild {
	return dag
		.docker()
		.buildFromBake(bakePath)
}

image() 🔗

Create a Docker image result.

Return Type

Image !

Arguments

Name	Type	Default Value	Description
imageRef	String !	-	OCI image reference

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 image --image-ref string

func (m *MyModule) Example(imageRef string) *dagger.DockerImage  {
	return dag.
			Docker().
			Image(imageRef)
}

@function
def example(image_ref: str) -> dagger.DockerImage:
	return (
		dag.docker()
		.image(image_ref)
	)

@func()
example(imageRef: string): DockerImage {
	return dag
		.docker()
		.image(imageRef)
}

module() 🔗

Return the module name.

Return Type

String !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 module

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Docker().
			Module(ctx)
}

@function
async def example() -> str:
	return await (
		dag.docker()
		.module()
	)

@func()
async example(): Promise<string> {
	return dag
		.docker()
		.module()
}

registryAuthAddresses() 🔗

Return configured registry auth addresses.

Return Type

[String ! ] !

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 registry-auth-addresses

func (m *MyModule) Example(ctx context.Context) []string  {
	return dag.
			Docker().
			RegistryAuthAddresses(ctx)
}

@function
async def example() -> List[str]:
	return await (
		dag.docker()
		.registry_auth_addresses()
	)

@func()
async example(): Promise<string[]> {
	return dag
		.docker()
		.registryAuthAddresses()
}

resolveBakeTarget() 🔗

Resolve Docker Buildx Bake target metadata without building an image.

Return Type

BakeTarget !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Source directory containing the Docker build context and Bake file
target	String	null	Optional Bake target to resolve; omit when the manifest contains exactly one target
bakePath	String !	"docker-bake.json"	Path to the Bake file relative to source
variableOverrides	[String ! ]	null	Optional Bake variable overrides in KEY=VALUE form

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 resolve-bake-target --bake-path string

func (m *MyModule) Example(bakePath string) *dagger.DockerBakeTarget  {
	return dag.
			Docker().
			ResolveBakeTarget(bakePath)
}

@function
def example(bake_path: str) -> dagger.DockerBakeTarget:
	return (
		dag.docker()
		.resolve_bake_target(bake_path)
	)

@func()
example(bakePath: string): DockerBakeTarget {
	return dag
		.docker()
		.resolveBakeTarget(bakePath)
}

withRegistryAuth() 🔗

Configure registry authentication for later registry operations.

Return Type

Docker !

Arguments

Name	Type	Default Value	Description
address	String !	-	Registry address to authenticate against
username	String !	-	Registry username
password	Secret !	-	Registry password or token secret

Example

dagger -m github.com/riftonix/daggerverse/modules/docker@de9bac862e41ed778457742a3fbb20cc11763d90 call \
 with-registry-auth --address string --username string --password env:MYSECRET

func (m *MyModule) Example(address string, username string, password *dagger.Secret) *dagger.Docker  {
	return dag.
			Docker().
			WithRegistryAuth(address, username, password)
}

@function
def example(address: str, username: str, password: dagger.Secret) -> dagger.Docker:
	return (
		dag.docker()
		.with_registry_auth(address, username, password)
	)

@func()
example(address: string, username: string, password: Secret): Docker {
	return dag
		.docker()
		.withRegistryAuth(address, username, password)
}