OpenObserve

Description / name	Input element
Your domain name

Overview

OpenObserve is an open-source observability platform for logs, metrics, and traces with 140x lower storage cost than Elasticsearch. Built for petabyte scale with high performance and ~40x compression.

Manual

Releases

Community

---

Deployment

sb install sandbox-openobserve

Usage

Visit https://openobserve.iYOUR_DOMAIN_NAMEi.

Basics

Default credentials are configured using your user email and password. Root user setup is required for initial access.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   openobserve_name: "custom_value"
   

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like openobserve_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 openobserve_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

openobserve_name

# Type: string
openobserve_name: openobserve

openobserve_role_web_subdomain

# Type: string
openobserve_role_web_subdomain: "{{ openobserve_name }}"

openobserve_role_web_domain

# Type: string
openobserve_role_web_domain: "{{ user.domain }}"

openobserve_role_web_port

# Type: string
openobserve_role_web_port: "5080"

openobserve_role_web_url

# Type: string
openobserve_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='openobserve') + '.' + lookup('role_var', '_web_domain', role='openobserve')
                           if (lookup('role_var', '_web_subdomain', role='openobserve') | length > 0)
                           else lookup('role_var', '_web_domain', role='openobserve')) }}"

openobserve_role_dns_record

# Type: string
openobserve_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='openobserve') }}"

openobserve_role_dns_zone

# Type: string
openobserve_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='openobserve') }}"

openobserve_role_dns_proxy

# Type: bool (true/false)
openobserve_role_dns_proxy: "{{ dns_proxied }}"

openobserve_role_traefik_sso_middleware

# Type: string
openobserve_role_traefik_sso_middleware: ""

openobserve_role_traefik_middleware_default

# Type: string
openobserve_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

openobserve_role_traefik_middleware_custom

# Type: string
openobserve_role_traefik_middleware_custom: ""

openobserve_role_traefik_certresolver

# Type: string
openobserve_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

openobserve_role_traefik_enabled

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

openobserve_role_traefik_api_enabled

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

openobserve_role_traefik_api_endpoint

# Type: string
openobserve_role_traefik_api_endpoint: ""

Container

openobserve_role_docker_container

# Type: string
openobserve_role_docker_container: "{{ openobserve_name }}"

Image

openobserve_role_docker_image_pull

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

openobserve_role_docker_image_tag

# Type: string
openobserve_role_docker_image_tag: "latest"

openobserve_role_docker_image_repo

# Type: string
openobserve_role_docker_image_repo: "public.ecr.aws/zinclabs/openobserve"

openobserve_role_docker_image

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

Envs

openobserve_role_docker_envs_default

# Type: dict
openobserve_role_docker_envs_default:
  TZ: "{{ tz }}"
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  ZO_ROOT_USER_EMAIL: "{{ user.email }}"
  ZO_ROOT_USER_PASSWORD: "{{ user.pass }}"

openobserve_role_docker_envs_custom

# Type: dict
openobserve_role_docker_envs_custom: {}

Volumes

openobserve_role_docker_volumes_default

# Type: list
openobserve_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='openobserve') }}:/data"

openobserve_role_docker_volumes_custom

# Type: list
openobserve_role_docker_volumes_custom: []

Hostname

openobserve_role_docker_hostname

# Type: string
openobserve_role_docker_hostname: "{{ openobserve_name }}"

Networks

openobserve_role_docker_networks_alias

# Type: string
openobserve_role_docker_networks_alias: "{{ openobserve_name }}"

openobserve_role_docker_networks_default

# Type: list
openobserve_role_docker_networks_default: []

openobserve_role_docker_networks_custom

# Type: list
openobserve_role_docker_networks_custom: []

Restart Policy

openobserve_role_docker_restart_policy

# Type: string
openobserve_role_docker_restart_policy: unless-stopped

State

openobserve_role_docker_state

# Type: string
openobserve_role_docker_state: started

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

Resource Limits

openobserve_role_docker_blkio_weight

# Type: int
openobserve_role_docker_blkio_weight:

openobserve_role_docker_cpu_period

# Type: int
openobserve_role_docker_cpu_period:

openobserve_role_docker_cpu_quota

# Type: int
openobserve_role_docker_cpu_quota:

openobserve_role_docker_cpu_shares

# Type: int
openobserve_role_docker_cpu_shares:

openobserve_role_docker_cpus

# Type: string
openobserve_role_docker_cpus:

openobserve_role_docker_cpuset_cpus

# Type: string
openobserve_role_docker_cpuset_cpus:

openobserve_role_docker_cpuset_mems

# Type: string
openobserve_role_docker_cpuset_mems:

openobserve_role_docker_kernel_memory

# Type: string
openobserve_role_docker_kernel_memory:

openobserve_role_docker_memory

# Type: string
openobserve_role_docker_memory:

openobserve_role_docker_memory_reservation

# Type: string
openobserve_role_docker_memory_reservation:

