docs: update Skyhook wording to NodeWright in operator topic docs - #369
Merged
Conversation
Rename the product/concept noun Skyhook -> NodeWright in five operator topic docs (uninstall, runtime_required, resource_management, operator-status-definitions, kubernetes-support), following the API rename. Prose only: the swap runs outside code fences and inline-code spans, so every frozen literal is preserved untouched -- the skyhook namespace (`-n skyhook`), the `skyhook.nvidia.com/*` API group / annotations / finalizer, `SKYHOOK_*` env vars, `kubectl ... skyhook` resource references, YAML examples, and Go identifiers such as `CleanupSCRMetadata` and `processSkyhooksPerNode`. Also drops the now-nonsensical "SCR" (Skyhook Custom Resource) acronym to plain "CR" in these docs' prose, leaving the `CleanupSCRMetadata` function name intact. Signed-off-by: Brian Lockwood <lockwobr@gmail.com>
rice-riley
approved these changes
Jul 23, 2026
Contributor
📝 WalkthroughWalkthroughUpdated five documentation files to replace affected Skyhook terminology with NodeWright. Kubernetes support, operator status, resource management, runtime-required behavior, uninstall workflows, troubleshooting, deletion edge cases, and known issues were revised. No exported or public entity declarations changed. Estimated code review effort: 2 (Simple) | ~10 minutes Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/resource_management.md`:
- Around line 1-3: Update the introductory description of resource management to
state that NodeWright consumes an existing namespace LimitRange for defaults and
does not install or guarantee one. Keep the documented behavior in the later
LimitRange section consistent, including that namespaces without one produce
BestEffort pods.
In `@docs/runtime_required.md`:
- Around line 52-55: Update the prose in the taint-removal section to
consistently use the terms “NodeWright” and “NodeWrights,” replacing “skyhook,”
“nodewrights,” and “nodewright” where they are descriptive nouns. Preserve the
`skyhook.nvidia.com` namespace unchanged.
In `@docs/uninstall.md`:
- Around line 86-89: Update the NodeWright CR deletion documentation to clarify
that finalizer cleanup removes only this NodeWright’s
nodewright.nvidia.com/cordon_<nodewright-name> annotation. State that nodes are
uncordoned only when no other cordon_* owner annotations remain, preserving
cordons owned by other NodeWrights.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 6126d91f-082a-40a8-89c7-8e9a18104b77
📒 Files selected for processing (5)
docs/kubernetes-support.mddocs/operator-status-definitions.mddocs/resource_management.mddocs/runtime_required.mddocs/uninstall.md
lockwobr
added a commit
that referenced
this pull request
Jul 23, 2026
Prose-only Skyhook->NodeWright rename across the rest of docs/ and the chart README, following the API rename. The swap runs outside code fences and inline-code spans, so every frozen literal is preserved: metric names (skyhook_status, skyhook_name, skyhook_node_*_count), the skyhook namespace (incl. the CLI default "skyhook"), the runtime-required taint, host paths (/var/lib/skyhook, /var/log/skyhook), the ghcr.io/nvidia/skyhook/agent image, skyhook.nvidia.com annotations/group, the createSkyhook*Role values keys, and dashboard/image/policy filenames. Files: docs/metrics/README.md, docs/cli.md, docs/README.md, docs/kyverno/README.md, docs/versioning.md, docs/release-process.md, docs/designs/webhook-bootstrap-lease.md, chart/README.md. Also drops the now-nonsensical "SCR" acronym to plain "CR" in these files. Folds in review fixes on the docs merged via #369: - runtime_required.md: finish the prose rename (per-NodeWright, NodeWrights, "NodeWright automatically tolerates"). - resource_management.md: clarify the namespace LimitRange is consumed when present (chart installs one by default, can be disabled), not guaranteed. - uninstall.md: document shared cordon ownership — a node is uncordoned only once no cordon_* ownership annotations remain. - cli.md: v0.7.x legacy path edits the Skyhook spec (not NodeWright); chart README grammar fixes.
lockwobr
added a commit
that referenced
this pull request
Jul 23, 2026
Prose-only Skyhook->NodeWright rename across the rest of docs/ and the chart README, following the API rename. The swap runs outside code fences and inline-code spans, so every frozen literal is preserved: metric names (skyhook_status, skyhook_name, skyhook_node_*_count), the skyhook namespace (incl. the CLI default "skyhook"), the runtime-required taint, host paths (/var/lib/skyhook, /var/log/skyhook), the ghcr.io/nvidia/skyhook/agent image, skyhook.nvidia.com annotations/group, the createSkyhook*Role values keys, and dashboard/image/policy filenames. Files: docs/metrics/README.md, docs/cli.md, docs/README.md, docs/kyverno/README.md, docs/versioning.md, docs/release-process.md, docs/designs/webhook-bootstrap-lease.md, chart/README.md. Also drops the now-nonsensical "SCR" acronym to plain "CR" in these files. Folds in review fixes on the docs merged via #369: - runtime_required.md: finish the prose rename (per-NodeWright, NodeWrights, "NodeWright automatically tolerates"). - resource_management.md: clarify the namespace LimitRange is consumed when present (chart installs one by default, can be disabled), not guaranteed. - uninstall.md: document shared cordon ownership — a node is uncordoned only once no cordon_* ownership annotations remain. - cli.md: v0.7.x legacy path edits the Skyhook spec (not NodeWright); chart README grammar fixes.
lockwobr
added a commit
that referenced
this pull request
Jul 27, 2026
…370) Prose-only Skyhook->NodeWright rename across the rest of docs/ and the chart README, following the API rename. The swap runs outside code fences and inline-code spans, so every frozen literal is preserved: metric names (skyhook_status, skyhook_name, skyhook_node_*_count), the skyhook namespace (incl. the CLI default "skyhook"), the runtime-required taint, host paths (/var/lib/skyhook, /var/log/skyhook), the ghcr.io/nvidia/skyhook/agent image, skyhook.nvidia.com annotations/group, the createSkyhook*Role values keys, and dashboard/image/policy filenames. Files: docs/metrics/README.md, docs/cli.md, docs/README.md, docs/kyverno/README.md, docs/versioning.md, docs/release-process.md, docs/designs/webhook-bootstrap-lease.md, chart/README.md. Also drops the now-nonsensical "SCR" acronym to plain "CR" in these files. Folds in review fixes on the docs merged via #369: - runtime_required.md: finish the prose rename (per-NodeWright, NodeWrights, "NodeWright automatically tolerates"). - resource_management.md: clarify the namespace LimitRange is consumed when present (chart installs one by default, can be disabled), not guaranteed. - uninstall.md: document shared cordon ownership — a node is uncordoned only once no cordon_* ownership annotations remain. - cli.md: v0.7.x legacy path edits the Skyhook spec (not NodeWright); chart README grammar fixes.
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Continues the Skyhook→NodeWright rename into the operator topic docs, updating the product/concept noun in prose. Five files, pure word swaps (68/68):
docs/uninstall.mddocs/runtime_required.mddocs/resource_management.mddocs/operator-status-definitions.mddocs/kubernetes-support.mdHow it stays safe
Unlike the test READMEs, these docs are dense with live commands where
skyhookis a frozen literal — the-n skyhooknamespace,kubectl get/delete/patch skyhook, theskyhook.nvidia.com/*group / annotations / finalizer,SKYHOOK_*env vars, and YAML examples. Every one of those lives inside a backtick code span or a fenced code block.So the swap runs only in prose — it skips fenced code blocks and inline-code spans entirely. That mechanically preserves every command, namespace, annotation key, finalizer, env var, YAML example, and Go identifier (
CleanupSCRMetadata,processSkyhooksPerNode). Verified post-swap: zero-n nodewright, zeronodewright.nvidia.com, zeroNODEWRIGHT_, no broken doc links, no shifted-heading anchors referenced elsewhere.SCR → CR
SCR("Skyhook Custom Resource") no longer expands sensibly, so these docs now use plainCR. TheCleanupSCRMetadataGo function name is left intact (word-boundary replace). NoteSCRis still used elsewhere in the repo (code comments, other docs) — a broaderSCR→CRsweep is a separate follow-up.Deliberately out of scope
docs/nodewright-migration.md— intentionally discusses both names.docs/cli.md,docs/metrics/README.md— have version-matrix / metric-name nuance; deferred to focused follow-ups.