Skip to content

Commit

Permalink
Add note about debug webpage
Browse files Browse the repository at this point in the history
  • Loading branch information
Nuckal777 committed Mar 15, 2023
1 parent 81555f9 commit f7c70c2
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ Also transitions have to be defined.
These consist of at least of a check chain and the state, which should follow next.
Optionally, a trigger chain can be configured to perform actions, when a node moves from one state into the next one.

### Debugging
By port-forwarding to the port specified by the `metrics-addr` flag (default `8080`) of the currently active maintenance-controller one can access a webview on `/`, which shows details about the state the maintenance-controller has.
It provides an overview about how many nodes are in a certain state regarding a certain profile.
Also, individual check chain evaluations can be checked.

### Format
There is a global configuration, which defines some general options, plugin instances and maintenance profiles.
The global configuration should be named `./config/maintenance.yaml` and should be placed relative to the controllers working directory preferably via a Kubernetes secret or a config map.
Expand Down

0 comments on commit f7c70c2

Please sign in to comment.