kosmos/chef
8
3
Fork 0
Code Issues 34 Pull Requests 3 Projects 2 Activity

Update the elasticsearch cookbook

Browse Source
This commit is contained in:
Greg Karékinian
2023-06-29 16:39:09 +02:00
parent 68ce3c4834
commit 7683de09a2
48 changed files with 2016 additions and 2065 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
cookbooks/elasticsearch/README.md
View File

@@ -1,6 +1,6 @@
# Elasticsearch Chef Cookbook
[![Build Status](https://travis-ci.org/elastic/cookbook-elasticsearch.svg?branch=master)](https://travis-ci.org/elastic/cookbook-elasticsearch) [![Cookbook Version](https://img.shields.io/cookbook/v/elasticsearch.svg)](https://supermarket.chef.io/cookbooks/elasticsearch)[![Build Status](https://jenkins-01.eastus.cloudapp.azure.com/job/elasticsearch-cookbook/badge/icon)](https://jenkins-01.eastus.cloudapp.azure.com/job/elasticsearch-cookbook/)
[![Cookbook Version](https://img.shields.io/cookbook/v/elasticsearch.svg)](https://supermarket.chef.io/cookbooks/elasticsearch)
**Please** review the [frequently asked questions](FAQ.md) and [contributing guidelines](CONTRIBUTING.md) before opening issues or submitting pull requests.
@@ -8,59 +8,6 @@
Please [check out the previous 3.x.x releases](https://github.com/elastic/cookbook-elasticsearch/tree/3.x.x) of this cookbook. Please consider pinning your cookbook to '~> 3.0' for support for Elasticsearch 6 and earlier, or '~> 4.0' release for Elasticsearch 6 and beyond.
## Attributes
Please consult [attributes/default.rb](attributes/default.rb) for a large list
of checksums for many different archives and package files of different
elasticsearch versions. Both recipes and resources/providers here use those
default values.
You may use `%s` in your URL and this cookbook will use sprintf/format to insert
the version parameter as a string into your download_url.
|Name|Default|Other values|
|----|-------|------------|
| For Elasticsearch < 7: ||
|`default['elasticsearch']['download_urls']['debian']`|[See values](attributes/default.rb).|`%s` will be replaced with the version attribute above|
|`default['elasticsearch']['download_urls']['rhel']`|[See values](attributes/default.rb).|`%s` will be replaced with the version attribute above|
|`default['elasticsearch']['download_urls']['tarball']`|[See values](attributes/default.rb).|`%s` will be replaced with the version attribute above|
| For Elasticsearch >= 7: ||
|`default['elasticsearch']['download_urls_v7']['debian']`|[See values](attributes/default.rb).|`%s` will be replaced with the version attribute above|
|`default['elasticsearch']['download_urls_v7']['rhel']`|[See values](attributes/default.rb).|`%s` will be replaced with the version attribute above|
|`default['elasticsearch']['download_urls_v7']['tarball']`|[See values](attributes/default.rb).|`%s` will be replaced with the version attribute above|
This cookbook's `elasticsearch::default` recipe also supports setting any `elasticsearch_` resource using attributes:
```
default['elasticsearch']['user'] = {}
default['elasticsearch']['install'] = {}
default['elasticsearch']['configure'] = {}
default['elasticsearch']['service'] = {}
default['elasticsearch']['plugin'] = {}
```
For example, this will pass a username 'foo' to `elasticsearch_user` and set a uid to `1234`:
```
default['elasticsearch']['user']['username'] = 'foo'
default['elasticsearch']['user']['uid'] = '1234'
```
## Recipes
Resources are the intended way to consume this cookbook, however we have
provided a single recipe that configures Elasticsearch by downloading an archive
containing a distribution of Elasticsearch, and extracting that into `/usr/share`.
See the attributes section above to for what defaults you can adjust.
### default
The default recipe creates an elasticsearch user, group, package installation,
configuration files, and service with all of the default options.
Please note that there are [additional examples within the test fixtures](test/fixtures/cookbooks/elasticsearch_test),
including a demonstration of how to configure two instances of Elasticsearch on a single server.
## Resources
## Notifications and Service Start/Restart
@@ -72,8 +19,6 @@ actions to the underlying service resource if you wish to notify it.
You **must** supply your desired notifications when using each resource if you want Chef to automatically restart services. Again, we don't recommend this unless you know what you're doing.
We are supporting whyrun mode in this cookbook, simply because we're using all builtin resources from core Chef, and these also already support whyrun. If you contribute to this cookbook, please be sure to maintain that or guard dangerous Ruby code with something like `if !whyrun_mode? || nested_resource.whyrun_supported?`.
### Resource names
Many of the resources provided in this cookbook need to share configuration
@@ -103,6 +48,7 @@ elasticsearch_plugin 'x-pack'
```
### elasticsearch_user
Actions: `:create`, `:remove`
Creates a user and group on the system for use by elasticsearch. Here is an
@@ -127,6 +73,7 @@ end
```
### elasticsearch_install
Actions: `:install`, `:remove`
Downloads the elasticsearch software, and unpacks it on the system. There are
@@ -155,29 +102,29 @@ elasticsearch_install 'elasticsearch'
```ruby
elasticsearch_install 'my_es_installation' do
type 'package' # type of install
version '7.4.2'
action :install # could be :remove as well
type 'package'
version '7.8.0'
action :install
end
```
```ruby
elasticsearch_install 'my_es_installation' do
type 'tarball' # type of install
type 'tarball'
dir '/usr/local' # where to install
download_url "https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-1.7.2.tar.gz"
# sha256
download_checksum "6f81935e270c403681e120ec4395c28b2ddc87e659ff7784608b86beb5223dd2"
action :install # could be :remove as well
action :install
end
```
```ruby
elasticsearch_install 'my_es_installation' do
type 'tarball' # type of install
version '7.4.2'
type 'tarball'
version '7.8.0'
action :install # could be :remove as well
end
```
@@ -194,6 +141,7 @@ end
```
### elasticsearch_configure
Actions: `:manage`, `:remove`
Configures an elasticsearch instance; creates directories for configuration,
@@ -205,7 +153,7 @@ which is a hash of any elasticsearch configuration directives. The
other important attribute is `default_configuration` -- this contains the
minimal set of required defaults.
Note that these are both _not_ a Chef mash, everything must be in a single level
Note that these are both *not* a Chef mash, everything must be in a single level
of keys and values. Any settings you pass in configuration will be merged into
(and potentially overwrite) any default settings.
@@ -215,11 +163,13 @@ for more.
Examples:
With all defaults -
```ruby
elasticsearch_configure 'elasticsearch'
```
With mostly defaults -
```ruby
elasticsearch_configure 'elasticsearch' do
allocated_memory '512m'
@@ -232,6 +182,7 @@ end
```
Very complicated -
```ruby
elasticsearch_configure 'my_elasticsearch' do
# if you override one of these, you probably want to override all
@@ -269,6 +220,7 @@ end
```
### elasticsearch_service
Actions: `:configure`, `:remove`
Writes out a system service configuration of the appropriate type, and enables
@@ -286,6 +238,7 @@ entirely skip trying to setup those scripts. Combined with changing the default
service actions, this will have the same effect as `action :nothing`.
### elasticsearch_plugin
Actions: `:install`, `:remove`
Installs or removes a plugin to a given elasticsearch instance and plugin
@@ -295,7 +248,7 @@ Furthermore, there isn't a way to determine if a plugin is compatible with ES or
even what version it is. So once we install a plugin to a directory, we
generally assume that is the desired one and we don't touch it further.
See https://github.com/elastic/cookbook-elasticsearch/issues/264 for more info.
See <https://github.com/elastic/cookbook-elasticsearch/issues/264> for more info.
NB: You [may encounter issues on certain distros](http://blog.backslasher.net/java-ssl-crash.html) with NSS 3.16.1 and OpenJDK 7.x.
Officially supported or commercial plugins require just the plugin name:
@@ -324,6 +277,7 @@ end
```
Plugins from Maven Central or Sonatype require 'groupId/artifactId/version':
```ruby
elasticsearch_plugin 'mapper-attachments' do
url 'org.elasticsearch/elasticsearch-mapper-attachments/2.6.0'
@@ -332,6 +286,7 @@ end
```
Plugins can be installed from a custom URL or file location as follows:
```ruby
elasticsearch_plugin 'mapper-attachments' do
url 'http://some.domain.name//my-plugin-1.0.0.zip'
@@ -347,6 +302,7 @@ end
The plugin resource respects the `https_proxy` or `http_proxy` (non-SSL)
[Chef settings](https://docs.chef.io/config_rb_client.html) unless explicitly
disabled using `chef_proxy false`:
```ruby
elasticsearch_plugin 'kopf' do
url 'lmenezes/elasticsearch-kopf'
@@ -377,6 +333,7 @@ end
## License
```text
This software is licensed under the Apache 2 license, quoted below.
Copyright (c) 2015 Elasticsearch <https://www.elastic.co/>
@@ -392,3 +349,4 @@ This software is licensed under the Apache 2 license, quoted below.
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```