HostKit.DSL (host_kit v0.1.0-beta.5)

Core HostKit DSL.

The DSL is only a builder: it evaluates .exs declarations into plain HostKit structs and does not apply changes to the host.

Summary

Functions

accept_hosts(value)

account(opts)

account(name, opts)

acme(opts)

agent(opts \\ [])

allow(opts)

argv(command, opts \\ [])

attach_listener(name, opts)

attach_logs(opts)

attach_telemetry(opts)

backend(name)

backend(name, opts)

backup_storage()

balance(policy, opts \\ [])

bash(name, script, opts \\ [])

bootstrap(list)

command(name, opts)

deny(target, opts \\ [])

directory(path, opts \\ [])

dotenv(path, opts \\ [], list)

drain(timeout)

egress(opts)

endpoint(name_or_service, name_or_opts \\ :default, opts \\ [])

env(name)

env(name, opts \\ [], list)

env_file(path, opts \\ [], list)

expose(name, opts)

file(path, opts \\ [])

firewall(opts \\ [], list)

git(name, command, opts \\ [])

git_exec(command)

health(path, opts \\ [])

host(name, opts \\ [])

host(name, opts, list)

http(url_or_opts \\ [])

http(url, opts)

https(opts \\ [])

identity_file(path)

image(value)

ingress(name, opts \\ [], list)

ini(path, opts \\ [])

ini(path, opts, list)

inside(list)

inside_monitor(type, opts \\ [])

instance(name, opts \\ [], list)

isolate(list)

isolate(profile, opts \\ [], list)

kind(value)

lifecycle(value)

listen(name_or_port, opts \\ [])

listener(name)

logs(opts)

memory_max(value)

mise(opts \\ [], list)

monitor(type, opts \\ [])

network(atom)

network_policy(opts)

observability(list)

option(key, value)

package(name, opts \\ [])

packages(names, opts \\ [])

password(value)

path(root, child \\ nil)

port(value)

prefixes(values)

preview(name, opts)

private_network(value)

project(name, opts \\ [], list)

provider(name, module, list)

providers(providers)

proxy(opts)

proxy(name, opts, list)

put_in_meta(key, value)

put_source_meta(opts, source)

ready(name, opts \\ [], list)

release(name, opts)

retry(opts)

roots(values)

route(opts, list)

run(name, command, opts \\ [])

secret(key, opts)

secret_env(name)

section(name, list)

server(listen \\ ":443", opts \\ [], list)

service(name, opts \\ [], list)

service_name()

service_user()

set(key, value)

source(name, opts)

ssh(opts)

ssh(opts, list)

state(path)

storage(name, opts)

storage_path(name)

storage_volume(name)

sudo(value)

symlink(path, opts)

systemd(unit, opts \\ [])

target(name, opts)

target_host(name)

telemetry(opts)

template(path, opts)

tenant(name, opts \\ [], list)

tls(mode, opts \\ [])

tool(name, version, opts \\ [])

unit_name(suffix \\ ".service")

user(value)

workspace(name, opts, list)

workspace_agent(opts \\ [])

writable(name)

writable_storage_paths()

yaml(path, opts)

Functions

accept_hosts(value)

(macro)

account(opts)

(macro)

account(name, opts)

(macro)

acme(opts)

(macro)

agent(opts \\ [])

(macro)

allow(opts)

(macro)

argv(command, opts \\ [])

(macro)

attach_listener(name, opts)

attach_logs(opts)

attach_telemetry(opts)

backend(name)

(macro)

backend(name, opts)

(macro)

backup_storage()

(macro)

balance(policy, opts \\ [])

(macro)

bash(name, script, opts \\ [])

(macro)

bootstrap(list)

(macro)

command(name, opts)

(macro)

deny(target, opts \\ [])

(macro)

directory(path, opts \\ [])

(macro)

dotenv(path, opts \\ [], list)

(macro)

drain(timeout)

(macro)

egress(opts)

(macro)

endpoint(name_or_service, name_or_opts \\ :default, opts \\ [])

(macro)

env(name)

(macro)

env(name, opts \\ [], list)

(macro)

env_file(path, opts \\ [], list)

(macro)

expose(name, opts)

(macro)

file(path, opts \\ [])

(macro)

firewall(opts \\ [], list)

(macro)

git(name, command, opts \\ [])

(macro)

git_exec(command)

health(path, opts \\ [])

(macro)

host(name, opts \\ [])

(macro)

host(name, opts, list)

(macro)

http(url_or_opts \\ [])

(macro)

http(url, opts)

(macro)

https(opts \\ [])

(macro)

identity_file(path)

(macro)

image(value)

(macro)

ingress(name, opts \\ [], list)

(macro)

ini(path, opts \\ [])

(macro)

ini(path, opts, list)

(macro)

inside(list)

(macro)

inside_monitor(type, opts \\ [])

(macro)

instance(name, opts \\ [], list)

(macro)

isolate(list)

(macro)

isolate(profile, opts \\ [], list)

(macro)

kind(value)

(macro)

lifecycle(value)

(macro)

listen(name_or_port, opts \\ [])

(macro)

listener(name)

(macro)

logs(opts)

(macro)

memory_max(value)

(macro)

mise(opts \\ [], list)

(macro)

monitor(type, opts \\ [])

(macro)

network(atom)

(macro)

network_policy(opts)

(macro)

observability(list)

(macro)

option(key, value)

(macro)

package(name, opts \\ [])

(macro)

packages(names, opts \\ [])

(macro)

password(value)

(macro)

path(root, child \\ nil)

(macro)

port(value)

(macro)

prefixes(values)

(macro)

preview(name, opts)

(macro)

private_network(value)

(macro)

project(name, opts \\ [], list)

(macro)

provider(name, module, list)

(macro)

providers(providers)

(macro)

proxy(opts)

(macro)

proxy(name, opts, list)

(macro)

put_in_meta(key, value)

(macro)

put_source_meta(opts, source)

ready(name, opts \\ [], list)

(macro)

release(name, opts)

(macro)

retry(opts)

(macro)

roots(values)

(macro)

route(opts, list)

(macro)

run(name, command, opts \\ [])

(macro)

secret(key, opts)

(macro)

secret_env(name)

(macro)

section(name, list)

(macro)

server(listen \\ ":443", opts \\ [], list)

(macro)

service(name, opts \\ [], list)

(macro)

service_name()

(macro)

service_user()

(macro)

set(key, value)

(macro)

source(name, opts)

(macro)

ssh(opts)

(macro)

ssh(opts, list)

(macro)

state(path)

(macro)

storage(name, opts)

(macro)

storage_path(name)

(macro)

storage_volume(name)

(macro)

sudo(value)

(macro)

symlink(path, opts)

(macro)

systemd(unit, opts \\ [])

(macro)

target(name, opts)

(macro)

target_host(name)

(macro)

telemetry(opts)

(macro)

template(path, opts)

(macro)

tenant(name, opts \\ [], list)

(macro)

tls(mode, opts \\ [])

(macro)

tool(name, version, opts \\ [])

(macro)

unit_name(suffix \\ ".service")

(macro)

user(value)

(macro)

workspace(name, opts, list)

(macro)

workspace_agent(opts \\ [])

(macro)

writable(name)

(macro)

writable_storage_paths()

(macro)

yaml(path, opts)

(macro)