Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 2 additions & 25 deletions docs/role-elasticsearch.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,5 @@
# Elasticsearch role

Installs and configures Elasticsearch, optionally with X-Pack security — a
self-signed CA and certificates that the other Elastic Stack roles reuse.
The Elasticsearch role documentation now lives with the role itself:

The role's own variables are documented in its README:

**→ [roles/elasticsearch/README.md](../roles/elasticsearch/README.md)**

## Shared variables

These `elasticstack_*` variables are shared across all Elastic Stack roles in
this collection (hence the common naming). Set them once and every role uses
them.

* *elasticstack_ca_host*: Inventory hostname of the host that holds the CA for the stack certificates. (default: first node in the `elasticsearch` group)
* *elasticstack_ca_name*: Distinguished name of the CA. (default: `CN=Elastic Certificate Tool Autogenerated CA`)
* *elasticstack_ca_pass*: Password protecting the CA. (default: `PleaseChangeMe`)
* *elasticstack_ca_validity_period*: Number of days the generated CA is valid. (default: `1095`)
* *elasticstack_ca_expiration_buffer*: Renew the CA when its remaining validity (in days) drops below this value. (default: `30`)
* *elasticstack_ca_will_expire_soon*: Set to `true` to force renewal of the CA and all component certificates. Alternatively run the playbook with the `renew_ca` tag. (default: `false`)
* *elasticstack_release*: Major release of the Elastic Stack to configure. (default: `8`)
* *elasticstack_variant*: Stack variant to install. Valid values: `elastic` or `oss`. (default: `elastic`)
* *elasticstack_elasticsearch_http_port*: Elasticsearch HTTP port. (default: `9200`)

> **Note:** these shared variables are documented here for now; they will move to
> a dedicated central page together with the elasticstack role
> (see [#475](https://github.com/NETWAYS/ansible-collection-elasticstack/issues/475)).
**➜ [roles/elasticsearch/README.md](../roles/elasticsearch/README.md)**
2 changes: 1 addition & 1 deletion roles/beats/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ This role also uses the collection-wide `elasticstack_*` variables (e.g.
`elasticstack_full_stack`, `elasticstack_variant`, `elasticstack_ca_host`,
`elasticstack_ca_pass`, `elasticstack_release`, `elasticstack_version`,
`elasticstack_elasticsearch_http_port`, `elasticstack_beats_port`). They are
documented centrally with the [elasticsearch role](../../docs/role-elasticsearch.md).
documented centrally with the [elasticstack role](../elasticstack/README.md).
2 changes: 1 addition & 1 deletion roles/elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,4 @@ This role also uses the collection-wide `elasticstack_*` variables (e.g.
`elasticstack_ca_host`, `elasticstack_ca_pass`, `elasticstack_ca_dir`,
`elasticstack_elasticsearch_http_port`, `elasticstack_initial_passwords`). They
are documented centrally with the
[elasticstack role](../../docs/role-elasticsearch.md).
[elasticstack role](../elasticstack/README.md).
2 changes: 1 addition & 1 deletion roles/kibana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ This role also uses the collection-wide `elasticstack_*` variables (e.g.
`elasticstack_full_stack`, `elasticstack_variant`, `elasticstack_release`,
`elasticstack_ca_host`, `elasticstack_ca_pass`, `elasticstack_kibana_host`,
`elasticstack_kibana_port`, `elasticstack_elasticsearch_http_port`). They are
documented centrally with the [elasticsearch role](../../docs/role-elasticsearch.md).
documented centrally with the [elasticstack role](../elasticstack/README.md).
2 changes: 1 addition & 1 deletion roles/logstash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,4 +136,4 @@ Run only parts of the role with `--tags`:
This role also uses the collection-wide `elasticstack_*` variables (e.g.
`elasticstack_full_stack`, `elasticstack_ca_host`, `elasticstack_ca_pass`,
`elasticstack_release`, `elasticstack_variant`). They are documented centrally
with the [elasticstack role](../../docs/role-elasticsearch.md).
with the [elasticstack role](../elasticstack/README.md).
2 changes: 1 addition & 1 deletion roles/repos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ This role is configured through the collection-wide `elasticstack_*` variables
mainly `elasticstack_release`, `elasticstack_variant`, `elasticstack_enable_repos`,
`elasticstack_repo_url`, `elasticstack_repo_key` and `elasticstack_rpm_workaround`.
They are documented centrally with the
[elasticsearch role](../../docs/role-elasticsearch.md).
[elasticstack role](../elasticstack/README.md).
Loading