Skip to content

docs: update runtime required doc to be more clear #111

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
merged 1 commit into from
Oct 28, 2025
Merged

docs: update runtime required doc to be more clear #111

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
9 changes: 5 additions & 4 deletions docs/runtime_required.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ before the nodes that it targets are considered available for general use.

# Details
## When is a node considered ready
When all of the following conditions are true per node:
1. All SCRs with `runtimeRequired: true` are complete
When all of the following is true per node:
1. All SCRs with `runtimeRequired: true` are complete (ie complete on all nodes)

## What happens happens when a node is considered ready
1. The runtime required taint is removed from the node if it exists.


# Why would you use runtime required
This is useful when you want to gate other work behind the successful completion of some set of Skyhook Packages. This can be for security reasons or for scheduling.
This is useful when you want to gate other work behind the successful completion of some set of Skyhook Packages. This can be for security reasons or for scheduling.

**NOTE:** No additional toleration is required, skyhook auto tolerates this (env:`runtimeRequiredTaint`) taint.