Reference
Use the reference pages as a quick lookup for commands, configuration options, and resource specifications.
CLI Reference
The CLI Reference documents the kubectl directpv plugin commands for managing drives and volumes.
| Section | Description |
|---|---|
| Cluster commands | Install DirectPV, discover drives, initialize storage |
| Drive commands | List, label, suspend, resume, and repair drives |
| Volume commands | List, label, suspend, and resume volumes |
| Scheduling commands | Cordon and uncordon drives |
| Maintenance commands | Clean stale volumes, move data, remove drives |
Kubernetes Reference
The Kubernetes Reference documents DirectPV’s Kubernetes resources and configuration.
| Page | Description |
|---|---|
| Helm Chart Reference | Configuration options for the minio/directpv Helm chart including image settings, node selectors, tolerations, and security profiles |
| Storage Class Reference | Default directpv-min-io storage class, custom storage class creation, drive selection parameters, and access tiers |
| CRD Reference | Custom Resource Definitions, including those for Drives, Volumes, Nodes, and InitRequest |
Quick links
Common tasks
| Task | Reference |
|---|---|
Install the kubectl plugin | CLI Reference - Install |
| Configure Helm chart values | Helm Chart Reference |
| Create a custom storage class | Storage Class Reference - Custom storage classes |
| View drive CRD fields | CRD Reference - DirectPVDrive |
| Use ellipsis expansion | CLI Reference - Ellipsis expansion |
| Understand resource selection | CLI Reference - Resource selection |
Command reference by category
Setup: install | discover | init | info | uninstall
Drives: list drives | label drives | suspend drives | resume drives | repair
Volumes: list volumes | label volumes | suspend volumes | resume volumes