docs: clarify requirements for deleting volumes (#26240)

If you delete a CSI volume, the volume cannot be currently claimed by an
allocation or in the process of being unpublished. This is documented in the CLI
but not the API. Also, the documentation incorrectly says that the `volume
delete` command silently returns without error if the volume doesn't exist, but
that's incorrect.

Fixes: https://github.com/hashicorp/nomad/issues/24756
This commit is contained in:
Tim Gross
2025-07-11 15:01:06 -04:00
committed by GitHub
parent bf44eddd9f
commit b23ab5ac15
3 changed files with 6 additions and 4 deletions

View File

@@ -26,8 +26,7 @@ Usage: nomad volume delete [options] <vol id>
Delete a volume from an external storage provider. The volume must still be
registered with Nomad in order to be deleted. Deleting will fail if the
volume is still in use by an allocation or in the process of being
unpublished. If the volume no longer exists, this command will silently
return without an error.
unpublished.
When ACLs are enabled, this command requires a token with the appropriate
capability in the volume's namespace: the 'csi-write-volume' capability for