kubectl directpv label drives

The kubectl directpv label drives command adds or removes custom labels on drives managed by DirectPV. Use labels to organize drives and control volume scheduling with the directpv-min-io StorageClass.

For information on using labels to schedule volumes to specific drives, see Volume Scheduling and Schedule Volumes by Label.

kubectl directpv label drives tier=hot --all

┌────────────────────────────────────────┬─────────────────────────────┐
│ DRIVE                                  │ MESSAGE                     │
├────────────────────────────────────────┼─────────────────────────────┤
│ a1b2c3d4-e5f6-7890-abcd-ef1234567890   │ labeled 'tier=hot'          │
│ b2c3d4e5-f6a7-8901-bcde-f12345678901   │ labeled 'tier=hot'          │
└────────────────────────────────────────┴─────────────────────────────┘

kubectl directpv label drives LABEL [LABEL ...]     \
                              [--all]               \
                              [-d|--drives "string"]\
                              [--dry-run]           \
                              [--ids "string"]      \
                              [--labels "string"]   \
                              [-n|--nodes "string"] \
                              [--status "string"]

The following aliases have the same function:

• kubectl directpv label drive
• kubectl directpv label dr

Add or update a label on the selected drives. Specify multiple KEY=VALUE pairs separated by spaces to add multiple labels.

Remove a label from the selected drives. Specify multiple KEY- arguments separated by spaces to remove multiple labels. You can only remove custom labels. You cannot remove the default DirectPV labels.

Optional

Select all drives. When specified, DirectPV ignores other selection flags.

Optional

Select drives on specific nodes. Supports ellipsis expansion notation.

Short form: -n

Optional

Select drives by name. Supports ellipsis expansion notation.

Short form: -d

Optional

Select drives by drive ID. Specify multiple IDs as a comma-separated list or by repeating the flag.

Optional

Select drives by existing labels. Supports comma-separated key=value pairs. When specifying multiple labels, drives must match all labels (AND logic).

Optional

Select drives by status. Specify multiple statuses as a comma-separated list or by repeating the flag.

Valid values: error, lost, moving, ready, removed

Optional

Display what changes would be made without applying them.

This command supports the following global flags:

Set a tier label with value hot on all drives:

kubectl directpv label drives tier=hot --all

Set multiple labels on all drives in a single command:

kubectl directpv label drives tier=hot environment=production --all

Set a type label on NVMe drives on node1:

kubectl directpv label drives type=fast --nodes=node1 --drives=nvme1n{1...3}

Label all drives in ready status:

kubectl directpv label drives environment=production --status=ready

Remove the tier label from all drives:

kubectl directpv label drives tier- --all

See what changes would be made without applying them:

kubectl directpv label drives tier=hot --all --dry-run

Labels follow Kubernetes label syntax:

• Keys and values must be 63 characters or fewer.
• Keys and values must begin and end with alphanumeric characters.
• Keys and values may contain dashes, underscores, and dots.

DirectPV applies default labels to drives for internal use. These labels cannot be removed. Use kubectl directpv list-drives to view all labels on a drive.

You must specify at least one selection flag (--all, --nodes, --drives, --ids, --labels, or --status) to identify which drives to label.

When you specify multiple selection flags, DirectPV selects only drives that match all criteria (AND logic). For example, --nodes=node1 --status=ready selects only drives on node1 that are also in ready status.