[Admin API] Add new rolling restart health endpoints #1019
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
kbatuigas
commented
Mar 19, 2025
| type: array | ||
| items: | ||
| type: string | ||
| description: ntp |
Contributor
Author
There was a problem hiding this comment.
@bashtanov we actually already have a components.schema definition for ntp: https://github.com/redpanda-data/docs/blob/api/modules/ROOT/attachments/admin-api.yaml#L4639 would it make sense to use a $ref here?
There was a problem hiding this comment.
The ntp definition linked describes an object with 3 separate key-value entries (key being ns, topic, partition), while here it is a combined string. So no, it would be incorrect to refer to this existing definition.
bashtanov
approved these changes
Mar 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request introduces new endpoints to the
admin-api.yamlfile for checking the status of brokers before and after a restart. Additionally, it defines new schemas for the results of these checks.This will accompany an update to the Rolling Restart and Upgrade Redpanda in Linux guides (PR #1026).
New endpoints:
/v1/broker/pre_restart_probeto check if it is safe to restart a broker, with an optionallimitquery parameter to limit the number of partitions listed for each risk type./v1/broker/post_restart_probeto check if a broker has recovered after a restart.New schemas:
pre_restart_check_resultschema to describe the result of a pre-restart check, including risks associated with restarting the broker.restart_risksschema to describe partitions affected by the current broker restart, grouped by risk type.post_restart_check_resultschema to describe the result of a post-restart check, which is the load reclaimed by the broker after restarting.Resolves https://redpandadata.atlassian.net/browse/
Review deadline: 21 March
Page previews
https://deploy-preview-1019--redpanda-docs-preview.netlify.app/api/admin-api/#get-/v1/broker/pre_restart_probe
https://deploy-preview-1019--redpanda-docs-preview.netlify.app/api/admin-api/#get-/v1/broker/post_restart_probe
Checks