Skip to content

Commit 1d4598c

Browse files
chore(docs): clarify ES rollover standalone binaries and ILM workflow (#1068)
## Which problem is this PR solving? Addresses jaegertracing/jaeger#7994 The Elasticsearch storage documentation currently shows Docker-based examples for `jaeger-es-rollover` and `jaeger-es-index-cleaner`, which may imply that Docker is required. Additionally, it may not be clear that ILM is an alternative to the manual rollover + lookback + index-cleaner workflow. ## Description of the changes This PR: 1. Adds a clarification that `jaeger-es-rollover` and `jaeger-es-index-cleaner` are available as standalone binaries on the GitHub releases page and are not limited to Docker usage. 2. Clarifies in the ILM section that ILM is an alternative to the manual rollover workflow, rather than an additional step. ## How was this change tested? Documentation-only change. Verified formatting locally and ensured Hugo shortcodes remain intact. ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/main/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] No code changes (documentation only) - [x] Formatting verified ## AI Usage in this PR See [AI Usage Policy](https://github.com/jaegertracing/jaeger/blob/main/CONTRIBUTING_GUIDELINES.md#ai-usage-policy). - [ ] **None**: No AI tools were used in creating this PR - [x] **Light**: AI provided minor assistance (wording and formatting suggestions) - [ ] **Moderate**: AI helped with code generation or debugging specific parts - [ ] **Heavy**: AI generated most or all of the code changes --------- Signed-off-by: Omkar ugalmugle <155310707+Omkar-Ugal@users.noreply.github.com> Signed-off-by: Yuri Shkuro <github@ysh.us> Co-authored-by: Yuri Shkuro <github@ysh.us>
1 parent fa2e147 commit 1d4598c

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

content/docs/v2/_dev/storage/elasticsearch.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ To learn more about rollover index management in Jaeger refer to this
4646

4747
For automated rollover, please refer to [Elasticsearch ILM support](#ilm-support).
4848

49+
{{< info >}}
50+
The examples for `jaeger-es-rollover` and `jaeger-es-index-cleaner` tools below are shown using
51+
Docker invocations, but they are also available as standalone binaries on the
52+
[Jaeger GitHub releases page](https://github.com/jaegertracing/jaeger/releases).
53+
{{< /info >}}
54+
4955
### Initialize
5056

5157
The following command prepares Elasticsearch for rollover deployment by creating index aliases, indices, and index templates:
@@ -102,6 +108,11 @@ docker run -it --rm --net=host \
102108

103109
[Elasticsearch ILM](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html) automatically manages indices according to performance, resiliency, and retention requirements.
104110

111+
ILM support is an alternative to the manual rollover + lookback +
112+
index-cleaner workflow described above. When ILM is enabled,
113+
Elasticsearch manages rollover and retention automatically
114+
according to the configured policy.
115+
105116
For example:
106117
* Rollover to a new index by size (bytes or number of documents) or age, archiving previous indices
107118
* Delete stale indices to enforce data retention standards

0 commit comments

Comments
 (0)