Skip to content

docs: update Skyhook wording to NodeWright in operator topic docs - #369

Merged
lockwobr merged 1 commit into
mainfrom
chore/docs-nodewright-prose
Jul 23, 2026
Merged

docs: update Skyhook wording to NodeWright in operator topic docs#369
lockwobr merged 1 commit into
mainfrom
chore/docs-nodewright-prose

Conversation

@lockwobr

Copy link
Copy Markdown
Collaborator

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.md
  • docs/runtime_required.md
  • docs/resource_management.md
  • docs/operator-status-definitions.md
  • docs/kubernetes-support.md

How it stays safe

Unlike the test READMEs, these docs are dense with live commands where skyhook is a frozen literal — the -n skyhook namespace, kubectl get/delete/patch skyhook, the skyhook.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, zero nodewright.nvidia.com, zero NODEWRIGHT_, 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 plain CR. The CleanupSCRMetadata Go function name is left intact (word-boundary replace). Note SCR is still used elsewhere in the repo (code comments, other docs) — a broader SCRCR sweep 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.
  • Frozen surfaces everywhere (namespace, agent image/package, CRD group + kind, chart/config CRD+RBAC, metric names, examples).

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>
@lockwobr
lockwobr requested a review from a team July 23, 2026 20:47
@lockwobr
lockwobr enabled auto-merge (squash) July 23, 2026 20:48
@github-actions github-actions Bot added doc Documentation change (PR path label; doc issues use the Documentation type) component/operator Skyhook operator (controller-manager) component/ci CI workflows, GitHub Actions, and repo tooling labels Jul 23, 2026
@lockwobr
lockwobr merged commit 6697b2d into main Jul 23, 2026
8 of 9 checks passed
@lockwobr
lockwobr deleted the chore/docs-nodewright-prose branch July 23, 2026 20:49
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Updated 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: doc

Suggested reviewers: rice-riley, ayuskauskas

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: renaming Skyhook wording to NodeWright across operator topic docs.
Description check ✅ Passed The description is directly related to the changeset and accurately explains the prose-only rename and scoped files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/docs-nodewright-prose

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between afa1b84 and e99a9a3.

📒 Files selected for processing (5)
  • docs/kubernetes-support.md
  • docs/operator-status-definitions.md
  • docs/resource_management.md
  • docs/runtime_required.md
  • docs/uninstall.md

Comment thread docs/resource_management.md
Comment thread docs/runtime_required.md
Comment thread docs/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.
@lockwobr lockwobr linked an issue Jul 27, 2026 that may be closed by this pull request
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/ci CI workflows, GitHub Actions, and repo tooling component/operator Skyhook operator (controller-manager) doc Documentation change (PR path label; doc issues use the Documentation type)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename API: Skyhook -> NodeWright (group + Kind + annotations + CLI)

2 participants