Dagger.Host (dagger v0.19.4)

Information about the host environment.

Summary

Types

t()

Functions

container_image(host, name)

Accesses a container image on the host.

directory(host, path, optional_args \\ [])

Accesses a directory on the host.

file(host, path, optional_args \\ [])

Accesses a file on the host.

find_up(host, name, optional_args \\ [])

Search for a file or directory by walking up the tree from system workdir. Return its relative path. If no match, return null

id(host)

A unique identifier for this Host.

service(host, ports, optional_args \\ [])

Creates a service that forwards traffic to a specified address via the host.

tunnel(host, service, optional_args \\ [])

Creates a tunnel that forwards traffic from the host to a service.

unix_socket(host, path)

Accesses a Unix socket on the host.

Types

t()

@type t() :: %Dagger.Host{client: term(), query_builder: term()}

Functions

container_image(host, name)

@spec container_image(t(), String.t()) :: Dagger.Container.t()

Accesses a container image on the host.

directory(host, path, optional_args \\ [])

@spec directory(t(), String.t(),
  exclude: [String.t()],
  include: [String.t()],
  no_cache: boolean() | nil,
  gitignore: boolean() | nil
) :: Dagger.Directory.t()

Accesses a directory on the host.

file(host, path, optional_args \\ [])

@spec file(t(), String.t(), [{:no_cache, boolean() | nil}]) :: Dagger.File.t()

Accesses a file on the host.

find_up(host, name, optional_args \\ [])

@spec find_up(t(), String.t(), [{:no_cache, boolean() | nil}]) ::
  {:ok, String.t() | nil} | {:error, term()}

Search for a file or directory by walking up the tree from system workdir. Return its relative path. If no match, return null

id(host)

@spec id(t()) :: {:ok, Dagger.HostID.t()} | {:error, term()}

A unique identifier for this Host.

service(host, ports, optional_args \\ [])

@spec service(t(), [Dagger.PortForward.t()], [{:host, String.t() | nil}]) ::
  Dagger.Service.t()

Creates a service that forwards traffic to a specified address via the host.

tunnel(host, service, optional_args \\ [])

@spec tunnel(t(), Dagger.Service.t(),
  native: boolean() | nil,
  ports: [Dagger.PortForward.t()]
) ::
  Dagger.Service.t()

Creates a tunnel that forwards traffic from the host to a service.

unix_socket(host, path)

@spec unix_socket(t(), String.t()) :: Dagger.Socket.t()

Accesses a Unix socket on the host.