Alpha Preview·Documentation in progress
Keyboard Shortcuts
Navigation
JNext heading
KPrevious heading
GGScroll to top
ShiftGScroll to bottom
NNext page
PPrevious page
Page
?Open keyboard shortcuts
EscClose modal
Skip to content

CRDs

Overview

PVC Explorer uses two CRDs in API group pvcexplorer.io/v1alpha1.

  • PVCExplorerScope: cluster-scoped registration and defaults
  • PVCExplorer: namespaced explorer instance per PVC

API Specification

ResourceVersionScopeShort nameStatus subresource
PVCExplorerpvcexplorer.io/v1alpha1NamespacedpvcexpEnabled
PVCExplorerScopepvcexplorer.io/v1alpha1ClusterpvcsEnabled

Responsibility split

  • PVCExplorerScope defines namespace selection, discovery mode, and default behavior
  • PVCExplorer defines per-PVC runtime behavior and exposes observed status

CRD Reference Pages

Quick comparison

KindScopePrimary role
PVCExplorerNamespacedManages one explorer agent for one PVC
PVCExplorerScopeClusterRegisters namespaces and defaults, then manages many PVCExplorer objects

Example relationships

Notes for beta

  • Keep CRD contracts minimal and explicit
  • Prefer status-driven UI behavior over inferred state
  • Add new fields only with clear reconciliation and UI use-cases

Source of truth

Apache 2.0 licensed. Built with the Kubebuilder framework.