Arcane Agent¶

Overview¶

Arcane Agent is a lightweight, headless process that runs on a remote Docker host to allow the central Arcane Manager to manage that host’s containers, images, volumes, and networks through a single unified interface.

Manual

Image tags

Community

Deployment¶

sb install arcane-agent

Usage¶

Access Arcane Manager and register the agent as a remote environment.

Role Defaults¶

Variables can be customized using the Inventory. (1)

Example override
```
arcane_agent_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like arcane_agent_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like arcane_agent_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsDockerDocker+Global Override Options

arcane_agent_name

# Type: string
arcane_agent_name: arcane-agent

arcane_agent_role_manager_url

# Public HTTPS base URL of the Arcane manager, for example https://arcane.example.com.
# Type: string
arcane_agent_role_manager_url: ""

arcane_agent_role_token

# Create an Edge environment in the manager and copy its generated agent token here.
# Use a different token for each agent. It is passed to the container as AGENT_TOKEN.
# After regenerating the token in Arcane, update this value and reinstall the agent.
# Type: string
arcane_agent_role_token: ""

arcane_agent_role_transport

# WebSocket keeps an outbound HTTPS connection open and needs no inbound agent port,
# gRPC router or Traefik entrypoint timeout changes. Other supported values are auto,
# grpc and poll. Auto prefers gRPC with WebSocket fallback; grpc disables fallback.
# Poll opens a gRPC or WebSocket tunnel on demand. Using gRPC requires an h2c router
# and a disabled read timeout on the manager's HTTPS entrypoint.
# Type: string
arcane_agent_role_transport: websocket

Container

arcane_agent_role_docker_container

# Type: string
arcane_agent_role_docker_container: "{{ arcane_agent_name }}"

Image

arcane_agent_role_docker_image_pull

# Type: bool (true/false)
arcane_agent_role_docker_image_pull: true

arcane_agent_role_docker_image_repo

# Type: string
arcane_agent_role_docker_image_repo: "ghcr.io/getarcaneapp/agent"

arcane_agent_role_docker_image_tag

# Type: string
arcane_agent_role_docker_image_tag: "latest"

arcane_agent_role_docker_image

# Type: string
arcane_agent_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='arcane_agent') }}:{{ lookup('role_var', '_docker_image_tag', role='arcane_agent') }}"

Envs

arcane_agent_role_docker_envs_default

# Type: dict
arcane_agent_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  EDGE_AGENT: "true"
  EDGE_TRANSPORT: "{{ lookup('role_var', '_transport', role='arcane_agent') }}"
  MANAGER_API_URL: "{{ lookup('role_var', '_manager_url', role='arcane_agent') }}"
  AGENT_TOKEN: "{{ lookup('role_var', '_token', role='arcane_agent') }}"
  PROJECTS_DIRECTORY: "{{ lookup('role_var', '_paths_projects_location', role='arcane_agent') }}"

arcane_agent_role_docker_envs_custom

# Type: dict
arcane_agent_role_docker_envs_custom: {}

Volumes

arcane_agent_role_docker_volumes_global

# Type: bool (true/false)
arcane_agent_role_docker_volumes_global: false

arcane_agent_role_docker_volumes_default

# Type: list
arcane_agent_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_data_location', role='arcane_agent') }}:/app/data"
  - "{{ lookup('role_var', '_paths_projects_location', role='arcane_agent') }}:{{ lookup('role_var', '_paths_projects_location', role='arcane_agent') }}"
  - "/var/run/docker.sock:/var/run/docker.sock"

arcane_agent_role_docker_volumes_custom

# Type: list
arcane_agent_role_docker_volumes_custom: []

Cgroup namespace

arcane_agent_role_docker_cgroupns_mode

# Type: string
arcane_agent_role_docker_cgroupns_mode: host

Healthcheck

arcane_agent_role_docker_healthcheck

# Type: dict
arcane_agent_role_docker_healthcheck:
  test:
    - CMD
    - ./arcane-agent
    - health
    - --timeout
    - 2s
  interval: 10s
  timeout: 3s
  retries: 5
  start_period: 15s

Hostname

arcane_agent_role_docker_hostname

# Type: string
arcane_agent_role_docker_hostname: "{{ arcane_agent_name }}"

Networks

arcane_agent_role_docker_networks_alias

# Type: string
arcane_agent_role_docker_networks_alias: "{{ arcane_agent_name }}"

arcane_agent_role_docker_networks_default

# Type: list
arcane_agent_role_docker_networks_default: []

arcane_agent_role_docker_networks_custom

# Type: list
arcane_agent_role_docker_networks_custom: []

Restart Policy

arcane_agent_role_docker_restart_policy

# Type: string
arcane_agent_role_docker_restart_policy: unless-stopped

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

A blank value is YAML null and inherits any lower-precedence role or shared default. Explicit Ansible omit is accepted only for optional Docker settings; default-backed and required settings reject it. Use the documented typed empty value, such as "", [], or {}, when disabling a guaranteed setting.

GPU

arcane_agent_role_docker_gpu_enabled

# Set this to true to let the app use a GPU.
# Intel access also requires gpu.intel: true.
# NVIDIA access also requires nvidia_enabled: true.
# This setting does not install or enable GPU support on the server.
# Type: bool (true/false)
arcane_agent_role_docker_gpu_enabled: false

arcane_agent_role_docker_nvidia_disabled

# Set this to true to turn off automatic NVIDIA access for this app.
# It only has an effect when the app's _docker_gpu_enabled option and
# nvidia_enabled are both true.
# Automatic /dev/dri access may remain.
# Type: bool (true/false)
arcane_agent_role_docker_nvidia_disabled: false

arcane_agent_role_docker_dev_dri_disabled

# Set this to true to stop Saltbox from automatically sharing the
# server's /dev/dri video devices with this app.
# It only has an effect when the app's _docker_gpu_enabled option is true
# and either gpu.intel or nvidia_enabled is true.
# NVIDIA-specific access may remain.
# Type: bool (true/false)
arcane_agent_role_docker_dev_dri_disabled: false

Resource Limits

arcane_agent_role_docker_blkio_weight

# Type: int
arcane_agent_role_docker_blkio_weight:

arcane_agent_role_docker_cpu_period

# Type: int
arcane_agent_role_docker_cpu_period:

arcane_agent_role_docker_cpu_quota

# Type: int
arcane_agent_role_docker_cpu_quota:

arcane_agent_role_docker_cpu_shares

# Type: int
arcane_agent_role_docker_cpu_shares:

arcane_agent_role_docker_cpus

# CPU allocation accepted as a numeric string, such as 1.5
# Type: string (quoted number)
arcane_agent_role_docker_cpus:

arcane_agent_role_docker_cpuset_cpus

# Type: string
arcane_agent_role_docker_cpuset_cpus:

arcane_agent_role_docker_cpuset_mems

# Type: string
arcane_agent_role_docker_cpuset_mems:

arcane_agent_role_docker_kernel_memory

# Type: string
arcane_agent_role_docker_kernel_memory:

arcane_agent_role_docker_memory

# Type: string
arcane_agent_role_docker_memory:

arcane_agent_role_docker_memory_reservation

# Type: string
arcane_agent_role_docker_memory_reservation:

arcane_agent_role_docker_memory_swap

# Type: string
arcane_agent_role_docker_memory_swap:

arcane_agent_role_docker_memory_swappiness

# Type: int
arcane_agent_role_docker_memory_swappiness:

arcane_agent_role_docker_shm_size

# Type: string
arcane_agent_role_docker_shm_size:

Security & Devices

arcane_agent_role_docker_cap_drop

# Type: list
arcane_agent_role_docker_cap_drop:

arcane_agent_role_docker_device_cgroup_rules

# Type: list
arcane_agent_role_docker_device_cgroup_rules:

arcane_agent_role_docker_device_read_bps

# Type: list
arcane_agent_role_docker_device_read_bps:

arcane_agent_role_docker_device_read_iops

# Type: list
arcane_agent_role_docker_device_read_iops:

arcane_agent_role_docker_device_requests

# Type: list
arcane_agent_role_docker_device_requests:

arcane_agent_role_docker_device_write_bps

# Type: list
arcane_agent_role_docker_device_write_bps:

arcane_agent_role_docker_device_write_iops

# Type: list
arcane_agent_role_docker_device_write_iops:

arcane_agent_role_docker_devices

# Type: list
arcane_agent_role_docker_devices:

arcane_agent_role_docker_groups

# Type: list
arcane_agent_role_docker_groups:

arcane_agent_role_docker_privileged

# Type: bool (true/false)
arcane_agent_role_docker_privileged:

arcane_agent_role_docker_security_opts

# Type: list
arcane_agent_role_docker_security_opts:

arcane_agent_role_docker_user

# Type: string
arcane_agent_role_docker_user:

arcane_agent_role_docker_userns_mode

# Type: string
arcane_agent_role_docker_userns_mode:

Networking

arcane_agent_role_docker_dns_opts

# Type: list
arcane_agent_role_docker_dns_opts:

arcane_agent_role_docker_dns_search_domains

# Type: list
arcane_agent_role_docker_dns_search_domains:

arcane_agent_role_docker_dns_servers

# Type: list
arcane_agent_role_docker_dns_servers:

arcane_agent_role_docker_domainname

# Type: string
arcane_agent_role_docker_domainname:

arcane_agent_role_docker_exposed_ports

# Type: list
arcane_agent_role_docker_exposed_ports:

arcane_agent_role_docker_hosts

# Type: dict
arcane_agent_role_docker_hosts:

arcane_agent_role_docker_hosts_use_common

# Type: bool (true/false)
arcane_agent_role_docker_hosts_use_common:

arcane_agent_role_docker_ipc_mode

# Type: string
arcane_agent_role_docker_ipc_mode:

arcane_agent_role_docker_links

# Type: list
arcane_agent_role_docker_links:

arcane_agent_role_docker_network_mode

# Type: string
arcane_agent_role_docker_network_mode:

arcane_agent_role_docker_pid_mode

# Type: string
arcane_agent_role_docker_pid_mode:

arcane_agent_role_docker_ports

# Type: list
arcane_agent_role_docker_ports:

arcane_agent_role_docker_uts

# Type: string
arcane_agent_role_docker_uts:

Storage

arcane_agent_role_docker_keep_volumes

# Type: bool (true/false)
arcane_agent_role_docker_keep_volumes:

arcane_agent_role_docker_mounts

# Type: list
arcane_agent_role_docker_mounts:

arcane_agent_role_docker_storage_opts

# Type: dict
arcane_agent_role_docker_storage_opts:

arcane_agent_role_docker_tmpfs

# Type: list
arcane_agent_role_docker_tmpfs:

arcane_agent_role_docker_volume_driver

# Type: string
arcane_agent_role_docker_volume_driver:

arcane_agent_role_docker_volumes_from

# Type: list
arcane_agent_role_docker_volumes_from:

arcane_agent_role_docker_working_dir

# Type: string
arcane_agent_role_docker_working_dir:

Monitoring & Lifecycle

arcane_agent_role_docker_auto_remove

# Type: bool (true/false)
arcane_agent_role_docker_auto_remove:

arcane_agent_role_docker_cleanup

# Type: bool (true/false)
arcane_agent_role_docker_cleanup:

arcane_agent_role_docker_force_kill

# Type: bool (true/false)
arcane_agent_role_docker_force_kill:

arcane_agent_role_docker_healthy_wait_timeout

# Healthy-state wait timeout in seconds
# Type: int
arcane_agent_role_docker_healthy_wait_timeout:

arcane_agent_role_docker_init

# Type: bool (true/false)
arcane_agent_role_docker_init:

arcane_agent_role_docker_kill_signal

# Type: string
arcane_agent_role_docker_kill_signal:

arcane_agent_role_docker_log_driver

# Type: string
arcane_agent_role_docker_log_driver:

arcane_agent_role_docker_log_options

# Type: dict
arcane_agent_role_docker_log_options:

arcane_agent_role_docker_oom_killer

# Type: bool (true/false)
arcane_agent_role_docker_oom_killer:

arcane_agent_role_docker_oom_score_adj

# Type: int
arcane_agent_role_docker_oom_score_adj:

arcane_agent_role_docker_output_logs

# Type: bool (true/false)
arcane_agent_role_docker_output_logs:

arcane_agent_role_docker_paused

# Type: bool (true/false)
arcane_agent_role_docker_paused:

arcane_agent_role_docker_recreate

# Type: bool (true/false)
arcane_agent_role_docker_recreate:

arcane_agent_role_docker_restart_retries

# Type: int
arcane_agent_role_docker_restart_retries:

arcane_agent_role_docker_stop_signal

# Type: string
arcane_agent_role_docker_stop_signal:

arcane_agent_role_docker_stop_timeout

# Type: int
arcane_agent_role_docker_stop_timeout:

Other Options

arcane_agent_role_docker_capabilities

# Type: list
arcane_agent_role_docker_capabilities:

arcane_agent_role_docker_cgroup_parent

# Type: string
arcane_agent_role_docker_cgroup_parent:

arcane_agent_role_docker_commands

# Type: list
arcane_agent_role_docker_commands:

arcane_agent_role_docker_create_timeout

# Type: int
arcane_agent_role_docker_create_timeout:

arcane_agent_role_docker_entrypoint

# Type: list
arcane_agent_role_docker_entrypoint:

arcane_agent_role_docker_env_file

# Type: string
arcane_agent_role_docker_env_file:

arcane_agent_role_docker_labels

# Type: dict
arcane_agent_role_docker_labels:

arcane_agent_role_docker_labels_use_common

# Type: bool (true/false)
arcane_agent_role_docker_labels_use_common:

arcane_agent_role_docker_read_only

# Type: bool (true/false)
arcane_agent_role_docker_read_only:

arcane_agent_role_docker_runtime

# Type: string
arcane_agent_role_docker_runtime:

arcane_agent_role_docker_sysctls

# Type: dict
arcane_agent_role_docker_sysctls:

arcane_agent_role_docker_ulimits

# Type: list
arcane_agent_role_docker_ulimits:

arcane_agent_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
arcane_agent_role_autoheal_enabled: true

arcane_agent_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
arcane_agent_role_depends_on: ""

arcane_agent_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
arcane_agent_role_depends_on_delay: "0"

arcane_agent_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
arcane_agent_role_depends_on_healthchecks:

arcane_agent_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
arcane_agent_role_diun_enabled: true

arcane_agent_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
arcane_agent_role_docker_controller: true

arcane_agent_role_docker_networks_alias_custom

# Type: list
arcane_agent_role_docker_networks_alias_custom:

arcane_agent_role_docker_volumes_download

# Type: bool (true/false)
arcane_agent_role_docker_volumes_download:

arcane_agent_role_paths_folders_list_custom

# Extra directories to create
# Type: list
arcane_agent_role_paths_folders_list_custom:

arcane_agent_role_paths_group

# Group for directories created by the role
# Type: string
arcane_agent_role_paths_group:

arcane_agent_role_paths_owner

# Owner for directories created by the role
# Type: string
arcane_agent_role_paths_owner:

arcane_agent_role_paths_permissions

# Permissions for directories created by the role
# Type: string
arcane_agent_role_paths_permissions:

arcane_agent_role_paths_recursive

# Apply owner and group recursively without changing child modes
# Type: bool (true/false)
arcane_agent_role_paths_recursive: