kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-01 16:05:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify requirements for deleting volumes (#26240)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

3
command/volume_delete.go
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

4
website/content/api-docs/volumes.mdx
View File

@@ -497,6 +497,10 @@ for deleting the volume as comma-separated key-value pairs (see the
example below). These secrets will be merged with any secrets already
stored when the CSI volume was created.
The volume must still be registered with Nomad in order to be deleted. This API
call fails if an allocation still claims the volume or if Nomad is unpublishing
the volume.
### Parameters
- `:volume_id` `(string: <required>)` - Specifies the ID of the

3
website/content/commands/volume/delete.mdx
View File

@@ -26,8 +26,7 @@ nomad volume delete [options] [volume]
The `volume delete` command requires a single argument, specifying the ID of
volume to be deleted. The volume must still be [registered][] with Nomad in
order to be deleted. Deleting fails 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 silently returns without an error.
allocation or in the process of being 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 CSI