openobserve_role_docker_memory_swap

# Type: string
openobserve_role_docker_memory_swap:

openobserve_role_docker_memory_swappiness

# Type: int
openobserve_role_docker_memory_swappiness:

openobserve_role_docker_shm_size

# Type: string
openobserve_role_docker_shm_size:

Security & Devices

openobserve_role_docker_cap_drop

# Type: list
openobserve_role_docker_cap_drop:

openobserve_role_docker_cgroupns_mode

# Type: string
openobserve_role_docker_cgroupns_mode:

openobserve_role_docker_device_cgroup_rules

# Type: list
openobserve_role_docker_device_cgroup_rules:

openobserve_role_docker_device_read_bps

# Type: list
openobserve_role_docker_device_read_bps:

openobserve_role_docker_device_read_iops

# Type: list
openobserve_role_docker_device_read_iops:

openobserve_role_docker_device_requests

# Type: list
openobserve_role_docker_device_requests:

openobserve_role_docker_device_write_bps

# Type: list
openobserve_role_docker_device_write_bps:

openobserve_role_docker_device_write_iops

# Type: list
openobserve_role_docker_device_write_iops:

openobserve_role_docker_devices

# Type: list
openobserve_role_docker_devices:

openobserve_role_docker_devices_default

# Type: string
openobserve_role_docker_devices_default:

openobserve_role_docker_groups

# Type: list
openobserve_role_docker_groups:

openobserve_role_docker_privileged

# Type: bool (true/false)
openobserve_role_docker_privileged:

openobserve_role_docker_security_opts

# Type: list
openobserve_role_docker_security_opts:

openobserve_role_docker_user

# Type: string
openobserve_role_docker_user:

openobserve_role_docker_userns_mode

# Type: string
openobserve_role_docker_userns_mode:

Networking

openobserve_role_docker_dns_opts

# Type: list
openobserve_role_docker_dns_opts:

openobserve_role_docker_dns_search_domains

# Type: list
openobserve_role_docker_dns_search_domains:

openobserve_role_docker_dns_servers

# Type: list
openobserve_role_docker_dns_servers:

openobserve_role_docker_domainname

# Type: string
openobserve_role_docker_domainname:

openobserve_role_docker_exposed_ports

# Type: list
openobserve_role_docker_exposed_ports:

openobserve_role_docker_hosts

# Type: dict
openobserve_role_docker_hosts:

openobserve_role_docker_hosts_use_common

# Type: bool (true/false)
openobserve_role_docker_hosts_use_common:

openobserve_role_docker_ipc_mode

# Type: string
openobserve_role_docker_ipc_mode:

openobserve_role_docker_links

# Type: list
openobserve_role_docker_links:

openobserve_role_docker_network_mode

# Type: string
openobserve_role_docker_network_mode:

openobserve_role_docker_pid_mode

# Type: string
openobserve_role_docker_pid_mode:

openobserve_role_docker_ports

# Type: list
openobserve_role_docker_ports:

openobserve_role_docker_uts

# Type: string
openobserve_role_docker_uts:

Storage

openobserve_role_docker_keep_volumes

# Type: bool (true/false)
openobserve_role_docker_keep_volumes:

openobserve_role_docker_mounts

# Type: list
openobserve_role_docker_mounts:

openobserve_role_docker_storage_opts

# Type: dict
openobserve_role_docker_storage_opts:

openobserve_role_docker_tmpfs

# Type: list
openobserve_role_docker_tmpfs:

openobserve_role_docker_volume_driver

# Type: string
openobserve_role_docker_volume_driver:

openobserve_role_docker_volumes_from

# Type: list
openobserve_role_docker_volumes_from:

openobserve_role_docker_volumes_global

# Type: bool (true/false)
openobserve_role_docker_volumes_global:

openobserve_role_docker_working_dir

# Type: string
openobserve_role_docker_working_dir:

Monitoring & Lifecycle

openobserve_role_docker_auto_remove

# Type: bool (true/false)
openobserve_role_docker_auto_remove:

openobserve_role_docker_cleanup

# Type: bool (true/false)
openobserve_role_docker_cleanup:

openobserve_role_docker_force_kill

# Type: string
openobserve_role_docker_force_kill:

openobserve_role_docker_healthcheck

# Type: dict
openobserve_role_docker_healthcheck:

openobserve_role_docker_healthy_wait_timeout

# Type: int
openobserve_role_docker_healthy_wait_timeout:

openobserve_role_docker_init

# Type: bool (true/false)
openobserve_role_docker_init:

openobserve_role_docker_kill_signal

# Type: string
openobserve_role_docker_kill_signal:

openobserve_role_docker_log_driver

# Type: string
openobserve_role_docker_log_driver:

openobserve_role_docker_log_options

# Type: dict
openobserve_role_docker_log_options:

openobserve_role_docker_oom_killer

# Type: bool (true/false)
openobserve_role_docker_oom_killer:

openobserve_role_docker_oom_score_adj

