Skip to content

Commit 52ffaa1

Browse files
author
Antoine Verin
committed
precise documentation
1 parent 78885f4 commit 52ffaa1

2 files changed

Lines changed: 9 additions & 2 deletions

File tree

website/docs/index.html.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ description: |-
88

99
# ElkAliases Provider
1010

11-
The ElkAliases provider gives the ability to deploy index template to a ElasticSearch server
11+
The ElkAliases provider gives the ability to add aliases to index and data-stream to a ElasticSearch server
12+
13+
With the current provider from elasticstack, the only place where it is possible to declare aliases is in the index template creation.
14+
This approach doesn't allow us to add aliases to indexes that are already created, since the template is used only at the creation of a new index and doesn't apply to already existing ones.
15+
To solve this problem, we have created this provider, which enables you through the `elkaliases_index_aliases` resource to add aliases to existing indices.
1216

1317
Use the navigation to the left to read about the available resources.
1418

website/docs/r/elkaliases_index_aliases.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ description: |-
88

99
# alkaliases\_index
1010

11-
The ``elkaliases_index_aliases`` resource creates aliases in an index
11+
The ``elkaliases_index_aliases`` resource creates aliases in an existing index.
12+
13+
14+
~> **Note**: The index needs to already exist at deployment time. This means that you cannot create an index template and apply aliases to it directly. You need to create an index or data stream first.
1215

1316
## Usage
1417

0 commit comments

Comments
 (0)