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

[Fleet] Revert custom ILM policy documentation #119013

Closed
hop-dev opened this issue Nov 18, 2021 · 4 comments
Closed

[Fleet] Revert custom ILM policy documentation #119013

hop-dev opened this issue Nov 18, 2021 · 4 comments
Assignees
Labels
bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team v7.16.0 v8.0.0 v8.1.0

Comments

@hop-dev
Copy link
Contributor

hop-dev commented Nov 18, 2021

As part of elastic/observability-docs#986 we documented how customers could apply a custom ILM policy to integration data streams by duplicating the data streams' index template and applying a higher priority. The documentation is here.

We have realised that the documentation is based on the false assumption that mappings are applied through @mapping component templates, when in fact they are set on the index template itself. This means that if a user followed the guide, then the new index template they create would not receive mapping updates when integrations are updated.

In the short term I think we need to revert this documentation and remove the UI link from 7.16 while we look at our options (Issue for adding the link #108554)

The APM team also used this document as a base for elastic/apm-server#6553 so this will need amending as well.

@hop-dev hop-dev added bug Fixes for quality problems that affect the customer experience v8.0.0 Team:Fleet Team label for Observability Data Collection Fleet team v7.16.0 v8.1.0 labels Nov 18, 2021
@hop-dev hop-dev self-assigned this Nov 18, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@joshdover
Copy link
Contributor

+1 on this decision. It also seems the behavior differs from stream-to-stream. Some streams do have a @mappings template that only contains { "dynamic" : false } while others do not have one at all. Curious if there's a good reason for this @jen-huang @ruflin. I think the best behavior would be to always put everything in the @mappings component templates so that every stream is configured the same way.

@nchaulet
Copy link
Member

nchaulet commented Nov 18, 2021

@hop-dev I am wondering if you tested to use the *@custom component template to specify the ILM policy this way you would not have to duplicate the index template

Edit: I just saw the whole discussion here elastic/observability-docs#986

@jen-huang
Copy link
Contributor

jen-huang commented Nov 18, 2021

Some streams do have a @mappings template that only contains { "dynamic" : false } while others do not have one at all. Curious if there's a good reason for this @jen-huang @ruflin.

@mappings was added with the intention to support package authors defining some some custom mapping settings on their data streams:

if (registryElasticsearch && registryElasticsearch['index_template.mappings']) {

APM is an example of a package that has various values for dynamic in their data streams: https://github.com/elastic/package-storage/tree/production/packages/apm/0.4.0/data_stream

This means that if a user followed the guide, then the new index template they create would not receive mapping updates when integrations are updated.

I think the best behavior would be to always put everything in the @mappings component templates so that every stream is configured the same way.

Yeah, when @custom was originally added, we weren't thinking that the user could have to copy the index template for each namespace (the solution we ended up going with for the docs). I agree that all the base mappings and other settings should be stored away in a component template so that they can be reused in custom index templates. We should revisit what is stored on each index template and move as much as possible to component templates:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team v7.16.0 v8.0.0 v8.1.0
Projects
None yet
Development

No branches or pull requests

5 participants