Skip to content

docs: describe the resource health add-on and its ignore rules - #1172

Open
marcelofukumoto wants to merge 12 commits into
harvester:mainfrom
marcelofukumoto:resource-health-docs
Open

marcelofukumoto wants to merge 12 commits into
harvester:mainfrom
marcelofukumoto:resource-health-docs

Conversation

@marcelofukumoto

Copy link
Copy Markdown

Problem:

v1.10 adds the experimental harvester-resource-health-controller add-on, and a Components tab on the Dashboard that shows its checks and lets you ignore them. The docs don't mention either.

Solution:

I added a Resource Health page under Advanced > Available Addons (v1.10 only) and listed the add-on on the Add-ons page. It covers:

  • Installing the manifest from the release page and enabling the add-on.
  • The Components tab: the alert icon, the rows and their checks, Filter, Expand All and Collapse All.
  • The checks the controller reports in v1.10.0, with their ComponentHealth names and severities.
  • Ignoring a check from its ⋮ menu (scope, how long, reason), Show ignored, and viewing, editing and deleting a rule, including one that has expired.
  • Ignore rules with kubectl, and the rule name the Components tab manages.
  • Two screenshots, the Components tab and the Create Ignore Rule dialog, taken on a real cluster.

Related Issue(s):

Issue harvester/harvester#9747
Issue harvester/harvester#8436

Test plan:

  1. Open the PR preview and go to Advanced > Available Addons > Resource Health in v1.10 (Dev).
  2. Check that the page renders with both images, and that the Add-ons page lists the add-on with a working link.
  3. Compare it with a v1.10 cluster that has the controller installed: open the Dashboard's Components tab, then create, edit and delete an ignore rule.

Additional documentation or context

UI change: harvester/harvester-ui-extension#1225

The add-on and its chart aren't merged yet (harvester/harvester#12056, harvester/charts#639). The manifest name follows the <name>-addon.yaml convention of the other standalone add-ons, and the list of checks comes from https://github.com/harvester/resource-health-controller at 039dabc. If the add-on doesn't make v1.10.0, the "Available as of" line needs to change.

@github-actions

github-actions Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Name Link
🔨 Latest commit cc562fd
😎 Deploy Preview https://6af2555b35c5ce91f9f135d9--harvester-preview.netlify.app

Add a page for the experimental harvester-resource-health-controller
add-on: how to install and enable it, the Components tab on the
Dashboard, the checks it reports in v1.10.0, and how to ignore a check
from the UI or with kubectl. List the add-on on the Add-ons page.

Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Comment thread docs/advanced/addons/resource-health.md Resolved
Comment thread docs/advanced/addons/resource-health.md Resolved
Comment thread docs/advanced/addons/resource-health.md Resolved
Comment thread docs/advanced/addons/resource-health.md Resolved
Comment thread docs/advanced/addons/resource-health.md Resolved
Comment thread docs/advanced/addons/resource-health.md Resolved
Comment thread docs/advanced/addons/resource-health.md Resolved
Comment thread docs/advanced/addons/resource-health.md Resolved
Comment thread docs/advanced/addons/resource-health.md Resolved
Comment thread docs/advanced/addons/resource-health.md Resolved
marcelofukumoto and others added 11 commits November 10, 2026 00:12
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>
Co-authored-by: Sushant Gaurav <sushant.gaurav@suse.com>
Signed-off-by: Marcelo Fukumoto <marcelo.fukumoto@suse.com>

This branch has not been deployed

No deployments
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.

2 participants