docker
Installation
Entrypoint
Types
Docker

docker

Dagger module

Installation

dagger install github.com/opopops/docker@7ae3c37d3ee93cb2f735ba3b84f23be49e01b3d6

Entrypoint

Return Type

Docker !

Arguments

Name	Type	Description
containers	[Container ! ] !	Container to use.
digest	String !	No description provided

Example

func (m *myModule) example(containers []*Container, digest string) *Docker  {
	return dag.
			Docker(containers, digest)
}

@function
def example(containers: List[dagger.Container], digest: str) -> dag.Docker:
	return (
		dag.docker(containers, digest)
	)

@func()
example(containers: Container[], digest: string): Docker {
	return dag
		.docker(containers, digest)
}

Types

Docker 🔗

Docker module

container() 🔗

Container to use.

Return Type

[Container ! ] !

Example

func (m *myModule) example(containers []*Container, digest string) []*Container  {
	return dag.
			Docker(containers, digest).
			Container()
}

@function
def example(containers: List[dagger.Container], digest: str) -> List[dagger.Container]:
	return (
		dag.docker(containers, digest)
		.container()
	)

@func()
example(containers: Container[], digest: string): Container[] {
	return dag
		.docker(containers, digest)
		.container()
}

import() 🔗

Return a container from registry

Return Type

Container !

Arguments

Name	Type	Default Value	Description
address	String !	-	Image's address from its registry.

Example

func (m *myModule) example(containers []*Container, digest string, address string) *Container  {
	return dag.
			Docker(containers, digest).
			Import(address)
}

@function
def example(containers: List[dagger.Container], digest: str, address: str) -> dagger.Container:
	return (
		dag.docker(containers, digest)
		.import_(address)
	)

@func()
example(containers: Container[], digest: string, address: string): Container {
	return dag
		.docker(containers, digest)
		.import(address)
}

apkoBuild() 🔗

Return Type

Docker !

Arguments

Name	Type	Default Value	Description
context	Directory !	-	Directory context used by apko.
config	String !	"apko.yaml"	apko config file.
arch	String	null	No description provided

Example

func (m *myModule) example(containers []*Container, digest string, context *Directory, config string) *Docker  {
	return dag.
			Docker(containers, digest).
			ApkoBuild(context, config)
}

@function
def example(containers: List[dagger.Container], digest: str, context: dagger.Directory, config: str) -> dag.Docker:
	return (
		dag.docker(containers, digest)
		.apko_build(context, config)
	)

@func()
example(containers: Container[], digest: string, context: Directory, config: string): Docker {
	return dag
		.docker(containers, digest)
		.apkoBuild(context, config)
}

build() 🔗

Build multi-platform image

Return Type

Docker !

Arguments

Name	Type	Default Value	Description
context	Directory !	-	Directory context used by the Dockerfile.
dockerfile	String !	"Dockerfile"	Path to the Dockerfile to use.
platform	String	null	No description provided
target	String !	""	Target build stage to build.

Example

func (m *myModule) example(containers []*Container, digest string, context *Directory, dockerfile string, target string) *Docker  {
	return dag.
			Docker(containers, digest).
			Build(context, dockerfile, target)
}

@function
def example(containers: List[dagger.Container], digest: str, context: dagger.Directory, dockerfile: str, target: str) -> dag.Docker:
	return (
		dag.docker(containers, digest)
		.build(context, dockerfile, target)
	)

@func()
example(containers: Container[], digest: string, context: Directory, dockerfile: string, target: string): Docker {
	return dag
		.docker(containers, digest)
		.build(context, dockerfile, target)
}

scanReport() 🔗

Return Grype scan report

Return Type

String !

Arguments

Name	Type	Default Value	Description
container	Container	null	No description provided
failOn	String	null	No description provided
outputFormat	String	"table"	No description provided

Example

func (m *myModule) example(ctx context.Context, containers []*Container, digest string) string  {
	return dag.
			Docker(containers, digest).
			ScanReport(ctx)
}

@function
async def example(containers: List[dagger.Container], digest: str) -> str:
	return await (
		dag.docker(containers, digest)
		.scan_report()
	)

@func()
async example(containers: Container[], digest: string): Promise<string> {
	return dag
		.docker(containers, digest)
		.scanReport()
}

scan() 🔗

Scan container using Grype

Return Type

Docker !

Arguments

Name	Type	Default Value	Description
container	Container	null	No description provided
failOn	String	"critical"	No description provided

Example

func (m *myModule) example(containers []*Container, digest string) *Docker  {
	return dag.
			Docker(containers, digest).
			Scan()
}

@function
def example(containers: List[dagger.Container], digest: str) -> dag.Docker:
	return (
		dag.docker(containers, digest)
		.scan()
	)

@func()
example(containers: Container[], digest: string): Docker {
	return dag
		.docker(containers, digest)
		.scan()
}

export() 🔗

Export container

Return Type

File !

Arguments

Name	Type	Default Value	Description
platformVariants	[Container ! ]	null	No description provided
compress	Boolean	false	No description provided

Example

func (m *myModule) example(containers []*Container, digest string) *File  {
	return dag.
			Docker(containers, digest).
			Export()
}

@function
def example(containers: List[dagger.Container], digest: str) -> dagger.File:
	return (
		dag.docker(containers, digest)
		.export()
	)

@func()
example(containers: Container[], digest: string): File {
	return dag
		.docker(containers, digest)
		.export()
}

publish() 🔗

Publish container

Return Type

String !

Arguments

Name	Type	Default Value	Description
address	String !	-	No description provided
platformVariants	[Container ! ]	null	No description provided
username	String	null	No description provided
password	Secret	null	No description provided

Example

func (m *myModule) example(ctx context.Context, containers []*Container, digest string, address string) string  {
	return dag.
			Docker(containers, digest).
			Publish(ctx, address)
}

@function
async def example(containers: List[dagger.Container], digest: str, address: str) -> str:
	return await (
		dag.docker(containers, digest)
		.publish(address)
	)

@func()
async example(containers: Container[], digest: string, address: string): Promise<string> {
	return dag
		.docker(containers, digest)
		.publish(address)
}

sign() 🔗

Sign Docker image

Return Type

String !

Arguments

Name	Type	Default Value	Description
privateKey	Secret !	-	A reference to a secret value, which can be handled more safely than the value itself.
password	Secret !	-	A reference to a secret value, which can be handled more safely than the value itself.
digest	String	null	No description provided
registryUsername	String	null	No description provided
registryPassword	Secret	null	No description provided
dockerConfig	File	null	No description provided

Example

func (m *myModule) example(ctx context.Context, containers []*Container, digest string, privateKey *Secret, password *Secret) string  {
	return dag.
			Docker(containers, digest).
			Sign(ctx, privateKey, password)
}

@function
async def example(containers: List[dagger.Container], digest: str, private_key: dagger.Secret, password: dagger.Secret) -> str:
	return await (
		dag.docker(containers, digest)
		.sign(private_key, password)
	)

@func()
async example(containers: Container[], digest: string, privateKey: Secret, password: Secret): Promise<string> {
	return dag
		.docker(containers, digest)
		.sign(privateKey, password)
}

releaseApko() 🔗

Release APKO image

Return Type

String !

Arguments

Name	Type	Default Value	Description
context	Directory !	-	A directory.
address	String !	-	No description provided
config	String !	"apko.yaml"	No description provided
username	String	null	No description provided
password	Secret	null	No description provided
dockerConfig	File	null	No description provided
arch	String	null	No description provided
scan	Boolean	false	No description provided
scanFailOn	String	"critical"	No description provided
sign	Boolean	false	No description provided
cosignPassword	Secret	null	No description provided
cosignPrivateKey	Secret	null	No description provided

Example

func (m *myModule) example(ctx context.Context, containers []*Container, digest string, context *Directory, address string, config string) string  {
	return dag.
			Docker(containers, digest).
			ReleaseApko(ctx, context, address, config)
}

@function
async def example(containers: List[dagger.Container], digest: str, context: dagger.Directory, address: str, config: str) -> str:
	return await (
		dag.docker(containers, digest)
		.release_apko(context, address, config)
	)

@func()
async example(containers: Container[], digest: string, context: Directory, address: string, config: string): Promise<string> {
	return dag
		.docker(containers, digest)
		.releaseApko(context, address, config)
}

release() 🔗

Release Docker image

Return Type

String !

Arguments

Name	Type	Default Value	Description
context	Directory !	-	A directory.
address	String !	-	No description provided
dockerfile	String !	"Dockerfile"	No description provided
username	String	null	No description provided
password	Secret	null	No description provided
dockerConfig	File	null	No description provided
platform	String	null	No description provided
scan	Boolean	false	No description provided
scanFailOn	String	"critical"	No description provided
sign	Boolean	false	No description provided
cosignPassword	Secret	null	No description provided
cosignPrivateKey	Secret	null	No description provided

Example

func (m *myModule) example(ctx context.Context, containers []*Container, digest string, context *Directory, address string, dockerfile string) string  {
	return dag.
			Docker(containers, digest).
			Release(ctx, context, address, dockerfile)
}

@function
async def example(containers: List[dagger.Container], digest: str, context: dagger.Directory, address: str, dockerfile: str) -> str:
	return await (
		dag.docker(containers, digest)
		.release(context, address, dockerfile)
	)

@func()
async example(containers: Container[], digest: string, context: Directory, address: string, dockerfile: string): Promise<string> {
	return dag
		.docker(containers, digest)
		.release(context, address, dockerfile)
}