Skip to content

Add short Node Monitoring page to website #223

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.

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
merged 1 commit into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 0 deletions site/_data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ side:
url: /arch-controller/
- title: Fault Tolerance
url: /arch-fault-tolerance/
- title: Node Monitoring
url: /arch-node-monitoring/
28 changes: 28 additions & 0 deletions site/_pages/arch-node-monitoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
permalink: /arch-node-monitoring/
title: "Node Monitoring"
classes: wide
---

The AppWrapper controller can optionally monitor Kubernetes Nodes and
dynamically adjust the `lendingLimits` on a designated `ClusterQueue`
to account for dynamically unavailable resources. This capability is
designed to enable cluster admins of an
[MLBatch cluster](https://github.com/project-codeflare/mlbatch) to fully
automate the small scale quota adjustments required to maintain full cluster
utilization in the presence of isolated node failures and/or
minor maintenance activities. The monitoring detects both Nodes that
are marked as `Unscheduable` via standard Kubernetes mechanisms and Nodes
that have resources that Autopilot has flagged as unhealthy (see [Fault Tolerance](/arch-fault-tolerance)).
The `lendingLimit` of a designated slack capacity `ClusterQueue` is
automatically adjusted to reflect the current dynamically unavailable resources.

Node monitoring is enabled by the following additional configuration:
```yaml
slackQueueName: "slack-queue"
autopilot:
monitorNodes: true
```

See [node_health_monitor.go]({{ site.gh_main_url }}/internal/controller/appwrapper/node_health_monitor.go)
for the implementation.
2 changes: 1 addition & 1 deletion site/_pages/dev-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ classes: wide

### Prerequisites

You'll need `go` v1.22.0+ installed on your development machine.
You'll need `go` v1.22.4+ installed on your development machine.

You'll need a container runtime and cli (eg `docker` or `rancher-desktop`).

Expand Down