ansible-role-elasticsearch/defaults/main.yml

---
es_version: "7.14.0"
es_use_snapshot_release: false
oss_version: false
es_package_name: "elasticsearch"
es_version_lock: false
es_use_repository: true
es_add_repository: true
es_templates_fileglob: ""
es_repo_base: "https://artifacts.elastic.co"
es_apt_key: "{{ es_repo_base }}/GPG-KEY-elasticsearch"
es_apt_url: "deb {{ es_repo_base }}/packages/{{ es_repo_name }}/apt stable main"
es_apt_url_old: "deb http://packages.elastic.co/elasticsearch/{{ es_repo_name }}/debian stable main"
es_start_service: true
es_java_install: "{{ false if (es_version is version('7.0.0', '>=')) else true }}"
update_java: false
es_restart_on_change: true
es_plugins_reinstall: false
es_templates: false
es_user: elasticsearch
es_group: elasticsearch
es_config: {}
es_config_default: "elasticsearch.j2"
es_config_log4j2: ""
es_config_jvm: "jvm.options.j2"
#Need to provide default directories
es_conf_dir: "/etc/elasticsearch"
es_pid_dir: "/var/run/elasticsearch"
es_tmp_dir: "/tmp"
es_data_dirs:
  - "/var/lib/elasticsearch"
es_log_dir: "/var/log/elasticsearch"
es_action_auto_create_index: true
es_max_open_files: 65536
es_max_map_count: 262144
es_allow_downgrades: false
es_xpack_trial: false
#These are used for internal operations performed by ansible.
#They do not affect the current configuration
es_api_scheme: "http"
es_api_host: "localhost"
es_api_port: 9200
es_api_uri: "{{ es_api_scheme }}://{{ es_api_host }}:{{ es_api_port }}"
es_security_api: "{{ '_security' if es_version is version('7.0.0', '>=') else '_xpack/security' }}"
es_license_api: "{{ '_license' if es_version is version('7.0.0', '>=') else '_xpack/license' }}"
es_api_sleep: 15
es_debian_startup_timeout: 10

# JVM custom parameters
es_java_home: ''
es_jvm_custom_parameters: ''
es_heap_dump_path: "/var/lib/elasticsearch"

# SSL/TLS parameters
es_enable_auto_ssl_configuration: true
es_enable_http_ssl: false
es_enable_transport_ssl: false
es_ssl_upload: true
es_ssl_keystore: ""
es_ssl_keystore_password: ""
es_ssl_truststore: ""
es_ssl_truststore_password: ""
es_ssl_key: ""
es_ssl_key_password: ""
es_ssl_certificate: ""
es_ssl_certificate_authority: ""
es_ssl_certificate_path: "{{ es_conf_dir }}/certs"
es_ssl_verification_mode: "certificate"
es_validate_certs: "yes"
es_delete_unmanaged_file: true
es_delete_unmanaged_native: true
Install Java on Debian 2015-05-11 16:51:33 +02:00			`---`
7.14.0 release (#812) 2021-08-03 16:15:59 +02:00			`es_version: "7.14.0"`
Use final 6.3.0 release instead of snapshot 2018-06-13 21:34:32 +02:00			`es_use_snapshot_release: false`
xpack features refactoring (#653) - rename es_enable_xpack variable to oss_version this variable name should be more explicit and consistent with the xpack changes made in 6.3 es_enable_xpack can still be used but is deprecated and will be removed in a later version. - remove es_xpack-features variables this variable was not working anymore since 6.3 [0] [0]: https://github.com/elastic/ansible-elasticsearch/issues/608 2020-06-12 18:15:03 +02:00			`oss_version: false`
WIP: 6.3 support 2018-06-13 08:29:45 +02:00			`es_package_name: "elasticsearch"`
Added new variable es_version_lock to define if deb/rpm package should be locked to currently installed version 2015-07-07 15:08:30 +02:00			`es_version_lock: false`
Added new variable for adding elasticsearch scripts 2015-08-03 15:14:29 +02:00			`es_use_repository: true`
Add option for disable the addition of official repository 2019-06-24 11:32:27 +02:00			`es_add_repository: true`
set templates task to run only if es_templates is true 2019-12-11 13:40:15 +01:00			`es_templates_fileglob: ""`
Template out the base of repo URLs Some popular artifact caches (e.g. Artifactory) do not provide HTTP CONNECT endpoints and thus aren't supported by es_proxy_host and es_proxy_port. This patch templates out the scheme and authority components (i.e. "https://artifacts.elastic.co" ) of the apt and yum repo URLs to accommodate the use of such artifact caches. 2019-01-16 16:11:51 -05:00			`es_repo_base: "https://artifacts.elastic.co"`
			`es_apt_key: "{{ es_repo_base }}/GPG-KEY-elasticsearch"`
			`es_apt_url: "deb {{ es_repo_base }}/packages/{{ es_repo_name }}/apt stable main"`
Use final 6.3.0 release instead of snapshot 2018-06-13 21:34:32 +02:00			`es_apt_url_old: "deb http://packages.elastic.co/elasticsearch/{{ es_repo_name }}/debian stable main"`
Changed default variable names so entire hash is not overwritten. Enabled plugin install 2015-05-13 13:33:43 +02:00			`es_start_service: true`
stop using deprecated version_compare (#659) 2020-05-06 13:41:00 +02:00			`es_java_install: "{{ false if (es_version is version('7.0.0', '>=')) else true }}"`
Idempotent Java 2016-04-16 11:22:27 +01:00			`update_java: false`
Adds support for optional restart on change 2016-01-18 14:38:22 +00:00			`es_restart_on_change: true`
Allow es_heap_size to be defined 2015-05-22 21:11:33 +02:00			`es_plugins_reinstall: false`
Changed minor version to 1.7.1, added new variable es_templates 2015-09-14 12:11:36 +02:00			`es_templates: false`
Added elasticsearch user/group and data dir to configuration 2015-05-23 14:38:13 +02:00			`es_user: elasticsearch`
			`es_group: elasticsearch`
Additional tests + support for empty es_config + documentation 2015-11-26 17:26:28 +00:00			`es_config: {}`
ansible code simplification after review 2019-12-02 14:15:00 +01:00			`es_config_default: "elasticsearch.j2"`
allow to deploy custom config files 2019-11-27 10:45:40 +01:00			`es_config_log4j2: ""`
ansible code simplification after review 2019-12-02 14:15:00 +01:00			`es_config_jvm: "jvm.options.j2"`
Correct handling of map in template 2015-11-25 15:28:09 +00:00			`#Need to provide default directories`
Remove multi instances support (#566) * remove multi instances support The goal is to stop supporting installation of more than one node in the same host. This commit update the Ansible role README documentation and remove the multi instances kitchen test. * remove systemd and init.d templates As we no more need to support more than one node on the same host, we no more need to override init files provided by elasticsearch official packages. * remove file script feature File scripts have been removed since elasticsearch 6.0 (https://www.elastic.co/guide/en/elasticsearch/reference/6.0/breaking_60_scripting_changes.html#_file_scripts_removed) * remove custom user and custom group ES_USER and ES_GROUP settings are no longer supported (https://www.elastic.co/guide/en/elasticsearch/reference/6.0/breaking_60_packaging_changes.html#_configuring_custom_user_and_group_for_package_is_no_longer_allowed) * add upgrade procedure * use same task for license activation with and without authentication 2019-06-03 14:18:09 +02:00			`es_conf_dir: "/etc/elasticsearch"`
Correct handling of map in template 2015-11-25 15:28:09 +00:00			`es_pid_dir: "/var/run/elasticsearch"`
add ansible var for ES_TMPDIR env var (#714) Elasticsearch requires its temp directory to be mounted as executable (see executable-jna-tmpdir). However, the CIS guidelines (e.g., CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v2.1.1, 1.1.5) recommend mounting /tmp with noexec. Therefore, users of this ansible role may have reason to set elasticsearch's temp dir to a non-default location. (The elasticsearch environment variable ES_TMPDIR gets set to /tmp by default. This PR preserves this default behavior.) 2020-09-02 02:10:28 -05:00			`es_tmp_dir: "/tmp"`
Remove multi instances support (#566) * remove multi instances support The goal is to stop supporting installation of more than one node in the same host. This commit update the Ansible role README documentation and remove the multi instances kitchen test. * remove systemd and init.d templates As we no more need to support more than one node on the same host, we no more need to override init files provided by elasticsearch official packages. * remove file script feature File scripts have been removed since elasticsearch 6.0 (https://www.elastic.co/guide/en/elasticsearch/reference/6.0/breaking_60_scripting_changes.html#_file_scripts_removed) * remove custom user and custom group ES_USER and ES_GROUP settings are no longer supported (https://www.elastic.co/guide/en/elasticsearch/reference/6.0/breaking_60_packaging_changes.html#_configuring_custom_user_and_group_for_package_is_no_longer_allowed) * add upgrade procedure * use same task for license activation with and without authentication 2019-06-03 14:18:09 +02:00			`es_data_dirs:`
			`- "/var/lib/elasticsearch"`
Correct handling of map in template 2015-11-25 15:28:09 +00:00			`es_log_dir: "/var/log/elasticsearch"`
Readded es_action_auto_create_index Default value is es_action_auto_create_index: true 2018-05-22 20:25:39 +02:00			`es_action_auto_create_index: true`
es_max_open_files default value changed to 65536 2016-06-29 10:56:32 +03:00			`es_max_open_files: 65536`
Updated debian scripts 2017-01-17 11:00:25 +00:00			`es_max_map_count: 262144`
Support for package downgrade 2016-07-20 14:57:21 +01:00			`es_allow_downgrades: false`
Add option to enable xpack trial 2019-10-18 16:54:46 +01:00			`es_xpack_trial: false`
Initial Shield support + latest gems + single plugin dir + new port/host vars 2016-07-22 23:44:27 +01:00			`#These are used for internal operations performed by ansible.`
Grammar 2017-10-11 20:22:27 -04:00			`#They do not affect the current configuration`
Add api scheme based on http_ssl variable 2019-10-11 17:16:35 +01:00			`es_api_scheme: "http"`
Initial Shield support + latest gems + single plugin dir + new port/host vars 2016-07-22 23:44:27 +01:00			`es_api_host: "localhost"`
use https for package sources 2016-10-27 00:20:23 +02:00			`es_api_port: 9200`
Update tests 2019-10-13 16:18:55 +01:00			`es_api_uri: "{{ es_api_scheme }}://{{ es_api_host }}:{{ es_api_port }}"`
stop using deprecated version_compare (#659) 2020-05-06 13:41:00 +02:00			`es_security_api: "{{ '_security' if es_version is version('7.0.0', '>=') else '_xpack/security' }}"`
			`es_license_api: "{{ '_license' if es_version is version('7.0.0', '>=') else '_xpack/license' }}"`
Add configurable native realm sleep 2019-10-25 10:10:42 +01:00			`es_api_sleep: 15`
parameterize debian init startup timeout 2017-10-09 17:11:06 +01:00			`es_debian_startup_timeout: 10`
Removing ssl configuration 2018-05-05 08:00:38 +02:00
Refactor to more common options for jvm 2017-02-13 13:13:20 +07:00			`# JVM custom parameters`
Introduce es_java_home variable to allow setting JAVA_HOME env var in defaults file. 2020-03-18 16:34:52 -07:00			`es_java_home: ''`
Refactor to more common options for jvm 2017-02-13 13:13:20 +07:00			`es_jvm_custom_parameters: ''`
Update jvm options with default values for 7.6.0 (#691) * update jvm options with default values for 7.6.0 * allow overriding heap dump path 2020-05-06 20:51:51 +02:00			`es_heap_dump_path: "/var/lib/elasticsearch"`
Add SSL/TLS support This commit introduces SSL/TLS support for the elastic search transport layer. It assumes certificates are generated externally, and only handles uploading and configuring the server accordingly. 2019-06-27 13:53:23 -07:00
			`# SSL/TLS parameters`
Add option to forgo autogenerated SSL config 2019-11-15 12:24:29 +00:00			`es_enable_auto_ssl_configuration: true`
Add SSL/TLS support This commit introduces SSL/TLS support for the elastic search transport layer. It assumes certificates are generated externally, and only handles uploading and configuring the server accordingly. 2019-06-27 13:53:23 -07:00			`es_enable_http_ssl: false`
			`es_enable_transport_ssl: false`
Add an option to not upload SSL/TLS certs (#727) 2020-10-12 10:02:25 +02:00			`es_ssl_upload: true`
Add SSL keystore and truststore 2019-10-11 16:09:05 +01:00			`es_ssl_keystore: ""`
Add ability to use key and truststore passwords 2019-10-12 00:57:49 +01:00			`es_ssl_keystore_password: ""`
Add SSL keystore and truststore 2019-10-11 16:09:05 +01:00			`es_ssl_truststore: ""`
Add ability to use key and truststore passwords 2019-10-12 00:57:49 +01:00			`es_ssl_truststore_password: ""`
Add SSL/TLS support This commit introduces SSL/TLS support for the elastic search transport layer. It assumes certificates are generated externally, and only handles uploading and configuring the server accordingly. 2019-06-27 13:53:23 -07:00			`es_ssl_key: ""`
Add ability to use key and truststore passwords 2019-10-12 00:57:49 +01:00			`es_ssl_key_password: ""`
Add SSL/TLS support This commit introduces SSL/TLS support for the elastic search transport layer. It assumes certificates are generated externally, and only handles uploading and configuring the server accordingly. 2019-06-27 13:53:23 -07:00			`es_ssl_certificate: ""`
			`es_ssl_certificate_authority: ""`
Use es_conf_dir for default cert location 2019-10-22 14:23:52 +01:00			`es_ssl_certificate_path: "{{ es_conf_dir }}/certs"`
Add SSL keystore and truststore 2019-10-11 16:09:05 +01:00			`es_ssl_verification_mode: "certificate"`
Add option for invalid certificates 2019-10-12 00:03:47 +01:00			`es_validate_certs: "yes"`
Update and document unmanaged user vars 2019-10-28 14:25:52 +00:00			`es_delete_unmanaged_file: true`
			`es_delete_unmanaged_native: true`