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

Add deprecation warning to Changelog and documentation for setup.template.type #28618

Merged
merged 4 commits into from
Oct 25, 2021

Conversation

kvch
Copy link
Contributor

@kvch kvch commented Oct 25, 2021

What does this PR do?

This PR adds more details to the option setup.template.type. The change is also added to the list of deprecated things in the changelog.

Why is it important?

The changes in Beats have to be documented for our users. It was missing from the original PR.

Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have made corresponding change to the default configuration files
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Oct 25, 2021
@kvch kvch requested a review from ruflin October 25, 2021 11:56
@kvch kvch changed the title Docs libbeat composable templates deprecate Add deprecation warning to Changelog and documentation for setup.template.type Oct 25, 2021
@kvch kvch added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Oct 25, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Oct 25, 2021
@elasticmachine
Copy link
Collaborator

elasticmachine commented Oct 25, 2021

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2021-10-25T12:21:14.942+0000

  • Duration: 20 min 7 sec

  • Commit: e0111e4

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

Copy link
Contributor

@ruflin ruflin left a comment

Choose a reason for hiding this comment

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

Did you already add it to the code? If yes, change LGTM.

that loads {ref}/index-templates.html[index templates].
Further options: `legacy`, {ref}/indices-templates-v1.html[legacy index templates] before Elasticsearch v7.8.
Use this to avoid breaking existing deployments.
And `component`, selecting it loads a component template which can be included in index templates.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think I'm still confused on what exactly the component template feature will do but this is not related to this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The implementation is in #28538, this is the missing docs.

Regarding the component index template, no need to worry about it because it is going to be removed in 8.0.0 :)

@kvch kvch merged commit 6d1909c into elastic:7.16 Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants