ansible-role-elasticsearch/README.md

115 lines
3 KiB
Markdown
Raw Normal View History

2019-09-05 13:48:41 +00:00
# Ansible role: Elasticsearch
2024-05-07 12:18:18 +00:00
[![Version](https://img.shields.io/badge/latest_version-1.1.0-green.svg)](https://code.waks.be/nishiki/ansible-role-elasticsearch/releases)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://code.waks.be/nishiki/ansible-role-elasticsearch/src/branch/main/LICENSE)
2019-09-05 13:48:41 +00:00
Install and configure Elasticsearch
## Requirements
2024-05-07 12:18:18 +00:00
- Ansible >= 2.9
- Debian
- Bookworm
2019-09-05 13:48:41 +00:00
## Role variables
2024-05-07 12:18:18 +00:00
- `elasticsearch_major_version` - set the major version (default: `7`)
- `elasticsearch_master` - set if the node is master (default: `true`)
- `elasticsearch_heap_size` - set the heap size (default: `1g`)
- `elasticsearch_api_user` - set the admin user (default: `elastic`)
- `elasticsearch_api_password` - set the password for api
- `elasticsearch_config` - hash with the configuration (see [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html))
2019-09-05 13:48:41 +00:00
2023-11-16 15:05:55 +00:00
```yaml
2024-05-07 12:18:18 +00:00
path.data: /var/lib/elasticsearch
path.logs: /var/log/elasticsearch
2019-09-05 13:48:41 +00:00
```
2024-05-07 12:18:18 +00:00
- `elasticsearch_ssl_key`: - string contain ssl private key if `xpack.security.transport.ssl.key` is defined in elasticsearch_config
- `elasticsearch_ssl_certificate`: - string contain ssl certificate if `xpack.security.transport.certificate.key` is defined in elasticsearch_config
- `elasticsearch_roles` - hash with the roles to managed
2023-11-16 15:05:55 +00:00
```yaml
2024-05-07 12:18:18 +00:00
myrole:
cluster:
- all
indices:
- names: ["logstash*"]
privileges:
- create
- write
2023-11-16 15:05:55 +00:00
```
2024-05-07 12:18:18 +00:00
- `elasticsearch_users` - hash with the users to managed
2023-10-17 07:47:10 +00:00
```yaml
2024-05-07 12:18:18 +00:00
toto:
password: supers3cret
roles:
- viewer
kibana_system:
password: supertest2
2023-10-17 07:47:10 +00:00
```
2024-05-07 12:18:18 +00:00
- `elasticsearch_index_templates` - hash with the index templates configuration
2019-11-21 12:15:34 +00:00
2023-11-16 15:05:55 +00:00
```yaml
2024-05-07 12:18:18 +00:00
logstash:
index_patterns:
- "logstash-*"
settings:
index:
number_of_replicas: 3
mappings:
metric:
type: short
date:
type: date
format: YYYY-MM-dd
2019-11-21 12:15:34 +00:00
```
2024-05-07 12:18:18 +00:00
- `elasticsearch_ilm_policies` - hash with the ilm policies configuration
2022-02-17 09:52:15 +00:00
2023-11-16 15:05:55 +00:00
```yaml
2024-05-07 12:18:18 +00:00
autoclean:
delete:
min_age: 30d
actions:
delete: {}
2022-02-17 09:52:15 +00:00
```
2019-09-05 13:48:41 +00:00
## How to use
```
- hosts: server
roles:
- elasticsearch
```
## Development
2020-02-29 22:35:57 +00:00
### Test with molecule and docker
2019-09-05 13:48:41 +00:00
2024-05-07 12:18:18 +00:00
- install [docker](https://docs.docker.com/engine/installation/)
- install `python3` and `python3-pip`
- install molecule and dependencies `pip3 install molecule 'molecule[docker]' ansible-lint testinfra yamllint`
- run `molecule test`
2019-09-05 13:48:41 +00:00
## License
```
Copyright (c) 2019 Adrien Waksberg
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
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.
```