Recovery: API and docs

[tkatila]

Includes also the fwupdate PR #101 content though it's not required for anything.

Please note, the main content in this PR is the gpurecoveryplan_types.go and RECOVERY.md. The CRD yamls and copy functions are generated.

[Copilot]

Pull request overview

This PR introduces the new GPU recovery API surface and documentation, and refactors firmware-update content image verification to use a generic request shape (aligning with the referenced fwupdate PR #101 direction).

Changes:

• Add GPURecoveryPlan v1alpha1 API types, register them in the scheme, and include generated deepcopy + CRD manifests (plus Helm CRD sync).
• Add recovery documentation (RECOVERY.md) and link it from README.md, plus add samples and RBAC helper roles.
• Refactor ContentImageVerifier to a generic VerifyImage(ctx, ImageVerifyRequest) and update firmware-update controller/tests accordingly (including a reachability-only fast path).

Reviewed changes

Copilot reviewed 19 out of 20 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
RECOVERY.md	Adds detailed recovery workflow documentation and usage guidance.
README.md	Adds a “GPU recovery” section and links to RECOVERY.md.
PROJECT	Registers the new GPURecoveryPlan API with kubebuilder project config.
Makefile	Syncs the new recovery CRD into the Helm chart CRDs directory.
internal/controller/gpufirmwareupdate_controller.go	Updates firmware content-image verification to use generic VerifyImage request.
internal/controller/gpufirmwareupdate_controller_test.go	Updates tests for new verifier interface and request/file shapes.
internal/controller/contentimage_verifier.go	Generalizes verifier interface/types and adds reachability-only verification path.
internal/controller/contentimage_verifier_test.go	Adds a unit test for path normalization helper.
config/samples/recoveryplan/kustomization.yaml	Adds kustomize sample scaffold for recovery plan.
config/samples/recoveryplan/gpurecoveryplan.yaml	Provides a commented sample GPURecoveryPlan manifest.
config/rbac/kustomization.yaml	Wires recovery plan admin/editor/viewer helper ClusterRoles into kustomization.
config/rbac/gpurecoveryplan_*_role.yaml	Adds helper ClusterRoles for recovery plan RBAC.
config/crd/kustomization.yaml	Includes the new recovery plan CRD base.
config/crd/bases/intel.com_gpurecoveryplans.yaml	Generated GPURecoveryPlan CRD definition.
charts/gpu-base-operator/crds/gpurecoveryplans.yaml	Helm chart CRD copy of the generated recovery plan CRD.
api/v1alpha1/zz_generated.deepcopy.go	Generated deep-copies for new API types.
api/v1alpha1/groupversion_info.go	Registers GPURecoveryPlan types in the scheme.
api/v1alpha1/gpurecoveryplan_types.go	Defines the new GPURecoveryPlan API types and validation markers.

Files not reviewed (1)

• api/v1alpha1/zz_generated.deepcopy.go: Generated file

Suppressed comments (1)

api/v1alpha1/gpurecoveryplan_types.go:279

• GoldenFirmwareSource’s comment says "At least one of ContainerSource or VolumeSource must be set", but the docs (and the state machine) describe cases where goldenFirmware is absent/empty and the event should move to missing-goldenfw. The comment should reflect that empty is allowed (and VolumeSource is not supported yet).

// GoldenFirmwareSource describes where the firmware file is located.
// At least one of ContainerSource or VolumeSource must be set.
type GoldenFirmwareSource struct {

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.