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] Improve input template API yaml comments #199168

Merged
merged 4 commits into from
Nov 6, 2024

Conversation

nchaulet
Copy link
Member

@nchaulet nchaulet commented Nov 6, 2024

Summary

Related to https://github.com/elastic/observability-dev/issues/3200
Replace #199135

Improve the yaml we generate for input template, previously we introduced placeholder variables to include variables without default in the generated YAML. To make that yaml valid for agents we will now comment the lines where we introduced placeholder.

For example for system and redis integration the template looks like this now:

Screenshot 2024-11-06 at 10 46 17 AM

image

Do we want to backport this to 8.16.0 ?

@nchaulet nchaulet added release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.16.0 labels Nov 6, 2024
@nchaulet nchaulet requested a review from flash1293 November 6, 2024 16:06
@nchaulet nchaulet self-assigned this Nov 6, 2024
@nchaulet nchaulet requested a review from a team as a code owner November 6, 2024 16:06
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@flash1293 flash1293 added the ci:project-deploy-observability Create an Observability project label Nov 6, 2024
Copy link
Contributor

github-actions bot commented Nov 6, 2024

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@flash1293
Copy link
Contributor

/oblt-deploy

@flash1293
Copy link
Contributor

Do we want to backport this to 8.16.0 ?

I don't think the original PR made it into 8.16

@nchaulet nchaulet added v8.16.0 and removed v8.16.0 labels Nov 6, 2024
@nchaulet
Copy link
Member Author

nchaulet commented Nov 6, 2024

@flash1293 it seems it is in 8.16.0 the code is present in the 8.16 branch

@flash1293
Copy link
Contributor

@nchaulet Then we should definitely backport to 8.16

The last BC will be cut tomorrow, let's make sure to get it in today

Copy link
Contributor

@flash1293 flash1293 left a comment

Choose a reason for hiding this comment

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

Checked the output and everything looks good to me, waiting for the test deployment to do a proper e2e test on serverless

Copy link
Member

@kpollich kpollich left a comment

Choose a reason for hiding this comment

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

Makes sense to me. I think having the second comment character should make it relatively easy to uncomment via editor shortcuts while still maintaining the description.

@nchaulet
Copy link
Member Author

nchaulet commented Nov 6, 2024

@elasticmachine merge upstream

@nchaulet nchaulet enabled auto-merge (squash) November 6, 2024 20:37
@elasticmachine
Copy link
Contributor

⏳ Build in-progress

  • Buildkite Build
  • Commit: 6873bc6
  • Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-199168-6873bc6624e9

History

cc @nchaulet

@nchaulet nchaulet merged commit 8041372 into elastic:main Nov 6, 2024
26 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.16, 8.x

https://github.com/elastic/kibana/actions/runs/11712595475

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Nov 6, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Nov 6, 2024
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.16
8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Nov 7, 2024
…99238)

# Backport

This will backport the following commits from `main` to `8.16`:
- [[Fleet] Improve input template API yaml comments
(#199168)](#199168)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Nicolas
Chaulet","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-06T22:01:19Z","message":"[Fleet]
Improve input template API yaml comments
(#199168)","sha":"8041372868f732530d7fecf1c44fad1f61b631fc","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","v9.0.0","backport:prev-minor","ci:project-deploy-observability","v8.16.0","v8.17.0"],"title":"[Fleet]
Improve input template API yaml
comments","number":199168,"url":"https://github.com/elastic/kibana/pull/199168","mergeCommit":{"message":"[Fleet]
Improve input template API yaml comments
(#199168)","sha":"8041372868f732530d7fecf1c44fad1f61b631fc"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199168","number":199168,"mergeCommit":{"message":"[Fleet]
Improve input template API yaml comments
(#199168)","sha":"8041372868f732530d7fecf1c44fad1f61b631fc"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: Nicolas Chaulet <[email protected]>
Co-authored-by: Joe Reuter <[email protected]>
kibanamachine added a commit that referenced this pull request Nov 7, 2024
…9239)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Fleet] Improve input template API yaml comments
(#199168)](#199168)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Nicolas
Chaulet","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-06T22:01:19Z","message":"[Fleet]
Improve input template API yaml comments
(#199168)","sha":"8041372868f732530d7fecf1c44fad1f61b631fc","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","v9.0.0","backport:prev-minor","ci:project-deploy-observability","v8.16.0","v8.17.0"],"title":"[Fleet]
Improve input template API yaml
comments","number":199168,"url":"https://github.com/elastic/kibana/pull/199168","mergeCommit":{"message":"[Fleet]
Improve input template API yaml comments
(#199168)","sha":"8041372868f732530d7fecf1c44fad1f61b631fc"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199168","number":199168,"mergeCommit":{"message":"[Fleet]
Improve input template API yaml comments
(#199168)","sha":"8041372868f732530d7fecf1c44fad1f61b631fc"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: Nicolas Chaulet <[email protected]>
mgadewoll pushed a commit to mgadewoll/kibana that referenced this pull request Nov 7, 2024
@nchaulet nchaulet deleted the fix-input-template-yaml-comments branch November 7, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v8.16.0 v8.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants