Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Data Streams: Add ecs@mappings disclaimer for index templates cloned on ES < 8.13 #1174

Merged
merged 4 commits into from
Jul 17, 2024

Conversation

zmoog
Copy link
Contributor

@zmoog zmoog commented Jul 16, 2024

Motivation

Starting from version 8.13, Elasticsearch includes the ecs@mappings component templates in all the index templates used in Elastic Agent integrations.

As integrations adopt the ecs@mappings component template, index templates cloned following the "Tutorial: Customize data retention policies" may start having problems with mappings.

End users must update their cloned index templates by adding the ecs@mappings component template.

Change description

This PR added a note and instructions to the tutorial users about updating the cloned index template they created following this tutorial.

Additional Notes

Reviewer checklist

  • PR address a single concern.
  • PR title and description are appropriately filled.
  • Changes will be merged in main.

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link

mergify bot commented Jul 16, 2024

This pull request does not have a backport label. Could you fix it @zmoog? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@zmoog
Copy link
Contributor Author

zmoog commented Jul 16, 2024

@lucabelluccini @ishleenk17, I'm updating the original tutorial with instructions to update the cloned index templates.

@zmoog zmoog self-assigned this Jul 16, 2024
@mergify mergify bot removed the backport-skip label Jul 16, 2024
@zmoog zmoog marked this pull request as ready for review July 16, 2024 13:58
@zmoog zmoog requested a review from a team as a code owner July 16, 2024 13:58
@zmoog zmoog changed the title Add ecs@mappings disclaimer for index templates cloned < 8.13 Data Streams: Add ecs@mappings disclaimer for index templates cloned on ES < 8.13 Jul 16, 2024
kilfoyle
kilfoyle previously approved these changes Jul 16, 2024
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks a lot for adding this @zmoog!

@lucabelluccini
Copy link
Contributor

Thank you @zmoog for the docs update!

BTW, this is somehow a breaking change for such users.
I would really invite integration development team & ingest/fleet on how to tackle this in the future automatically.

This is something Platform Ingest (or even further to Elasticsearch) should help to overcome.

@zmoog
Copy link
Contributor Author

zmoog commented Jul 17, 2024

Only those with write access to this repository can merge pull requests.

Is seems I can't merge the PR 😇

@kilfoyle
Copy link
Contributor

Is seems I can't merge the PR 😇

Oops! I forgot about that. I'll merge and make sure the backports are merged too.

@kilfoyle kilfoyle merged commit 9ed0623 into elastic:main Jul 17, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Jul 17, 2024
…on ES < 8.13 (#1174)

* Add disclaimer for index templates cloned < 8.13

* Suggest a roll over to apply the changes

* Minor edits

* Apple review suggestions

(cherry picked from commit 9ed0623)
mergify bot pushed a commit that referenced this pull request Jul 17, 2024
…on ES < 8.13 (#1174)

* Add disclaimer for index templates cloned < 8.13

* Suggest a roll over to apply the changes

* Minor edits

* Apple review suggestions

(cherry picked from commit 9ed0623)
kilfoyle pushed a commit that referenced this pull request Jul 17, 2024
…on ES < 8.13 (#1174) (#1178)

* Add disclaimer for index templates cloned < 8.13

* Suggest a roll over to apply the changes

* Minor edits

* Apple review suggestions

(cherry picked from commit 9ed0623)

Co-authored-by: Maurizio Branca <[email protected]>
kilfoyle pushed a commit that referenced this pull request Jul 17, 2024
…on ES < 8.13 (#1174) (#1179)

* Add disclaimer for index templates cloned < 8.13

* Suggest a roll over to apply the changes

* Minor edits

* Apple review suggestions

(cherry picked from commit 9ed0623)

Co-authored-by: Maurizio Branca <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants