Skip to content

Commit a5814d7

Browse files
Backport of docs: explain access modes for CSI and DHV volumes (#26352) (#26373)
The documentation for CSI and DHV has a list of the available access modes, but doesn't explain what they mean in terms of what jobs can request, the scheduler behavior, or the CSI plugin behavior. Expand on the information available in the CSI specification and provide a description of DHV's behavior as well. Ref: https://github.com/container-storage-interface/spec/blob/master/spec.md#createvolume Co-authored-by: Tim Gross <[email protected]>
1 parent 2fa045a commit a5814d7

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

website/content/docs/other-specifications/volume/capability.mdx

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,20 @@ available concurrently. Can be one of `"single-node-reader-only"`,
4040
`"single-node-writer"`, `"multi-node-reader-only"`,
4141
`"multi-node-single-writer"`, or `"multi-node-multi-writer"`. Most CSI plugins
4242
support only single-node modes. Consult the documentation of the storage
43-
provider and CSI plugin.
43+
provider and CSI plugin. Can be one of the following:
44+
45+
- `"single-node-reader-only"`: Jobs can only request the volume with
46+
read-only access, and only one node can mount the volume at a time.
47+
- `"single-node-writer"`: Jobs can request the volume with read/write or
48+
read-only access, and only one node can mount the volume at a time.
49+
- `"multi-node-reader-only"`: Jobs can only request the volume with
50+
read-only access, but multiple nodes can mount the volume simultaneously.
51+
- `"multi-node-single-writer"`: Jobs can request the volume with read/write
52+
or read-only access, but the scheduler only allows one allocation to have
53+
read/write access. Multiple nodes can mount the volume simultaneously.
54+
- `"multi-node-multi-writer"`: Jobs can request the volume with read/write
55+
or read-only access, and the scheduler allows multiple allocations to have
56+
read/write access. Multiple nodes can mount the volume simultaneously.
4457

4558
- `attachment_mode` `(string: <required>)` - The storage API that will be used
4659
by the volume. Most storage providers will support `"file-system"`, to mount

0 commit comments

Comments
 (0)