# Type: int
openobserve_role_docker_oom_score_adj:

openobserve_role_docker_output_logs

# Type: bool (true/false)
openobserve_role_docker_output_logs:

openobserve_role_docker_paused

# Type: bool (true/false)
openobserve_role_docker_paused:

openobserve_role_docker_recreate

# Type: bool (true/false)
openobserve_role_docker_recreate:

openobserve_role_docker_restart_retries

# Type: int
openobserve_role_docker_restart_retries:

openobserve_role_docker_stop_timeout

# Type: int
openobserve_role_docker_stop_timeout:

Other Options

openobserve_role_docker_capabilities

# Type: list
openobserve_role_docker_capabilities:

openobserve_role_docker_cgroup_parent

# Type: string
openobserve_role_docker_cgroup_parent:

openobserve_role_docker_commands

# Type: list
openobserve_role_docker_commands:

openobserve_role_docker_create_timeout

# Type: int
openobserve_role_docker_create_timeout:

openobserve_role_docker_entrypoint

# Type: string
openobserve_role_docker_entrypoint:

openobserve_role_docker_env_file

# Type: string
openobserve_role_docker_env_file:

openobserve_role_docker_labels

# Type: dict
openobserve_role_docker_labels:

openobserve_role_docker_labels_use_common

# Type: bool (true/false)
openobserve_role_docker_labels_use_common:

openobserve_role_docker_read_only

# Type: bool (true/false)
openobserve_role_docker_read_only:

openobserve_role_docker_runtime

# Type: string
openobserve_role_docker_runtime:

openobserve_role_docker_sysctls

# Type: list
openobserve_role_docker_sysctls:

openobserve_role_docker_ulimits

# Type: list
openobserve_role_docker_ulimits:

openobserve_role_autoheal_enabled

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

openobserve_role_depends_on

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

openobserve_role_depends_on_delay

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

openobserve_role_depends_on_healthchecks

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

openobserve_role_diun_enabled

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

openobserve_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
openobserve_role_dns_enabled: true

openobserve_role_docker_controller

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

openobserve_role_docker_image_repo

# Type: string
openobserve_role_docker_image_repo:

openobserve_role_docker_image_tag

# Type: string
openobserve_role_docker_image_tag:

openobserve_role_docker_volumes_download

# Type: bool (true/false)
openobserve_role_docker_volumes_download:

openobserve_role_paths_location

# Type: string
openobserve_role_paths_location:

openobserve_role_themepark_addons

# Type: string
openobserve_role_themepark_addons:

openobserve_role_themepark_app

# Type: string
openobserve_role_themepark_app:

openobserve_role_themepark_theme

# Type: string
openobserve_role_themepark_theme:

openobserve_role_traefik_api_endpoint

# Type: dict/omit
openobserve_role_traefik_api_endpoint:

openobserve_role_traefik_api_middleware

# Type: string
openobserve_role_traefik_api_middleware:

openobserve_role_traefik_api_middleware_http

# Type: string
openobserve_role_traefik_api_middleware_http:

openobserve_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
openobserve_role_traefik_autodetect_enabled: false

openobserve_role_traefik_certresolver

# Type: string
openobserve_role_traefik_certresolver:

openobserve_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
openobserve_role_traefik_crowdsec_enabled: false

openobserve_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
openobserve_role_traefik_error_pages_enabled: false

openobserve_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
openobserve_role_traefik_gzip_enabled: false

openobserve_role_traefik_middleware_http

# Type: string
openobserve_role_traefik_middleware_http:

openobserve_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
openobserve_role_traefik_middleware_http_api_insecure:

openobserve_role_traefik_middleware_http_insecure

# Type: bool (true/false)
openobserve_role_traefik_middleware_http_insecure:

openobserve_role_traefik_priority

# Type: string
openobserve_role_traefik_priority:

openobserve_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
openobserve_role_traefik_robot_enabled: true

openobserve_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
openobserve_role_traefik_tailscale_enabled: false

openobserve_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
openobserve_role_traefik_wildcard_enabled: true

openobserve_role_web_domain

# Type: string
openobserve_role_web_domain:

openobserve_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
openobserve_role_web_fqdn_override:

Example Override

openobserve_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "openobserve2.{{ user.domain }}"
  - "openobserve.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

openobserve_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
openobserve_role_web_host_override:

Example Override

openobserve_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'openobserve2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

openobserve_role_web_http_port

# Type: string (quoted number)
openobserve_role_web_http_port:

openobserve_role_web_http_scheme

# Type: string ("http"/"https")
openobserve_role_web_http_scheme:

openobserve_role_web_http_serverstransport

# Type: dict/omit
openobserve_role_web_http_serverstransport:

openobserve_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
openobserve_role_web_scheme:

openobserve_role_web_serverstransport

# Type: dict/omit
openobserve_role_web_serverstransport:

openobserve_role_web_subdomain

# Type: string
openobserve_role_web_subdomain: