Elasticsearch¶

Overview¶

Elasticsearch is an open source distributed, RESTful search and analytics engine, scalable data store, and vector database capable of addressing a growing number of use cases. As the heart of the Elastic Stack, it centrally stores your data for lightning-fast search, fine‑tuned relevancy, and powerful analytics that scale with ease.

Manual

Releases

Community

Info

Elasticsearch is typically not a standalone app, it is run in tandem with another role to enable features.

Deployment¶

sb install sandbox-elasticsearch

Role Defaults¶

Use the Inventory to customize variables. (1)

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

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

BasicsSettingsDockerDocker+Global Override Options

elasticsearch_name

# Type: string
elasticsearch_name: elasticsearch

elasticsearch_role_docker_env_password

# Type: string
elasticsearch_role_docker_env_password: "elastic789"

elasticsearch_role_docker_env_http_port

# Type: string
elasticsearch_role_docker_env_http_port: "9200"

elasticsearch_role_docker_env_transport_port

# Type: string
elasticsearch_role_docker_env_transport_port: "9300"

elasticsearch_role_sysctl_vm_max_map_count

# Type: string
elasticsearch_role_sysctl_vm_max_map_count: "262144"

Container

elasticsearch_role_docker_container

# Type: string
elasticsearch_role_docker_container: "{{ elasticsearch_name }}"

Image

elasticsearch_role_docker_image_pull

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

elasticsearch_role_docker_image_repo

# Type: string
elasticsearch_role_docker_image_repo: "docker.elastic.co/elasticsearch/elasticsearch"

elasticsearch_role_docker_image_tag

# Type: string
elasticsearch_role_docker_image_tag: "8.11.0"

elasticsearch_role_docker_image

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

Envs

elasticsearch_role_docker_envs_default

# Type: dict
elasticsearch_role_docker_envs_default:
  TZ: "{{ tz }}"
  discovery.type: "single-node"
  node.name: "{{ elasticsearch_name }}"
  xpack.security.enabled: "false"
  ELASTIC_PASSWORD: "{{ lookup('role_var', '_docker_env_password', role='elasticsearch') }}"

elasticsearch_role_docker_envs_custom

# Type: dict
elasticsearch_role_docker_envs_custom: {}

Volumes

elasticsearch_role_docker_volumes_default

# Type: list
elasticsearch_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='elasticsearch') }}:/usr/share/elasticsearch/data"

elasticsearch_role_docker_volumes_custom

# Type: list
elasticsearch_role_docker_volumes_custom: []

Hostname

elasticsearch_role_docker_hostname

# Type: string
elasticsearch_role_docker_hostname: "{{ elasticsearch_name }}"

Networks

elasticsearch_role_docker_networks_alias

# Type: string
elasticsearch_role_docker_networks_alias: "{{ elasticsearch_name }}"

elasticsearch_role_docker_networks_default

# Type: list
elasticsearch_role_docker_networks_default: []

elasticsearch_role_docker_networks_custom

# Type: list
elasticsearch_role_docker_networks_custom: []

Restart Policy

elasticsearch_role_docker_restart_policy

# Type: string
elasticsearch_role_docker_restart_policy: unless-stopped

State

elasticsearch_role_docker_state

# Type: string
elasticsearch_role_docker_state: started

User

elasticsearch_role_docker_user

# Type: string
elasticsearch_role_docker_user: "{{ uid }}"

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

Resource Limits

elasticsearch_role_docker_blkio_weight

# Type: int
elasticsearch_role_docker_blkio_weight:

elasticsearch_role_docker_cpu_period

# Type: int
elasticsearch_role_docker_cpu_period:

elasticsearch_role_docker_cpu_quota

# Type: int
elasticsearch_role_docker_cpu_quota:

elasticsearch_role_docker_cpu_shares

# Type: int
elasticsearch_role_docker_cpu_shares:

elasticsearch_role_docker_cpus

# Type: string
elasticsearch_role_docker_cpus:

elasticsearch_role_docker_cpuset_cpus

# Type: string
elasticsearch_role_docker_cpuset_cpus:

elasticsearch_role_docker_cpuset_mems

# Type: string
elasticsearch_role_docker_cpuset_mems:

