Skip to content

Conversation

@kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Mar 23, 2025

This pull request updates the Rolling Restart and Update Redpanda pages to include new Admin API endpoints. Related Admin API Reference update: #1019

Documentation updates:

Description

Resolves https://redpandadata.atlassian.net/browse/
Review deadline: 27 March

Page previews

What's New
Perform a Rolling Restart
Upgrade Redpanda in Linux

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@kbatuigas kbatuigas requested a review from a team as a code owner March 23, 2025 21:41
@hyperlint-ai-deprecated
Copy link
Contributor

PR Change Summary

Updated the Rolling Restart and Update Redpanda documentation to include new Admin API endpoints for health probes.

  • Added new health probes for broker restarts and upgrades to the What's New page.
  • Included example usage for the pre_restart_probe endpoint in the maintenance mode documentation.
  • Added example usage for the post_restart_probe endpoint in the post-upgrade tasks documentation.

Modified Files

  • modules/get-started/pages/whats-new.adoc
  • modules/upgrade/partials/rolling-upgrades/enable-maintenance-mode.adoc
  • modules/upgrade/partials/rolling-upgrades/post-upgrade-tasks.adoc

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@netlify
Copy link

netlify bot commented Mar 23, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 869fe46
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67e080180de7be0008bb8e0d
😎 Deploy Preview https://deploy-preview-1026--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kbatuigas kbatuigas requested a review from mattschumpert March 24, 2025 14:19
----
// Returns the load already reclaimed by broker, as a percentage of in-sync replicas
{
"load_reclaimed_pc": 66

Choose a reason for hiding this comment

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

This is really nice @bashtanov ! Seems this will help a lot in building a smoother automated restart/upgrade automation @chrisseto @mmaslankaprv

== New health probes for broker restarts and upgrades

The Redpanda Admin API now includes new health probes to help you ensure safe broker restarts and upgrades. The xref:api:ROOT:admin-api.adoc#get-/v1/broker/pre_restart_probe[`pre_restart_probe`] endpoint identifies potential risks if a broker is restarted, and xref:api:ROOT:admin-api.adoc#get-/v1/broker/post_restart_probe[`post_restart_probe`] indicates how much of its workloads a broker has reclaimed after the restart. See also:
Copy link
Contributor

Choose a reason for hiding this comment

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

@kbatuigas please check these links. Is the API just not updated yet?

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

lgtm

@kbatuigas kbatuigas merged commit f257d8a into beta Apr 1, 2025
11 checks passed
@kbatuigas kbatuigas deleted the DOC-931-Document-feature-25.1-Rolling-Restart-Health-API-endpoints-for-Readiness-Probes branch April 1, 2025 13:29
JakeSCahill pushed a commit that referenced this pull request Apr 6, 2025
JakeSCahill pushed a commit that referenced this pull request Apr 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants