Volume Manager CLI

Install Volume Manager plugin

Volume Manager provides a kubectl plugin for managing Volume Manager drives and volumes. Use this plugin at the command line to complete all of the functions required for adding, managing, scheduling, and removing Volume Manager drives and volumes in a Kubernetes cluster.

Install the directpv plugin by downloading the binary for your specific architecture and moving it to the /usr/bin/local folder on your local machine:

Linux

AMD64

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/linux-amd64/kubectl-directpv_5.0.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv /usr/local/bin/kubectl-directpv

kubectl directpv --help

ARM64

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/linux-arm64/kubectl-directpv_5.0.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv /usr/local/bin/kubectl-directpv

kubectl directpv --help

PPC64-LE

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/linux-ppc64le/kubectl-directpv_5.0.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv /usr/local/bin/kubectl-directpv

kubectl directpv --help

MacOS

AMD64

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/darwin-amd64/kubectl-directpv_5.0.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv /usr/local/bin/kubectl-directpv

kubectl directpv --help

ARM64

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/darwin-arm64/kubectl-directpv_5.0.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv /usr/local/bin/kubectl-directpv

kubectl directpv --help

Windows

Usage

kubectl directpv [command] [flags]

Flags

The following flags are available for kubectl directpv and many of the commands included with the plugin.

Flag	Description
`-h`, `--help`	help for directpv
`--kubeconfig string`	Path to the kubeconfig file to use for CLI requests
`--quiet`	Suppress printing error messages
`--version`	version for directpv

Available Commands

This documentation includes details for each available command on separate subpages. The available commands include:

Command	Description
Install
`install`	Install Volume Manager in Kubernetes
Manage Drives and Volumes
`discover`	Discover new drives
`info`	Show information about Volume Manager installation
`init`	Initialize drives
`label drives`	Set labels to drives
`label volumes`	Set labels to volumes
`list-drives`	List drives
`list-volumes`	List volumes
`repair`	Repair faulty XFS-formatted drives
`resume-drives`	Resume suspended drives
`resume-volumes`	Resume suspended volumes
`suspend-drives`	Suspend drives
`suspend-volumes`	Suspend volumes
Manage Scheduling
`cordon`	Mark drives as unschedulable
`uncordon`	Mark drives as schedulable
Maintenance
`clean`	Cleanup stale volumes
`migrate`	Migrate drives and volumes from legacy DirectCSI
`move`	Move volumes excluding data from source drive to destination drive on a same node
`remove`	Remove unused drives from Volume Manager
Uninstall Volume Manager
`uninstall`	Uninstall Volume Manager in Kubernetes

Command History

Volume Manager Command changes

Old Volume Manager Command	Replacement Volume Manager Command
`kubectl directpv discover`	`kubectl directpv init`

Command changes from DirectCSI

DirectCSI Command	Volume Manager Command
`kubectl directcsi drives list`	`kubectl directpv list drives`
`kubectl directcsi volumes list`	`kubectl directpv list volumes`
`kubectl directcsi format`	`kubectl directpv discover`, then `kubectl directpv init`