Skip to content

Commit c8342dd

Browse files
committed
Add mandatory requirements to docs
1 parent 4b2e54c commit c8342dd

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
![Test ElasticStack](https://github.com/NETWAYS/ansible-collection-elasticstack/actions/workflows/test_full_stack.yml/badge.svg)
44

55
> [!CAUTION]
6-
> This branch has some breaking changes. Be careful using it!
6+
> This branch has some breaking changes. Be careful using it! Everything after commit 3d6673f6d526afeb0fd7ba382d067d76bd10bbd6 is affected!
77
88
This collection installs and manages the Elastic Stack. It provides roles for every component of the Stack. Furthermore, it is possible to differentiate between Enterprise or OSS releases.
99

@@ -13,6 +13,9 @@ Every role is documented with all variables, please refer to the documentation f
1313

1414
## Roles documentation
1515

16+
> [!NOTE]
17+
> Some roles have fixed requirements that you must observe. Please have a look at the [requirements](docs/01-requirements.md) before using the collection. (There is a high probability that some of them will be refactored soon)
18+
1619
* [Beats](docs/role-beats.md)
1720
* [Elasticsearch](docs/role-elasticsearch.md)
1821
* [Kibana](docs/role-kibana.md)

docs/01-requirements.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Requirements
2+
3+
There are some requirements that the user have to fulfill while using the collection. Some of them will be refactored and disappear from the list soon.
4+
5+
**Inventory names**
6+
7+
The collection provides roles for several tools (elasticsearch, kibana, ...). In some tasks hosts from the specific inventory group are fetched. The group names are customizable via variables. But using different inventory names than provided inside the variables will result in errors.
8+
9+
**elasticstack_ca_host**
10+
11+
This is a mandatory variable. It is used to define the host that will be used as "CA host".

0 commit comments

Comments
 (0)