Skip to content

RUN-4081: Document Health Checks compatibility with Enterprise Runners (5.18.0+) #1759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fdevans merged 1 commit into from
Jan 17, 2026
Merged

RUN-4081: Document Health Checks compatibility with Enterprise Runners (5.18.0+) #1759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/administration/runner/runner-faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Yes, multiple runners can be configured with the same tags. At this time only on

## Does this work with Health Checks?

As of the current product version Health Checks via the Runner are not yet supported.
Yes, Health Checks are fully compatible with Enterprise Runners as of version 5.18.0. Health Checks will continue to work correctly when Runners are enabled and assigned to projects.
4 changes: 2 additions & 2 deletions docs/administration/runner/runner-plugins/runner-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,6 @@ The following plugins are available in the next generation Runners:
- vault-storage
:::

:::warning Health Checks Limitation
The Health Checks feature is not yet compatible with Enterprise Runners. If you have Enterprise Runners enabled, Health Checks will show nodes as unhealthy. This will be addressed in an upcoming release.
:::tip Health Checks with Enterprise Runners
Health Checks are fully compatible with Enterprise Runners as of version 5.18.0. Health Checks will continue to work correctly when Runners are enabled and assigned to projects.
:::
5 changes: 2 additions & 3 deletions docs/manual/healthchecks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@
Health Checks allow the ability to check the *Health Status* of Nodes periodically and on-demand.
It can show the heatlh status visually in the GUI, and use the status to filter out unhealthy nodes when running Jobs.

:::warning Limitation with Enterprise Runners
The Health Checks feature is not yet compatible with Enterprise Runners. If you have Enterprise Runners enabled, Health Checks will show nodes as unhealthy.
This will be addressed in an upcoming release
:::tip Health Checks with Enterprise Runners
Health Checks are fully compatible with Enterprise Runners as of version 5.18.0. Health Checks will continue to work correctly when Runners are enabled and assigned to projects.
:::

![Health Checks](/assets/img/healthchecks-health-status-ui.png)<br>
Expand Down
Loading