* Failures are no longer raised when no instances are defined for a plugin and service restarts are not requested.
* The `datadir` for instances can now be shared among multiple instances by using the `datadir_instance_directories` parameter.
* `repo_baseurl` is now exposed as a top-level parameter for users who wish to control custom repositories.
+* `elasticsearch-keystore` values can now be managed via native Puppet resources.
#### Fixes
## 5.2.0 (May 5, 2017)
### Summary
Release supporting several new features and bugfixes for 5.4.0 users and users who need the ability to update plugins.
#### Features
* Support for Shield/X-Pack logging configuration file added.
* The `elasticsearch::script` type now supports recursively managing directories of scripts.
* All module defined types can now be managed as top-level hash parameters to the `elasticsearch` class (primarily for hiera and PE)
#### Fixes
* Fixed a bug that prevented plugins from being updated properly.
* Fixed deprecated `default.path` options introduced in Elasticsearch 5.4.0.
## 5.1.1 (April 13, 2017)
### Summary
#### Features
* Instance configs now have highest precedence when constructing the final yaml
config file.
#### Fixes
This is a hotfix release to support users affected by [an upstream Elasticsearch issue](https://github.com/elastic/elasticsearch/issues/6887).
See the [associated issue](https://github.com/elastic/puppet-elasticsearch/issues/802#issuecomment-293295930) for details regarding the workaround.
The change implemented in this release is to place the `elasticsearch::instance` `config` parameter at the highest precedence when merging the final config yaml which permits users manually override `path.data` values.
## 5.1.0 (February 28, 2017)
### Summary
Ingest pipeline and index settings support.
Minor bugfixes.
#### Features
* Ingestion pipelines supported via custom resources.
* Index settings support.
#### Fixes
* Custom facts no longer fail when trying to read unreadable elasticsearch config files.
* `Accept` and `Content-Type` headers properly set for providers (to support ES 6.x)
## 5.0.0 (February 9, 2017)
Going forward, This module will follow Elasticsearch's upstream major version to indicate compatability.
That is, version 5.x of this module supports version 5 of Elasticsearch, and version 6.x of this module will be released once Elasticsearch 6 support is added.
### Summary
Note that this is a **major version release**!
Please read the release notes carefully before upgrading to avoid downtime/unexpected behavior.
Remember to restart any puppetmaster servers to clear provider caches and pull in updated code.
### Backwards-Incompatible Changes
* The `elasticsearch::shield::user` and `elasticsearch::shield::role` resources have been renamed to `elasticsearch::user` and `elasticsearch::role` since the resource now handles both Shield and X-Pack.
* Both Shield and X-Pack configuration files are kept in `/etc/elasticsearch/shield` and `/etc/elasticsearch/x-pack`, respectively. If you previously managed Shield resources with version 0.x of this module, you may need to migrate files from `/usr/share/elasticsearch/shield`.
* The default data directory has been changed to `/var/lib/elasticsearch`. If you used the previous default (the Elasticsearch home directory, `/usr/share/elasticsearch/data`), you may need to migrate your data.
* The first changes that may be Elasticsearch 1.x-incompatible have been introduced (see the [elasticsearch support lifecycle](https://www.elastic.co/support/eol)). This only impacts version 1.x running on systemd-based distributions.
* sysctl management has been removed (and the module removed as a dependency for this module), and puppet/yum is used in lieu of ceritsc/yum.
#### Features
* Support management of the global jvm.options configuration file.
* X-Pack support added.
* Restricted permissions to the elasticsearch.yml file.
* Deprecation log configuration support added.
* Synced systemd service file with upstream.
#### Bugfixes
* Fixed case in which index template could prepend an additional 'index.' to index settings.
* Fixed a case in which dependency cycles could arise when pinning packages on CentOS.
* No longer recursively change the Elasticsearch home directory's lib/ to the elasticsearch user.
* Unused defaults values now purged from instance init defaults files.
#### Changes
* Changed default data directory to /var/lib
* sysctl settings are no longer managed by the thias/sysctl module.
* Calls to `elasticsearch -version` in elasticsearch::plugin code replaced with native Puppet code to resolve Elasticsearch package version. Should improve resiliency when managing plugins.
* Shield and X-Pack configuration files are stored in /etc/elasticsearch instead of /usr/share/elasticsearch.
* Removed deprecated ceritsc/yum module in favor of puppet/yum.
#### Testing changes
## 0.15.1 (December 1, 2016)
### Summary
Primarily a bugfix release for Elasticsearch 5.x support-related issues.
Note updated minimum required puppet versions as well.
#### Features
#### Bugfixes
* Removed ES_HEAP_SIZE check in init scripts for Elasticsearch 5.x
* Changed sysctl value to a string to avoid type errors for some versions
* Fixed a $LOAD_PATH error that appeared in some cases for puppet_x/elastic/es_versioning
#### Changes
* Updated minimium required version for Puppet and PE to reflect tested versions and versions supported by Puppet Labs
#### Testing changes
## 0.15.0 (November 17, 2016)
### Summary
* Support for Ubuntu Xenial (16.04) formally declared.
* Initial support for running Elasticsearch 5.x series.
#### Features
* Support management of 5.x-style Elastic yum/apt package repositories.
* Support service scripts for 5.x series of Elasticsearch
#### Bugfixes
* Update the apt::source call to not cause deprecation warnings
* Updated module metadata to correctly require puppet-stdlib with validate_integer()
#### Changes
#### Testing changes
* Ubuntu Xenial (16.04) added to the test matrix.
## 0.14.0 (October 12, 2016)
### Summary
Primarily a bugfix release for issues related to plugin proxy functionality, various system service fixes, and directory permissions.
This release also adds the ability to define logging rolling file settings and a CA file/path for template API access.
#### Features
* Added 'file_rolling_type' parameter to allow selecting file logging rotation type between "dailyRollingFile" or "rollingFile". Also added 'daily_rolling_date_pattern', 'rolling_file_max_backup_index' and 'rolling_file_max_file_size' for file rolling customization.
#### Bugfixes
* Permissions on the Elasticsearch plugin directory have been fixed to permit world read rights.
* The service systemd unit now `Wants=` a network target to fix bootup parallelization problems.
* Recursively create the logdir for elasticsearch when creating multiple instances
* Files and directories with root ownership now specify UID/GID 0 instead to improve compatability with *BSDs.
* Elasticsearch Debian init file changed to avoid throwing errors when DATA_DIR, WORK_DIR and/or LOG_DIR were an empty variable.
* Fixed a broken File dependency when a plugin was set to absent and ::elasticsearch set to present.
* Fixed issue when using the `proxy` parameter on plugins in Elasticsearch 2.x.
#### Changes
* The `api_ca_file` and `api_ca_path` parameters have been added to support custom CA bundles for API access.
* Numerics in elasticsearch.yml will always be properly unquoted.
* puppetlabs/java is now listed as a dependency in metadata.json to avoid unexpected installation problems.
#### Testing changes
## 0.13.2 (August 29, 2016)
### Summary
Primarily a bugfix release to resolve HTTPS use in elasticsearch::template resources, 5.x plugin operations, and plugin file permission enforcement.
#### Features
* Plugin installation for the 5.x series of Elasticsearch is now properly supported.
* Fixed an edge case where dependency cycles could arise when managing absent resources.
* Elasticsearch templates now properly use HTTPS when instructed to do so.
#### Changes
* Updated the elasticsearch_template type to return more helpful error output.
* Updated the es_instance_conn_validator type to silence deprecation warnings in Puppet >= 4.
#### Testing changes
## 0.13.1 (August 8, 2016)
### Summary
Lingering bugfixes from elasticsearch::template changes.
More robust systemd mask handling.
Updated some upstream module parameters for deprecation warnings.
Support for the Shield `system_key` file.
#### Features
* Added `system_key` parameter to the `elasticsearch` class and `elasticsearch::instance` type for placing Shield system keys.
#### Bugfixes
* Fixed systemd elasticsearch.service unit masking to use systemctl rather than raw symlinking to avoid puppet file backup errors.
* Fixed a couple of cases that broke compatability with older versions of puppet (elasticsearch_template types on puppet versions prior to 3.6 and yumrepo parameters on puppet versions prior to 3.5.1)
* Fixed issues that caused templates to be incorrectly detected as out-of-sync and thus always changed on each puppet run.
* Resources are now explicitly ordered to ensure behavior such as plugins being installed before instance start, users managed before templates changed, etc.
#### Changes
* Updated repository gpg fingerprint key to long form to silence module warnings.
#### Testing changes
## 0.13.0 (August 1, 2016)
### Summary
Rewritten elasticsearch::template using native type and provider.
Fixed and added additional proxy parameters to elasticsearch::plugin instances.
Exposed repo priority parameters for apt and yum repos.
#### Features
* In addition to better consistency, the `elasticsearch::template` type now also accepts various `api_*` parameters to control how access to the Elasticsearch API is configured (there are top-level parameters that are inherited and can be overwritten in `elasticsearch::api_*`).
* The `elasticsearch::config` parameter now supports deep hiera merging.
* Added the `elasticsearch::repo_priority` parameter to support apt and yum repository priority configuration.
* Added `proxy_username` and `proxy_password` parameters to `elasticsearch::plugin`.
#### Bugfixes
* Content of templates should now properly trigger new API PUT requests when the index template stored in Elasticsearch differs from the template defined in puppet.
* Installing plugins with proxy parameters now works correctly due to changed Java property flags.
* The `elasticsearch::plugin::module_dir` parameter has been re-implemented to aid in working around plugins with non-standard plugin directories.
#### Changes
* The `file` parameter on the `elasticsearch::template` defined type has been deprecated to be consistent with usage of the `source` parameter for other types.
#### Testing changes
## 0.12.0 (July 20, 2016)
IMPORTANT! A bug was fixed that mistakenly added /var/lib to the list of DATA_DIR paths on Debian-based systems. This release removes that environment variable, which could potentially change path.data directories for instances of Elasticsearch. Take proper precautions when upgrading to avoid unexpected downtime or data loss (test module upgrades, et cetera).
### Summary
Rewritten yaml generator, code cleanup, and various bugfixes. Configuration file yaml no longer nested. Service no longer restarts by default, and exposes more granular restart options.
#### Features
* The additional parameters restart_config_change, restart_package_change, and restart_plugin_change have been added for more granular control over service restarts.
#### Bugfixes
* Special yaml cases such as arrays of hashes and strings like "::" are properly supported.
* Previous Debian SysV init scripts mistakenly set the `DATA_DIR` environment variable to a non-default value.
* Some plugins failed installation due to capitalization munging, the elasticsearch_plugin provider no longer forces downcasing.
#### Changes
* The `install_options` parameter on the `elasticsearch::plugin` type has been removed. This was an undocumented parameter that often caused problems for users.
* The `elasticsearch.service` systemd unit is no longer removed but masked by default, effectively hiding it from systemd but retaining the upstream vendor unit on disk for package management consistency.
* `restart_on_change` now defaults to false to reduce unexpected cluster downtime (can be set to true if desired).
* Package pinning is now contained within a separate class, so users can opt to manage package repositories manually and still use this module's pinning feature.
* All configuration hashes are now flattened into dot-notated yaml in the elasticsearch configuration file. This should be fairly transparent in terms of behavior, though the config file formatting will change.
#### Testing changes
* The acceptance test suite has been dramatically slimmed to cut down on testing time and reduce false positives.
## 0.11.0 ( May 23, 2016 )
### Summary
Shield support, SLES support, and overhauled testing setup.
#### Features
* Support for shield
* TLS Certificate management
* Users (role and password management for file-based realms)
* Roles (file-based with mapping support)
* Support (repository proxies)[https://github.com/elastic/puppet-elasticsearch/pull/615]
* Support for (SSL auth on API calls)[https://github.com/elastic/puppet-elasticsearch/pull/577]
#### Bugfixes
* (Fix Facter calls)[https://github.com/elastic/puppet-elasticsearch/pull/590] in custom providers
#### Changes
#### Testing changes
* Overhaul testing methodology, see CONTRIBUTING for updates
* Add SLES 12, Oracle 6, and PE 2016.1.1 to testing matrix
* Enforce strict variable checking
#### Known bugs
* This is the first release with Shield support, some untested edge cases may exist
##0.10.3 ( Feb 08, 2016 )
###Summary
Adding support for OpenBSD and minor fixes
####Features
* Add required changes to work with ES 2.2.x plugins
* Support for custom log directory
* Support for OpenBSD
####Bugfixes
* Add correct relation to file resource and plugin installation
* Notify service when upgrading the package
####Changes
* Remove plugin dir when upgrading Elasticsearch
####Testing changes
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.10.2 ( Jan 19, 2016 )
###Summary
Bugfix release and adding Gentoo support
####Features
* Added Gentoo support
####Bugfixes
* Create init script when set to unmanaged
* init_template variable was not passed on correctly to other classes / defines
* Fix issue with plugin type that caused run to stall
* Export ES_GC_LOG_FILE in init scripts
####Changes
* Improve documentation about init_defaults
* Update common files
* Removed recurse option on data directory management
* Add retry functionality to plugin type
####Testing changes
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.10.1 ( Dec 17, 2015 )
###Summary
Bugfix release for proxy functionality in plugin installation
####Features
####Bugfixes
* Proxy settings were not passed on correctly
####Changes
* Cleanup .pmtignore to exclude more files
####Testing changes
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.10.0 ( Dec 14, 2015 )
###Summary
Module now works with ES 2.x completely
####Features
* Work with ES 2.x new plugin system and remain to work with 1.x
* Implemented datacat module from Richard Clamp so other modules can hook into it for adding configuration options
* Fixed init and systemd files to work with 1.x and 2.x
* Made the module work with newer pl-apt module versions
* Export es_include so it is passed on to ES
* Ability to supply long gpg key for apt repo
####Bugfixes
* Documentation and typographical fixes
* Do not force puppet:/// schema resource
* Use package resource defaults rather than setting provider and source
####Changes
####Testing changes
* Improve unit testing and shorten the runtime
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.9 ( Sep 01, 2015 )
###Summary
Bugfix release and extra features
####Features
* Work with ES 2.x
* Add Java 8 detection in debian init script
* Improve offline plugin installation
####Bugfixes
* Fix a bug with new ruby versions but older puppet versions causing type error
* Fix config tempate to use correct ruby scoping
* Fix regex retrieving proxy port while downloading plugin
* Fix systemd template for better variable handling
* Template define was using wrong pathing for removal
####Changes
####Testing changes
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.8 ( Jul 07, 2015 )
###Summary
####Features
* Work with ES 2.x
####Bugfixes
* Fix plugin to maintain backwards compatibility
####Changes
####Testing changes
* ensure testing works with Puppet 4.x ( Rspec and Acceptance )
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.7 ( Jun 24, 2015 )
###Summary
This releases adds several important features and fixes an important plugin installation issue with ES 1.6 and higher.
####Features
* Automate plugin dir extraction
* use init service provider for Amazon Linux
* Add Puppetlabs/apt and ceritsc/yum as required modules
* Added Timeout to fetching facts in case ES does not respond
* Add proxy settings for package download
####Bugfixes
* Fixed systemd template to fix issue with LimitMEMLOCK setting
* Improve package version handling when specifying a version
* Add tmpfiles.d file to manage sub dir in /var/run path
* Fix plugin installations for ES 1.6 and higher
####Changes
* Removed Modulefile, only maintaining metadata.json file
####Testing changes
* Added unit testing for package pinning feature
* Added integration testing with Elasticsearch to find issues earlier
* Fix OpenSuse 13 testing
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.6 ( May 28, 2015 )
###Summary
Bugfix release 0.9.6
####Features
* Implemented package version pinning to avoid accidental upgrading
* Added support for Debian 8
* Added support for upgrading plugins
* Managing LimitNOFILE and LimitMEMLOCK settings in systemd
####Bugfixes
####Changes
* Dropped official support for PE 3.1.x and 3.2.x
####Testing changes
* Several testing changes implemented to increase coverage
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.5( Apr 16, 2015 )
###Summary
Bugfix release 0.9.5
We reverted the change that implemented the full 40 character for the apt repo key.
This caused issues with some older versions of the puppetlabs-apt module
####Features
####Bugfixes
* Revert using the full 40 character for the apt repo key.
####Changes
####Testing changes
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.4( Apr 14, 2015 )
###Summary
Bugfix release 0.9.4
####Features
* Add the ability to create and populate scripts
####Bugfixes
* add support for init_defaults_file to elasticsearch::instance
* Update apt key to full 40characters
####Changes
* Fix readme regarding module_dir with plugins
####Testing changes
* Adding staged removal test
* Convert git urls to https
* Add centos7 node config
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.3( Mar 24, 2015 )
###Summary
Bugfix release 0.9.3
####Features
####Bugfixes
* Not setting repo_version did not give the correct error
* Systemd file did not contain User/Group values
####Changes
* Brand rename from Elasticsearch to Elastic
####Testing changes
* Moved from multiple Gemfiles to single Gemfile
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.2( Mar 06, 2015 )
###Summary
Bugfix release 0.9.2
####Features
* Introducing es_instance_conn_validator resource to verify instance availability
####Bugfixes
* Fix missing data path when using the path config setting but not setting the data path
####Changes
None
####Testing changes
None
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.1 ( Feb 23, 2015 )
###Summary
This is the first bug fix release for 0.9 version.
A bug was reported with the recursive file management.
####Features
None
####Bugfixes
* Fix recursive file management
* Set undefined variables to work with strict_variables
####Changes
None
####Testing changes
None
####Known bugs
* Possible package conflicts when using ruby/python defines with main package name
##0.9.0 ( Feb 02, 2015 )
###Summary
This release is the first one towards 1.0 release.
Our planning is to provide LTS releases with the puppet module
####Features
* Support for using hiera to define instances and plugins.
* Support for OpenSuSE 13.x
* Custom facts about the installed Elasticsearch instance(s)
* Proxy host/port support for the plugin installation
* Ability to supply a custom logging.yml template
####Bugfixes
* Ensure file owners are correct accross all related files
* Fix of possible service name conflict
* Empty main config would fail with instances
* Removal of standard files from packages we dont use
* Ensuring correct sequence of plugin and template defines
* Added ES_CLASSPATH export to init scripts
####Changes
* Java installation to use puppetlabs-java module
* Added Support and testing for Puppet 3.7 and PE 3.7
* Improve metadata.json based on scoring from Forge
####Testing changes
* Added testing against Puppet 3.7 and PE 3.7
* Using rspec3
* Using rspec-puppet-facts gem simplifies rspec testing
####Known Bugs
* Possible package conflicts when using ruby/python defines with main package name
1. [Module description - What the module does and why it is useful](#module-description)
2. [Setup - The basics of getting started with Elasticsearch](#setup)
* [The module manages the following](#the-module-manages-the-following)
* [Requirements](#requirements)
3. [Usage - Configuration options and additional functionality](#usage)
4. [Advanced features - Extra information on advanced usage](#advanced-features)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
8. [Support - When you need help with this module](#support)
## Module description
This module sets up [Elasticsearch](https://www.elastic.co/overview/elasticsearch/) instances with additional resource for plugins, templates, and more.
This module is actively tested against Elasticsearch 2.x and 5.x.
## Setup
### The module manages the following
* Elasticsearch repository files.
* Elasticsearch package.
* Elasticsearch configuration file.
* Elasticsearch service.
* Elasticsearch plugins.
* Elasticsearch templates.
* Elasticsearch ingest pipelines.
* Elasticsearch index settings.
* Elasticsearch Shield/X-Pack users, roles, and certificates.
+* Elasticsearch keystores.
### Requirements
* The [stdlib](https://forge.puppetlabs.com/puppetlabs/stdlib) Puppet library.
* [puppet/yum](https://forge.puppetlabs.com/puppet/yum) For yum version lock.
Declare the top-level `elasticsearch` class (managing repositories) and set up an instance:
```puppet
class { 'elasticsearch':
java_install => true,
manage_repo => true,
repo_version => '5.x',
}
elasticsearch::instance { 'es-01': }
```
**Note**: Elasticsearch 5.x requires a recent version of the JVM.
If you are on a recent version of your distribution of choice (such as Ubuntu 16.04 or CentOS 7), setting `java_install => true` will work out-of-the-box.
If you are on an earlier distribution, you may need to take additional measures to install Java 1.8.
## Usage
### Main class
Most top-level parameters in the `elasticsearch` class are set to reasonable defaults.
The following are some parameters that may be useful to override:
#### Install a specific version
```puppet
class { 'elasticsearch':
version => '1.4.2'
}
```
Note: This will only work when using the repository.
#### Automatically restarting the service (default set to false)
By default, the module will not restart Elasticsearch when the configuration file, package, or plugins change.
This can be overridden globally with the following option:
```puppet
class { 'elasticsearch':
restart_on_change => true
}
```
Or controlled with the more granular options: `restart_config_change`, `restart_package_change`, and `restart_plugin_change.`
#### Automatic upgrades (default set to false)
```puppet
class { 'elasticsearch':
autoupgrade => true
}
```
#### Removal/Decommissioning
```puppet
class { 'elasticsearch':
ensure => 'absent'
}
```
#### Install everything but disable service(s) afterwards
```puppet
class { 'elasticsearch':
status => 'disabled'
}
```
#### API Settings
Some resources, such as `elasticsearch::template`, require communicating with the Elasticsearch REST API.
By default, these API settings are set to:
```puppet
class { 'elasticsearch':
api_protocol => 'http',
api_host => 'localhost',
api_port => 9200,
api_timeout => 10,
api_basic_auth_username => undef,
api_basic_auth_password => undef,
api_ca_file => undef,
api_ca_path => undef,
validate_tls => true,
}
```
Each of these can be set at the top-level `elasticsearch` class and inherited for each resource or overridden on a per-resource basis.
#### Dynamically Created Resources
This module supports managing all of its defined types through top-level parameters to better support Hiera and Puppet Enterprise.
For example, to manage an instance and index template directly from the `elasticsearch` class:
```puppet
class { 'elasticsearch':
instances => {
'es-01' => {
'config' => {
'network.host' => '0.0.0.0'
}
}
},
templates => {
'logstash' => {
'content' => {
'template' => 'logstash-*',
'settings' => {
'number_of_replicas' => 0
}
}
}
}
}
```
### Instances
This module works with the concept of instances. For service to start you need to specify at least one instance.
#### Quick setup
```puppet
elasticsearch::instance { 'es-01': }
```
This will set up its own data directory and set the node name to `$hostname-$instance_name`
#### Advanced options
Instance specific options can be given:
```puppet
elasticsearch::instance { 'es-01':
config => { }, # Configuration hash
init_defaults => { }, # Init defaults hash
datadir => [ ], # Data directory
}
```
See [Advanced features](#advanced-features) for more information.
### Plugins
This module can help manage [a variety of plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-plugins.html#known-plugins).
Note that `module_dir` is where the plugin will install itself to and must match that published by the plugin author; it is not where you would like to install it yourself.
Most sites will manage Java separately; however, this module can attempt to install Java as well.
This is done by using the [puppetlabs-java](https://forge.puppetlabs.com/puppetlabs/java) module.
```puppet
class { 'elasticsearch':
java_install => true
}
```
Specify a particular Java package/version to be installed:
```puppet
class { 'elasticsearch':
java_install => true,
java_package => 'packagename'
}
```
When configuring Elasticsearch's memory usage, you can do so by either changing init defaults for Elasticsearch 1.x/2.x (see the [following example](#hash-representation)), or modify it globally in 5.x using `jvm.options`:
```puppet
class { 'elasticsearch':
jvm_options => [
'-Xms4g',
'-Xmx4g'
]
}
```
### Service management
Currently only the basic SysV-style [init](https://en.wikipedia.org/wiki/Init) and [Systemd](http://en.wikipedia.org/wiki/Systemd) service providers are supported, but other systems could be implemented as necessary (pull requests welcome).
#### Defaults File
The *defaults* file (`/etc/defaults/elasticsearch` or `/etc/sysconfig/elasticsearch`) for the Elasticsearch service can be populated as necessary.
This can either be a static file resource or a simple key value-style [hash](http://docs.puppetlabs.com/puppet/latest/reference/lang_datatypes.html#hashes) object, the latter being particularly well-suited to pulling out of a data source such as Hiera.
Note: `init_defaults` hash can be passed to the main class and to the instance.
## Advanced features
### X-Pack/Shield
[X-Pack](https://www.elastic.co/products/x-pack) and [Shield](https://www.elastic.co/products/shield) file-based users, roles, and certificates can be managed by this module.
**Note**: If you are planning to use these features, it is *highly recommended* you read the following documentation to understand the caveats and extent of the resources available to you.
#### Getting Started
Although this module can handle several types of Shield/X-Pack resources, you are expected to manage the plugin installation and versions for your deployment.
For example, the following manifest will install Elasticseach with a single instance running X-Pack:
The following manifest will do the same, but with Shield:
```puppet
class { 'elasticsearch':
java_install => true,
manage_repo => true,
repo_version => '2.x',
security_plugin => 'shield',
}
elasticsearch::instance { 'es-01': }
Elasticsearch::Plugin { instances => ['es-01'], }
elasticsearch::plugin { 'license': }
elasticsearch::plugin { 'shield': }
```
The following examples will assume the preceding resources are part of your puppet manifest.
#### Roles
Roles in the file realm (the `esusers` realm in Shield) can be managed using the `elasticsearch::role` type.
For example, to create a role called `myrole`, you could use the following resource in X-Pack:
```puppet
elasticsearch::role { 'myrole':
privileges => {
'cluster' => [ 'monitor' ],
'indices' => [{
'names' => [ '*' ],
'privileges' => [ 'read' ],
}]
}
}
```
And in Shield:
```puppet
elasticsearch::role { 'myrole':
privileges => {
'cluster' => 'monitor',
'indices' => {
'*' => 'read'
}
}
}
```
This role would grant users access to cluster monitoring and read access to all indices.
See the [Shield](https://www.elastic.co/guide/en/shield/index.html) or [X-Pack](https://www.elastic.co/guide/en/x-pack/current/xpack-security.html) documentation for your version to determine what `privileges` to use and how to format them (the Puppet hash representation will simply be translated into yaml.)
**Note**: The Puppet provider for `esusers`/`users` has fine-grained control over the `roles.yml` file and thus will leave the default roles Shield installs in-place.
If you would like to explicitly purge the default roles (leaving only roles managed by puppet), you can do so by including the following in your manifest:
```puppet
resources { 'elasticsearch_role':
purge => true,
}
```
##### Mappings
Associating mappings with a role for file-based management is done by passing an array of strings to the `mappings` parameter of the `elasticsearch::role` type.
For example, to define a role with mappings:
```puppet
elasticsearch::role { 'logstash':
mappings => [
'cn=group,ou=devteam',
],
privileges => {
'cluster' => 'manage_index_templates',
'indices' => [{
'names' => ['logstash-*'],
'privileges' => [
'write',
'delete',
'create_index',
],
}],
},
}
```
**Note**: Observe the brackets around `indices` in the preceding role definition; which is an array of hashes per the format in Shield 2.3.x. Follow the documentation to determine the correct formatting for your version of Shield or X-Pack.
If you'd like to keep the mappings file purged of entries not under Puppet's control, you should use the following `resources` declaration because mappings are a separate low-level type:
```puppet
resources { 'elasticsearch_role_mapping':
purge => true,
}
```
#### Users
Users can be managed using the `elasticsearch::user` type.
For example, to create a user `mysuser` with membership in `myrole`:
```puppet
elasticsearch::user { 'myuser':
password => 'mypassword',
roles => ['myrole'],
}
```
The `password` parameter will also accept password hashes generated from the `esusers`/`users` utility and ensure the password is kept in-sync with the Shield `users` file for all Elasticsearch instances.
**Note**: When using the `esusers`/`users` provider (the default for plaintext passwords), Puppet has no way to determine whether the given password is in-sync with the password hashed by Shield/X-Pack.
In order to work around this, the `elasticsearch::user` resource has been designed to accept refresh events in order to update password values.
This is not ideal, but allows you to instruct the resource to change the password when needed.
For example, to update the aforementioned user's password, you could include the following your manifest:
```puppet
notify { 'update password': } ~>
elasticsearch::user { 'myuser':
password => 'mynewpassword',
roles => ['myrole'],
}
```
#### Certificates
SSL/TLS can be enabled by providing an `elasticsearch::instance` type with paths to the certificate and private key files, and a password for the keystore.
```puppet
elasticsearch::instance { 'es-01':
ssl => true,
ca_certificate => '/path/to/ca.pem',
certificate => '/path/to/cert.pem',
private_key => '/path/to/key.pem',
keystore_password => 'keystorepassword',
}
```
**Note**: Setting up a proper CA and certificate infrastructure is outside the scope of this documentation, see the aforementioned Shield or X-Pack guide for more information regarding the generation of these certificate files.
The module will set up a keystore file for the node to use and set the relevant options in `elasticsearch.yml` to enable TLS/SSL using the certificates and key provided.
#### System Keys
Shield/X-Pack system keys can be passed to the module, where they will be placed into individual instance configuration directories.
This can be set at the `elasticsearch` class and inherited across all instances:
```puppet
class { 'elasticsearch':
system_key => 'puppet:///path/to/key',
}
```
Or set on a per-instance basis:
```puppet
elasticsearch::instance { 'es-01':
system_key => '/local/path/to/key',
}
```
### Package version pinning
The module supports pinning the package version to avoid accidental upgrades that are not done by Puppet.
To enable this feature:
```puppet
class { 'elasticsearch':
package_pin => true,
version => '1.5.2',
}
```
In this example we pin the package version to 1.5.2.
### Data directories
There are several different ways of setting data directories for Elasticsearch.
In every case the required configuration options are placed in the `elasticsearch.yml` file.
In some cases, you may want to share a top-level data directory among multiple instances.
```puppet
class { 'elasticsearch':
datadir_instance_directories => false,
config => {
'node.max_local_storage_nodes' => 2
}
}
elasticsearch::instance { 'es-01': }
elasticsearch::instance { 'es-02': }
```
Will result in the following directories created by Elasticsearch at runtime:
/var/lib/elasticsearch/nodes/0
/var/lib/elasticsearch/nodes/1
See [the Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html#max-local-storage-nodes) for additional information regarding this configuration.
### Main and instance configurations
The `config` option in both the main class and the instances can be configured to work together.
The options in the `instance` config hash will merged with the ones from the main class and override any duplicates.
#### Simple merging
```puppet
class { 'elasticsearch':
config => { 'cluster.name' => 'clustername' }
}
elasticsearch::instance { 'es-01':
config => { 'node.name' => 'nodename' }
}
elasticsearch::instance { 'es-02':
config => { 'node.name' => 'nodename2' }
}
```
This example merges the `cluster.name` together with the `node.name` option.
#### Overriding
When duplicate options are provided, the option in the instance config overrides the ones from the main class.
+Recent versions of Elasticsearch include the [elasticsearch-keystore](https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-settings.html) utility to create and manage the `elasticsearch.keystore` file which can store sensitive values for certain settings.
+The settings and values for this file can be controlled by this module.
+Settings follow the behavior of the `config` parameter for the top-level Elasticsearch class and `elasticsearch::instance` defined types.
+That is, you may define keystore settings globally, and all values will be merged with instance-specific settings for final inclusion in the `elasticsearch.keystore` file.
+Note that each hash key is passed to the `elasticsearch-keystore` utility in a straightforward manner, so you should specify the hash passed to `secrets` in flattened form (that is, without full nested hash representation).
+
+For example, to define cloud plugin credentials for all instances:
+
+```puppet
+class { 'elasticsearch':
+ secrets => {
+ 'cloud.aws.access_key' => 'AKIA....',
+ 'cloud.aws.secret_key' => 'AKIA....',
+ }
+}
+```
+
+Or, to instead control these settings for a single instance:
+
+```puppet
+elasticsearch::instance { 'es-01':
+ secrets => {
+ 'cloud.aws.access_key' => 'AKIA....',
+ 'cloud.aws.secret_key' => 'AKIA....',
+ }
+}
+```
+
+##### Purging Secrets
+
+By default, if a secret setting exists on-disk that is not present in the `secrets` hash, this module will leave it intact.
+If you prefer to keep only secrets in the keystore that are specified in the `secrets` hash, use the `purge_secrets` boolean parameter either on the `elasticsearch` class to set it globally or per-instance.
+
+##### Notifying Services
+
+Any changes to keystore secrets will notify running elasticsearch services by respecting the `restart_on_change` and `restart_config_change` parameters.
+
## Limitations
This module is built upon and tested against the versions of Puppet listed in
the metadata.json file (i.e. the listed compatible versions on the Puppet
Forge).
The module has been tested on:
* Debian 7/8
* CentOS 6/7
* OracleLinux 6/7
* Ubuntu 14.04, 16.04
* OpenSuSE 42.x
* SLES 12
Other distro's that have been reported to work:
* RHEL 6
* Scientific 6
Testing on other platforms has been light and cannot be guaranteed.
## Development
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for instructions regarding development environments and testing.
## Support
Need help? Join us in [#elasticsearch](https://webchat.freenode.net?channels=%23elasticsearch) on Freenode IRC or on the [discussion forum](https://discuss.elastic.co/).
it { should contain_file('/etc/elasticsearch/es-01/logging.yml').with_content(/^logger.index.search.slowlog: DEBUG, index_search_slow_log_file$/).with(:source => nil) }
end
context 'logging file ' do
let(:pre_condition) { <<-EOS
class { "elasticsearch":
logging_file => "puppet:///path/to/logging.yml"
}
EOS
}
it { should contain_file('/etc/elasticsearch/es-01/logging.yml').with(:source => 'puppet:///path/to/logging.yml', :content => nil) }
it { should contain_file('/etc/elasticsearch/es-01/logging.yml').with_content(/^logger.index.search.slowlog: INFO, index_search_slow_log_file$/).with(:source => nil) }
end
context 'logging file' do
let :params do {
:logging_file => 'puppet:///path/to/logging.yml'
} end
it { should contain_file('/etc/elasticsearch/es-01/logging.yml').with(:source => 'puppet:///path/to/logging.yml', :content => nil) }
end
context 'deprecation logging' do
let :params do {
:deprecation_logging => true
} end
it { should contain_file('/etc/elasticsearch/es-01/logging.yml').with_content(/^logger.deprecation: DEBUG, deprecation_log_file$/).with(:source=> nil) }
it { should contain_file('/etc/elasticsearch/es-01/logging.yml')
it { should contain_file('/etc/elasticsearch/es-01/logging.yml').with_content(/^logger.deprecation: INFO, deprecation_log_file$/).with(:source=> nil) }
end
end
describe 'rollingFile apender' do
let(:pre_condition) {%q{
class { 'elasticsearch':
file_rolling_type => 'rollingFile',
rolling_file_max_backup_index => 10,
rolling_file_max_file_size => '100MB',
}
}}
it { should contain_file('/etc/elasticsearch/es-01/logging.yml')
.with_content(
/type: rollingFile/,
/maxBackupIndex: 10/,
/maxBackupIndex: 10/,
/maxFileSize: 100MB/)
}
end
end
context 'running as an other user' do
let(:pre_condition) { <<-EOS
class { "elasticsearch":
elasticsearch_user => "myesuser",
elasticsearch_group => "myesgroup"
}
EOS
}
it { should contain_file('/var/lib/elasticsearch/es-01').with(:owner => 'myesuser') }
it { should contain_file('/etc/elasticsearch/es-01').with(:owner => 'myesuser', :group => 'myesgroup') }
it { should contain_datacat('/etc/elasticsearch/es-01/elasticsearch.yml').with(:owner => 'myesuser', :group => 'myesgroup') }
it { should contain_file('/etc/elasticsearch/es-01/elasticsearch.yml').with(:owner => 'myesuser', :group => 'myesgroup') }
it { should contain_file('/etc/elasticsearch/es-01/logging.yml').with(:owner => 'myesuser', :group => 'myesgroup') }
it { should contain_file('/etc/elasticsearch/es-01/log4j2.properties').with(:owner => 'myesuser', :group => 'myesgroup') }
end
context 'setting different service status then main class' do
let(:pre_condition) { 'class {"elasticsearch": status => "enabled" }' }
context 'status option' do
let :params do {
:status => 'running'
} end
it { should contain_service('elasticsearch-instance-es-01').with(:ensure => 'running', :enable => false) }
end
end
context 'init_template' do
context 'default' do
it { should contain_elasticsearch__service('es-01').with(:init_template => 'elasticsearch/etc/init.d/elasticsearch.RedHat.erb') }