Skip to content

[DOCS] Logstash configuration management APIs#214497

Merged
lcawl merged 4 commits intoelastic:mainfrom
lcawl:logstash-apis
Mar 18, 2025
Merged

[DOCS] Logstash configuration management APIs#214497
lcawl merged 4 commits intoelastic:mainfrom
lcawl:logstash-apis

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Mar 13, 2025

Summary

Relates to #206243

This PR includes the Logstash configuration management APIs in the OpenAPI document, since https://www.elastic.co/guide/en/kibana/current/logstash-configuration-management-api.html will not exist in the narrative V9 docs.

In the long run, ideally this information would be generated from the code but this is a stop-gap to meet the current deadlines.

Preview

image

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

@lcawl lcawl added Team:Logstash release_note:skip Skip the PR/issue when compiling release notes docs backport:version Backport to applied version labels v9.1.0 v8.19.0 v8.18.1 v9.0.1 labels Mar 13, 2025
@lcawl lcawl marked this pull request as ready for review March 14, 2025 00:20
@lcawl lcawl requested a review from a team as a code owner March 14, 2025 00:20
@lcawl lcawl requested a review from a team March 17, 2025 15:33
@elasticmachine
Copy link
Copy Markdown
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

@karenzone
Copy link
Copy Markdown
Contributor

cc:/ @robbavey

@karenzone karenzone requested a review from mashhurs March 17, 2025 22:09
Copy link
Copy Markdown
Contributor

@mashhurs mashhurs left a comment

Choose a reason for hiding this comment

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

API list, restful methods and descriptions are super.

@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Mar 18, 2025

Interaction with CPM APIs require user to have either logstash_admin or logstash_writer role. It would be nice if we can include somewhere. Or at least make the https://www.elastic.co/guide/en/logstash/current/configuring-centralized-pipelines.html link visible

I've added a sentence about the security privileges in each operation's description, as well as links to the page in the docs where it describes how to create those logstash_reader and logstash_writer roles.

Copy link
Copy Markdown
Contributor

@mashhurs mashhurs left a comment

Choose a reason for hiding this comment

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

LGTM!

@lcawl lcawl merged commit ab0776e into elastic:main Mar 18, 2025
9 checks passed
@kibanamachine
Copy link
Copy Markdown
Contributor

Starting backport for target branches: 8.18, 8.x, 9.0

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

@lcawl lcawl deleted the logstash-apis branch March 18, 2025 05:54
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Mar 18, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

💔 Some backports could not be created

Status Branch Result
8.18 Backport failed because of merge conflicts
8.x Backport failed because of merge conflicts

You might need to backport the following PRs to 8.x:
- [DOCS] Add minimal uptime APIs (#213867)
9.0

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 214497

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Mar 18, 2025
@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Mar 18, 2025

💚 All backports created successfully

Status Branch Result
8.x
8.18

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

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Mar 18, 2025
kibanamachine added a commit that referenced this pull request Mar 18, 2025
# Backport

This will backport the following commits from `main` to `9.0`:
- [[DOCS] Logstash configuration management APIs
(#214497)](#214497)

<!--- Backport version: 9.6.6 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-18T05:54:06Z","message":"[DOCS]
Logstash configuration management APIs
(#214497)","sha":"ab0776ee1e798daf4b73d34f5c369141c1a71dd7","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Logstash","release_note:skip","docs","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Logstash configuration management
APIs","number":214497,"url":"https://github.com/elastic/kibana/pull/214497","mergeCommit":{"message":"[DOCS]
Logstash configuration management APIs
(#214497)","sha":"ab0776ee1e798daf4b73d34f5c369141c1a71dd7"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214497","number":214497,"mergeCommit":{"message":"[DOCS]
Logstash configuration management APIs
(#214497)","sha":"ab0776ee1e798daf4b73d34f5c369141c1a71dd7"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 19, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

lcawl added a commit that referenced this pull request Mar 19, 2025
# Backport

This will backport the following commits from `main` to `8.18`:
- [[DOCS] Logstash configuration management APIs
(#214497)](#214497)

<!--- Backport version: 9.6.4 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-18T05:54:06Z","message":"[DOCS]
Logstash configuration management APIs
(#214497)","sha":"ab0776ee1e798daf4b73d34f5c369141c1a71dd7","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Logstash","release_note:skip","docs","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Logstash configuration management
APIs","number":214497,"url":"https://github.com/elastic/kibana/pull/214497","mergeCommit":{"message":"[DOCS]
Logstash configuration management APIs
(#214497)","sha":"ab0776ee1e798daf4b73d34f5c369141c1a71dd7"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214497","number":214497,"mergeCommit":{"message":"[DOCS]
Logstash configuration management APIs
(#214497)","sha":"ab0776ee1e798daf4b73d34f5c369141c1a71dd7"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/214895","number":214895,"state":"OPEN"}]}]
BACKPORT-->
lcawl added a commit that referenced this pull request Mar 19, 2025
# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS] Logstash configuration management APIs
(#214497)](#214497)

<!--- Backport version: 9.6.4 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-18T05:54:06Z","message":"[DOCS]
Logstash configuration management APIs
(#214497)","sha":"ab0776ee1e798daf4b73d34f5c369141c1a71dd7","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Logstash","release_note:skip","docs","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Logstash configuration management
APIs","number":214497,"url":"https://github.com/elastic/kibana/pull/214497","mergeCommit":{"message":"[DOCS]
Logstash configuration management APIs
(#214497)","sha":"ab0776ee1e798daf4b73d34f5c369141c1a71dd7"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214497","number":214497,"mergeCommit":{"message":"[DOCS]
Logstash configuration management APIs
(#214497)","sha":"ab0776ee1e798daf4b73d34f5c369141c1a71dd7"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/214895","number":214895,"state":"OPEN"}]}]
BACKPORT-->
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 19, 2025
clintandrewhall pushed a commit to clintandrewhall/kibana that referenced this pull request Mar 20, 2025
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Mar 22, 2025
cqliu1 pushed a commit to cqliu1/kibana that referenced this pull request Mar 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:Logstash v8.18.0 v8.18.1 v8.19.0 v9.0.0 v9.0.1 v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants