Skip to content

Commit 4015c3c

Browse files
Add precisions to documentation (#16)
Co-authored-by: Bertrand Paquet <[email protected]>
1 parent 78885f4 commit 4015c3c

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

website/docs/index.html.markdown

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@ 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 on indexes, created by an [index templates](https://registry.terraform.io/providers/elastic/elasticstack/latest/docs/resources/elasticsearch_index_template).
12+
13+
With the current provider from elasticstack, there is no solution to [add aliases to an existing index](https://github.com/elastic/terraform-provider-elasticstack/issues/285).
14+
To solve this problem, we have created this provider, which enables you through the `elkaliases_index_aliases` resource to add aliases to existing index or data stream.
15+
If you use this provider, you should not declare `alias` with `elasticstack_elasticsearch_index_template` resource.
16+
17+
This provider is a workaround, waiting for a long term solution in [the official provider](https://registry.terraform.io/providers/elastic/elasticstack/latest).
1218

1319
Use the navigation to the left to read about the available resources.
1420

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)