NodeWright Documentation

This directory contains user and operator documentation for NodeWright. Here you'll find guides, examples, and reference material to help you deploy, configure, and secure NodeWright in your Kubernetes cluster.

Getting Started

• Overview: What NodeWright is and how it works.
• Quickstart: Install NodeWright and run a hello-world package on one node.
• Installation: Install NodeWright via Helm.
• Migration from Skyhook: Transition guide from Skyhook to NodeWright.

Architecture

• Operator Status Definitions: Definitions of Status, State, Stage, and Condition concepts used throughout the operator.
• Lifecycle of a NodeWright: How a NodeWright moves from apply to complete, including the check step paired with every work step in a package's stages.
• Interrupt Flow and Ordering: How NodeWright handles packages with interrupts, including the interrupt sequence.
• Strict Ordering: How and why the operator applies each NodeWright Custom Resource in a deterministic sequential order.

User Guide

• CLI Reference: kubectl nodewright commands and usage.
• The NodeWright Custom Resource: Field-by-field reference for the CR, plus targeting with node selectors, deployment policies, and the ignore label.
• Deployment Policy and Compartments: Fine-grained rollout control with compartments, budgets, and strategies.
• Providing Secrets to Packages: How to securely provide secrets to NodeWright-managed packages.
• Runtime Required: How to use the runtime required taint and feature.
• Taints: Taint management in NodeWright.
• Uninstall: Controlled uninstall of packages from nodes.

Operations

• Kubernetes Support: Supported Kubernetes versions and compatibility.
• Resource Management: How NodeWright manages CPU/memory resources using LimitRange.
• Operator Resources at Scale: CPU and memory considerations as cluster and package counts change.
• Versioning: Version scheme and compatibility.

Observability

• Metrics: Prometheus metrics, Grafana dashboards, and monitoring setup.

Security

• Kyverno Policy Examples: Example Kyverno policies for restricting images or packages.