[DOCS] Logstash configuration management APIs#214497
Conversation
💚 Build Succeeded
Metrics [docs]
History
|
|
cc:/ @robbavey |
There was a problem hiding this comment.
API list, restful methods and descriptions are super.
One of my concerns, is to clarify if this feature is still under tech preview (at least I am not aware of).- Interaction with CPM APIs require user to have either
logstash_adminorlogstash_writerrole. 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. |
|
Starting backport for target branches: 8.18, 8.x, 9.0 https://github.com/elastic/kibana/actions/runs/13916386405 |
(cherry picked from commit ab0776e)
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
(cherry picked from commit ab0776e)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
(cherry picked from commit ab0776e)
# 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>
|
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. |
# 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-->
# 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-->
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
Checklist
Check the PR satisfies following conditions.
Reviewers should verify this PR satisfies this list as well.
release_note:breakinglabel should be applied in these situations.release_note:*label is applied per the guidelinesIdentify 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.