Dagger
Search

docker

No long description provided.

Installation

dagger install github.com/vito/daggerverse/docker@5a53a93aaa08e2caf02c249fe045ee0ae613c85e

Entrypoint

Return Type 
Docker
Example
dagger -m github.com/vito/daggerverse/docker@5a53a93aaa08e2caf02c249fe045ee0ae613c85e 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

Docker 🔗

daemon() 🔗

Daemon returns an API for using a Docker Daemon.

Return Type 
Daemon !
Example
dagger -m github.com/vito/daggerverse/docker@5a53a93aaa08e2caf02c249fe045ee0ae613c85e call \
 daemon
func (m *MyModule) Example()   {
	return dag.
			Docker().
			Daemon()
}
@function
def example() -> :
	return (
		dag.docker()
		.daemon()
	)
@func()
example():  {
	return dag
		.docker()
		.daemon()
}

compose() 🔗

Compose returns an API for using Docker Compose.

Return Type 
Compose !
Arguments
NameTypeDefault ValueDescription
dirDirectory !-No description provided
files[StringKind ! ] -No description provided
Example
dagger -m github.com/vito/daggerverse/docker@5a53a93aaa08e2caf02c249fe045ee0ae613c85e call \
 compose
func (m *MyModule) Example(dir )   {
	return dag.
			Docker().
			Compose(dir)
}
@function
def example(dir: ) -> :
	return (
		dag.docker()
		.compose(dir)
	)
@func()
example(dir: ):  {
	return dag
		.docker()
		.compose(dir)
}

Compose 🔗

dir() 🔗

The directory to use as the context for the Compose project.

Return Type 
Directory !
Example
Function DockerCompose.Dir is not accessible from the docker module
Function DockerCompose.Dir is not accessible from the docker module
Function DockerCompose.Dir is not accessible from the docker module
Function DockerCompose.Dir is not accessible from the docker module

files() 🔗

The Compose config files to use, within the directory.

Return Type 
[StringKind ! ] !
Example
Function DockerCompose.Files is not accessible from the docker module
Function DockerCompose.Files is not accessible from the docker module
Function DockerCompose.Files is not accessible from the docker module
Function DockerCompose.Files is not accessible from the docker module

env() 🔗

Environment variables to interpolate into the Compose config files.

Return Type 
[ObjectKind ! ] !
Example
Function DockerCompose.Env is not accessible from the docker module
Function DockerCompose.Env is not accessible from the docker module
Function DockerCompose.Env is not accessible from the docker module
Function DockerCompose.Env is not accessible from the docker module

withEnv() 🔗

WithEnv sets an environment variable that may be interpolated into the Compose config files.

Return Type 
Compose !
Arguments
NameTypeDefault ValueDescription
nameStringKind !-No description provided
valStringKind !-No description provided
Example
Function DockerCompose.withEnv is not accessible from the docker module
Function DockerCompose.withEnv is not accessible from the docker module
Function DockerCompose.withEnv is not accessible from the docker module
Function DockerCompose.withEnv is not accessible from the docker module

all() 🔗

All returns a proxy service that forwards traffic to all defined services.

Return Type 
Service !
Example
Function DockerCompose.all is not accessible from the docker module
Function DockerCompose.all is not accessible from the docker module
Function DockerCompose.all is not accessible from the docker module
Function DockerCompose.all is not accessible from the docker module

Daemon 🔗

version() 🔗

The version of Docker to use.

Return Type 
StringKind !
Example
Function DockerDaemon.Version is not accessible from the docker module
Function DockerDaemon.Version is not accessible from the docker module
Function DockerDaemon.Version is not accessible from the docker module
Function DockerDaemon.Version is not accessible from the docker module

cache() 🔗

An optional cache volume to mount at /var/lib/docker.

Return Type 
CacheVolume !
Example
Function DockerDaemon.Cache is not accessible from the docker module
Function DockerDaemon.Cache is not accessible from the docker module
Function DockerDaemon.Cache is not accessible from the docker module
Function DockerDaemon.Cache is not accessible from the docker module

withVersion() 🔗

WithVersion allows you to specify a Docker version to use.

Return Type 
Daemon !
Arguments
NameTypeDefault ValueDescription
versionStringKind !-No description provided
Example
Function DockerDaemon.withVersion is not accessible from the docker module
Function DockerDaemon.withVersion is not accessible from the docker module
Function DockerDaemon.withVersion is not accessible from the docker module
Function DockerDaemon.withVersion is not accessible from the docker module

withCache() 🔗

WithCache sets a cache volume to mount at /var/lib/docker.

Return Type 
Daemon !
Arguments
NameTypeDefault ValueDescription
cacheCacheVolume !-No description provided
Example
Function DockerDaemon.withCache is not accessible from the docker module
Function DockerDaemon.withCache is not accessible from the docker module
Function DockerDaemon.withCache is not accessible from the docker module
Function DockerDaemon.withCache is not accessible from the docker module

service() 🔗

Service returns a Docker daemon service.

Return Type 
Service !
Example
Function DockerDaemon.service is not accessible from the docker module
Function DockerDaemon.service is not accessible from the docker module
Function DockerDaemon.service is not accessible from the docker module
Function DockerDaemon.service is not accessible from the docker module

Env 🔗

name() 🔗

Return Type 
StringKind !
Example
Function DockerEnv.Name is not accessible from the docker module
Function DockerEnv.Name is not accessible from the docker module
Function DockerEnv.Name is not accessible from the docker module
Function DockerEnv.Name is not accessible from the docker module

value() 🔗

Return Type 
StringKind !
Example
Function DockerEnv.Value is not accessible from the docker module
Function DockerEnv.Value is not accessible from the docker module
Function DockerEnv.Value is not accessible from the docker module
Function DockerEnv.Value is not accessible from the docker module