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

document which fields can be updated by volume register (#17249)

Browse Source 
The `volume register` command can update a small subset of the volume's fields
in-place, with some restrictions depending on whether the volume is currently in
use. Document these in the `volume register` command docs and the volume
specification docs.

Fixes: #17247
This commit is contained in:
Tim Gross
2023-05-22 09:15:25 -04:00
committed by GitHub
parent 85376af1b7
commit 87ea64c583
2 changed files with 29 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
website/content/docs/commands/volume/register.mdx
View File

@@ -67,6 +67,19 @@ the exact section.
The volume specification is documented in the [Volume
Specification][volume_specification] page.
Not all fields can be updated after the volume is registered:
* The `capacity_min` and `capacity_max` fields can be updated, so long as the
volumes existing capacity fits within that range. The actual capacity of the
volume is unchanged.
* The `capability` blocks can be added or removed, but only if the capability is
not currently in use by a mounted volume.
* The `mount_options` block can be updated if the volume is not in use.
* The `secrets` block can be updated.
* The `context` block can be updated. The values for this field are typically
provided by the CSI plugin, and should not be updated unless recommended by
the CSI plugin's documentation.
[csi]: https://github.com/container-storage-interface/spec
[csi_plugins_internals]: /nomad/docs/concepts/plugins/csi#csi-plugins
[volume_specification]: /nomad/docs/other-specifications/volume

16
website/content/docs/other-specifications/volume/index.mdx
View File

@@ -157,6 +157,22 @@ You should not set the [`snapshot_id`](#snapshot_id), [`clone_id`](#clone_id),
And you should not set the [`external_id`](#external_id) or
[`context`](#context) fields on **volume creation**.
## Updating a Volume Definition
The `volume register` command allows updating a volume definition. But not all
fields can be updated after the volume is registered:
* The `capacity_min` and `capacity_max` fields can be updated, so long as the
volumes existing capacity fits within that range. The actual capacity of the
volume is unchanged.
* The `capability` blocks can be added or removed, but only if the capability is
not currently in use by a mounted volume.
* The `mount_options` block can be updated if the volume is not in use.
* The `secrets` block can be updated.
* The `context` block can be updated. The values for this field are typically
provided by the CSI plugin, and should not be updated unless recommended by
the CSI plugin's documentation.
## Examples
### Volume registration