elasticsearch_role_docker_kernel_memory

# Type: string
elasticsearch_role_docker_kernel_memory:

elasticsearch_role_docker_memory

# Type: string
elasticsearch_role_docker_memory:

elasticsearch_role_docker_memory_reservation

# Type: string
elasticsearch_role_docker_memory_reservation:

elasticsearch_role_docker_memory_swap

# Type: string
elasticsearch_role_docker_memory_swap:

elasticsearch_role_docker_memory_swappiness

# Type: int
elasticsearch_role_docker_memory_swappiness:

elasticsearch_role_docker_shm_size

# Type: string
elasticsearch_role_docker_shm_size:

Security & Devices

elasticsearch_role_docker_cap_drop

# Type: list
elasticsearch_role_docker_cap_drop:

elasticsearch_role_docker_cgroupns_mode

# Type: string
elasticsearch_role_docker_cgroupns_mode:

elasticsearch_role_docker_device_cgroup_rules

# Type: list
elasticsearch_role_docker_device_cgroup_rules:

elasticsearch_role_docker_device_read_bps

# Type: list
elasticsearch_role_docker_device_read_bps:

elasticsearch_role_docker_device_read_iops

# Type: list
elasticsearch_role_docker_device_read_iops:

elasticsearch_role_docker_device_requests

# Type: list
elasticsearch_role_docker_device_requests:

elasticsearch_role_docker_device_write_bps

# Type: list
elasticsearch_role_docker_device_write_bps:

elasticsearch_role_docker_device_write_iops

# Type: list
elasticsearch_role_docker_device_write_iops:

elasticsearch_role_docker_devices

# Type: list
elasticsearch_role_docker_devices:

elasticsearch_role_docker_devices_default

# Type: string
elasticsearch_role_docker_devices_default:

elasticsearch_role_docker_groups

# Type: list
elasticsearch_role_docker_groups:

elasticsearch_role_docker_privileged

# Type: bool (true/false)
elasticsearch_role_docker_privileged:

elasticsearch_role_docker_security_opts

# Type: list
elasticsearch_role_docker_security_opts:

elasticsearch_role_docker_userns_mode

# Type: string
elasticsearch_role_docker_userns_mode:

Networking

elasticsearch_role_docker_dns_opts

# Type: list
elasticsearch_role_docker_dns_opts:

elasticsearch_role_docker_dns_search_domains

# Type: list
elasticsearch_role_docker_dns_search_domains:

elasticsearch_role_docker_dns_servers

# Type: list
elasticsearch_role_docker_dns_servers:

elasticsearch_role_docker_domainname

# Type: string
elasticsearch_role_docker_domainname:

elasticsearch_role_docker_exposed_ports

# Type: list
elasticsearch_role_docker_exposed_ports:

elasticsearch_role_docker_hosts

# Type: dict
elasticsearch_role_docker_hosts:

elasticsearch_role_docker_hosts_use_common

# Type: bool (true/false)
elasticsearch_role_docker_hosts_use_common:

elasticsearch_role_docker_ipc_mode

# Type: string
elasticsearch_role_docker_ipc_mode:

elasticsearch_role_docker_links

# Type: list
elasticsearch_role_docker_links:

elasticsearch_role_docker_network_mode

# Type: string
elasticsearch_role_docker_network_mode:

elasticsearch_role_docker_pid_mode

# Type: string
elasticsearch_role_docker_pid_mode:

elasticsearch_role_docker_ports

# Type: list
elasticsearch_role_docker_ports:

elasticsearch_role_docker_uts

# Type: string
elasticsearch_role_docker_uts:

Storage

elasticsearch_role_docker_keep_volumes

# Type: bool (true/false)
elasticsearch_role_docker_keep_volumes:

elasticsearch_role_docker_mounts

# Type: list
elasticsearch_role_docker_mounts:

elasticsearch_role_docker_storage_opts

# Type: dict
elasticsearch_role_docker_storage_opts:

elasticsearch_role_docker_tmpfs

# Type: list
elasticsearch_role_docker_tmpfs:

elasticsearch_role_docker_volume_driver

# Type: string
elasticsearch_role_docker_volume_driver:

elasticsearch_role_docker_volumes_from

