Explain what the ES rollover initializer does by yurishkuro · Pull Request #1109 · jaegertracing/documentation

yurishkuro · 2026-06-18T21:12:48Z

Summary

Document the specific steps performed by jaeger-es-rollover init: creating index templates, seed indices, and read/write aliases.
Explain what changes with ILM enabled: policy validation, lifecycle settings embedded in templates, and is_write_index flag on write aliases.
Clarify that ILM removes the need for the rollover and lookback cron jobs.

Test plan

Verify the docs render correctly with Hugo

🤖 Generated with Claude Code

Document the specific steps performed by `jaeger-es-rollover init`: creating index templates, seed indices, and read/write aliases. Also explain ILM-specific behavior (policy validation, lifecycle settings in templates, is_write_index flag on aliases). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot

Pull request overview

This PR enhances the Elasticsearch storage documentation by explicitly describing what jaeger-es-rollover init does during rollover initialization, and how that behavior changes (and simplifies operations) when ILM is enabled.

Changes:

Expands the “Initialize” section with a concrete, step-by-step description of templates, seed indices, and read/write aliases.
Adds an ILM-focused explanation of additional initializer behavior (policy validation, lifecycle settings, write-alias requirements).
Clarifies operational impact of ILM vs. the manual rollover workflow.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Add a high-level comparison table of the three index management strategies (daily indices, rollover, rollover with ILM) and a config options matrix showing use_aliases, use_ilm, and create_mappings with their interactions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

The date_layout config allows hourly (or other) index granularity, not just daily. Add date_layout to the config matrix. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Strategies as columns, concerns as rows. Mention daily/hourly in the time-based column. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

It requires running a cron job, making it a manual process compared to ILM-managed rollover. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Mention the actor (Jaeger, operator/cron, Elasticsearch) for each index management strategy. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Elasticsearch creates subsequent indices, not the cron job. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

- Fix table separator to use 3+ hyphens for compatibility - Add comma after introductory clause on line 97 - Mention index-cleaner is also unnecessary with ILM Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

ILM is simpler than manual rollover, not more complex. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

- Remove "two" from "two cron jobs" (lookback is optional) - Mark lookback as (optional) in strategy table - Use full dotted path index.lifecycle.* for clarity Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Both Jaeger and jaeger-es-rollover use the same MappingBuilder code. The restriction exists because init already creates templates as part of index initialization, not because Jaeger cannot produce ILM-aware templates. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings June 18, 2026 21:12

Copilot started reviewing on behalf of yurishkuro June 18, 2026 21:13 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread content/docs/v2/_dev/storage/elasticsearch.md Outdated

Comment thread content/docs/v2/_dev/storage/elasticsearch.md Outdated

yurishkuro and others added 2 commits June 18, 2026 17:20

Rename 'Daily indices' to 'Time-based indices'

726df85

The date_layout config allows hourly (or other) index granularity, not just daily. Add date_layout to the config matrix. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot AI review requested due to automatic review settings June 18, 2026 21:21

Copilot started reviewing on behalf of yurishkuro June 18, 2026 21:21 View session

yurishkuro and others added 4 commits June 18, 2026 17:22

Transpose strategy comparison table

c5f51d9

Strategies as columns, concerns as rows. Mention daily/hourly in the time-based column. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Rename 'Rollover' to 'Manual rollover' in strategy table

88b0116

It requires running a cron job, making it a manual process compared to ILM-managed rollover. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Clarify who creates indices in each strategy

bc4a617

Mention the actor (Jaeger, operator/cron, Elasticsearch) for each index management strategy. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Fix ILM column: only initial index is same as manual rollover

aafc06f

Elasticsearch creates subsequent indices, not the cron job. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread content/docs/v2/_dev/storage/elasticsearch.md Outdated

Mark 'Rollover with ILM' as recommended strategy

2b5b6b2

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot AI review requested due to automatic review settings June 18, 2026 21:25

Copilot started reviewing on behalf of yurishkuro June 18, 2026 21:26 View session

yurishkuro and others added 2 commits June 18, 2026 17:26

Add 'Relevant strategy' column to config options table

c8210c4

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Use explicit tool name instead of 'the initializer'

d75ca64

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread content/docs/v2/_dev/storage/elasticsearch.md Outdated

Update ILM cross-reference wording

6fb9023

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot AI review requested due to automatic review settings June 18, 2026 21:30

Copilot started reviewing on behalf of yurishkuro June 18, 2026 21:31 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread content/docs/v2/_dev/storage/elasticsearch.md Outdated

yurishkuro and others added 2 commits June 18, 2026 17:32

Fix wording: 'rollover initializer' not 'elasticsearch initializer'

42be55e

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Address PR review comments

71d5dba

- Fix table separator to use 3+ hyphens for compatibility - Add comma after introductory clause on line 97 - Mention index-cleaner is also unnecessary with ILM Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot AI review requested due to automatic review settings June 18, 2026 21:34

Copilot started reviewing on behalf of yurishkuro June 18, 2026 21:35 View session

Apply same docs improvements to v2.19

77c3c77

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread content/docs/v2/_dev/storage/elasticsearch.md Outdated

Remove misleading 'increasing complexity' claim

51e1a0a

ILM is simpler than manual rollover, not more complex. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <github@ysh.us>

Copilot AI review requested due to automatic review settings June 18, 2026 21:37

Copilot started reviewing on behalf of yurishkuro June 18, 2026 21:38 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread content/docs/v2/2.19/storage/elasticsearch.md

Comment thread content/docs/v2/2.19/storage/elasticsearch.md

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

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

yurishkuro and others added 2 commits June 18, 2026 17:42

Copilot AI review requested due to automatic review settings June 18, 2026 21:49

Copilot started reviewing on behalf of yurishkuro June 18, 2026 21:50 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

yurishkuro merged commit f1c920b into jaegertracing:main Jun 18, 2026
8 checks passed

yurishkuro deleted the explain-es-initializer branch June 18, 2026 22:01

Uh oh!

Conversation

yurishkuro commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

yurishkuro commented Jun 18, 2026 •

edited

Loading