# Type: list
elasticsearch_role_docker_volumes_from:

elasticsearch_role_docker_volumes_global

# Type: bool (true/false)
elasticsearch_role_docker_volumes_global:

elasticsearch_role_docker_working_dir

# Type: string
elasticsearch_role_docker_working_dir:

Monitoring & Lifecycle

elasticsearch_role_docker_auto_remove

# Type: bool (true/false)
elasticsearch_role_docker_auto_remove:

elasticsearch_role_docker_cleanup

# Type: bool (true/false)
elasticsearch_role_docker_cleanup:

elasticsearch_role_docker_force_kill

# Type: string
elasticsearch_role_docker_force_kill:

elasticsearch_role_docker_healthcheck

# Type: dict
elasticsearch_role_docker_healthcheck:

elasticsearch_role_docker_healthy_wait_timeout

# Type: int
elasticsearch_role_docker_healthy_wait_timeout:

elasticsearch_role_docker_init

# Type: bool (true/false)
elasticsearch_role_docker_init:

elasticsearch_role_docker_kill_signal

# Type: string
elasticsearch_role_docker_kill_signal:

elasticsearch_role_docker_log_driver

# Type: string
elasticsearch_role_docker_log_driver:

elasticsearch_role_docker_log_options

# Type: dict
elasticsearch_role_docker_log_options:

elasticsearch_role_docker_oom_killer

# Type: bool (true/false)
elasticsearch_role_docker_oom_killer:

elasticsearch_role_docker_oom_score_adj

# Type: int
elasticsearch_role_docker_oom_score_adj:

elasticsearch_role_docker_output_logs

# Type: bool (true/false)
elasticsearch_role_docker_output_logs:

elasticsearch_role_docker_paused

# Type: bool (true/false)
elasticsearch_role_docker_paused:

elasticsearch_role_docker_recreate

# Type: bool (true/false)
elasticsearch_role_docker_recreate:

elasticsearch_role_docker_restart_retries

# Type: int
elasticsearch_role_docker_restart_retries:

elasticsearch_role_docker_stop_timeout

# Type: int
elasticsearch_role_docker_stop_timeout:

Other Options

elasticsearch_role_docker_capabilities

# Type: list
elasticsearch_role_docker_capabilities:

elasticsearch_role_docker_cgroup_parent

# Type: string
elasticsearch_role_docker_cgroup_parent:

elasticsearch_role_docker_commands

# Type: list
elasticsearch_role_docker_commands:

elasticsearch_role_docker_create_timeout

# Type: int
elasticsearch_role_docker_create_timeout:

elasticsearch_role_docker_entrypoint

# Type: string
elasticsearch_role_docker_entrypoint:

elasticsearch_role_docker_env_file

# Type: string
elasticsearch_role_docker_env_file:

elasticsearch_role_docker_labels

# Type: dict
elasticsearch_role_docker_labels:

elasticsearch_role_docker_labels_use_common

# Type: bool (true/false)
elasticsearch_role_docker_labels_use_common:

elasticsearch_role_docker_read_only

# Type: bool (true/false)
elasticsearch_role_docker_read_only:

elasticsearch_role_docker_runtime

# Type: string
elasticsearch_role_docker_runtime:

elasticsearch_role_docker_sysctls

# Type: list
elasticsearch_role_docker_sysctls:

elasticsearch_role_docker_ulimits

# Type: list
elasticsearch_role_docker_ulimits:

elasticsearch_role_autoheal_enabled

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

elasticsearch_role_depends_on

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

elasticsearch_role_depends_on_delay

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

elasticsearch_role_depends_on_healthchecks

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

elasticsearch_role_diun_enabled

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

elasticsearch_role_docker_controller

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

elasticsearch_role_docker_env_password

# Type: string
elasticsearch_role_docker_env_password:

elasticsearch_role_docker_image_repo

# Type: string
elasticsearch_role_docker_image_repo:

elasticsearch_role_docker_image_tag

# Type: string
elasticsearch_role_docker_image_tag:

elasticsearch_role_docker_volumes_download

# Type: bool (true/false)
elasticsearch_role_docker_volumes_download:

elasticsearch_role_paths_location

# Type: string
elasticsearch_role_paths_location: