Skip to content

Commit 526c5d7

Browse files
committed
Implement jdef's grammar suggestions
1 parent 7574213 commit 526c5d7

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

csi.proto

+2-2
Original file line numberDiff line numberDiff line change
@@ -1056,8 +1056,8 @@ message ControllerServiceCapability {
10561056
// condition after a volume is provisioned.
10571057
GET_VOLUME = 12 [(alpha_enum_value) = true];
10581058

1059-
// Indicates the SP supports ControllerUnpublishVolume.fence
1060-
// field.
1059+
// Indicates the SP supports the
1060+
// ControllerUnpublishVolume.fence field.
10611061
UNPUBLISH_FENCE = 13 [(alpha_enum_value) = true];
10621062
}
10631063

spec.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ The full list of plugin capabilities is documented in the `ControllerGetCapabili
265265

266266
The purpose of the `QUARANTINE_S`, `QUARANTINE_P`, and `QUARANTINE_SP` states are to enable recovery from node problems.
267267
Because CSI is designed to be used in distributed systems, it is inevitable that sometimes volumes will become attached to nodes that get stuck or lost, temporarily or permanently.
268-
Rather than require an administrator to manually clean up such situation, CSI offers a way disconnect a volume from a node "out of order" such that a volume can be disconnected from a problematic node, and safely connected to a different node, and the node can be reliably and safely cleaned up before accessing that volume again, as opposed to the normal path where the node must confirm a volume is disconnected before the controller can unpublish it.
268+
Rather than require an administrator to manually clean up in such a situation, CSI offers a way to disconnect a volume from a node "out of order" such that a volume can be disconnected from problematic *node A*, and safely connected to a different *node B*, and then *node A* can be reliably and safely cleaned up before accessing that volume again; as opposed to the normal path whereby *node A* must confirm a volume is disconnected before the controller can unpublish it.
269269

270270
## Container Storage Interface
271271

@@ -1303,13 +1303,13 @@ The CO MUST implement the specified error recovery behavior when it encounters t
13031303

13041304
Controller Plugin MUST implement this RPC call if it has `PUBLISH_UNPUBLISH_VOLUME` controller capability.
13051305
This RPC is a reverse operation of `ControllerPublishVolume`.
1306-
It MUST be called after all `NodeUnstageVolume` and `NodeUnpublishVolume` on the volume are called and succeed unless the plugin has the `UNPUBLISH_FENCE` capability.
1306+
It MUST be called after both `NodeUnstageVolume` and `NodeUnpublishVolume` on the volume are called and succeed unless the plugin has the `UNPUBLISH_FENCE` capability.
13071307
The Plugin SHOULD perform the work that is necessary for making the volume ready to be consumed by a different node.
13081308
The Plugin MUST NOT assume that this RPC will be executed on the node where the volume was previously used.
13091309

13101310
If the plugin has the `UNPUBLISH_FENCE` capability, the CO MAY specify `fence` as `true`, in which case the SP MUST ensure that the node may no longer access the volume before returning a successful response.
13111311
This results in a transition into one of the `QUARANTINE` states where the node must be cleaned up without being able to access the volume like usual.
1312-
This is intended cut off an unreachable node from accessing volumes so those volumes may be safely published to another node.
1312+
This is intended to cut off an unreachable node from accessing volumes so those volumes may be safely published to another node.
13131313
Once in one of the `QUARANTINE` states the volume MAY NOT be published to that node again until appropriate cleanup has happened using `NodeUnpublishVolume` and `NodeUnstageVolume` (if applicable).
13141314

13151315
This RPC is typically called by the CO when the workload using the volume is being moved to a different node, or all the workload using the volume on a node has finished.
@@ -1731,8 +1731,8 @@ message ControllerServiceCapability {
17311731
// condition after a volume is provisioned.
17321732
GET_VOLUME = 12 [(alpha_enum_value) = true];
17331733
1734-
// Indicates the SP supports ControllerUnpublishVolume.fence
1735-
// field.
1734+
// Indicates the SP supports the
1735+
// ControllerUnpublishVolume.fence field.
17361736
UNPUBLISH_FENCE = 13 [(alpha_enum_value) = true];
17371737
}
17381738
@@ -2191,7 +2191,7 @@ This RPC is a reverse operation of `NodeStageVolume`.
21912191
This RPC MUST undo the work by the corresponding `NodeStageVolume`.
21922192
This RPC SHALL be called by the CO once for each `staging_target_path` that was successfully setup via `NodeStageVolume`.
21932193

2194-
If the corresponding Controller Plugin has `PUBLISH_UNPUBLISH_VOLUME` controller capability and the Node Plugin has `STAGE_UNSTAGE_VOLUME` capability, the CO MUST guarantee that this RPC is called and returns success before calling `ControllerUnpublishVolume` for the given node and the given volume, unless the Controller Plugin has `UNPUBLISH_FENCE` capability and the Node Plugin has the `FORCE_UNPUBLISH` capability and the `force` flag is `true`.
2194+
If the corresponding Controller Plugin has the `PUBLISH_UNPUBLISH_VOLUME` controller capability and the Node Plugin has the `STAGE_UNSTAGE_VOLUME` capability, the CO MUST guarantee that this RPC is called and returns success before calling `ControllerUnpublishVolume` for the given node and the given volume, unless the Controller Plugin has the `UNPUBLISH_FENCE` capability and the Node Plugin has the `FORCE_UNPUBLISH` capability and the `force` flag is `true`.
21952195
The CO MUST guarantee that this RPC is called after all `NodeUnpublishVolume` have been called and returned success for the given volume on the given node.
21962196

21972197
If the Node Plugin has the `FORCE_UNPUBLISH` capability, the CO MAY specify `force` as `true` in which case the Node Plugin MUST support unstaging volumes even when access has been revoked with `ControllerUnpublishVolume`.
@@ -2364,12 +2364,12 @@ A Node Plugin MUST implement this RPC call.
23642364
This RPC is a reverse operation of `NodePublishVolume`.
23652365
This RPC MUST undo the work by the corresponding `NodePublishVolume`.
23662366
This RPC SHALL be called by the CO at least once for each `target_path` that was successfully setup via `NodePublishVolume`.
2367-
If the corresponding Controller Plugin has `PUBLISH_UNPUBLISH_VOLUME` controller capability, the CO SHOULD issue all `NodeUnpublishVolume` (as specified above) before calling `ControllerUnpublishVolume` for the given node and the given volume, unless the Controller Plugin has `UNPUBLISH_FENCE` capability and the Node Plugin has the `FORCE_UNPUBLISH` capability and the `force` flag is `true`.
2367+
If the corresponding Controller Plugin has the `PUBLISH_UNPUBLISH_VOLUME` controller capability, the CO SHOULD issue `NodeUnpublishVolume` (as specified above) before calling `ControllerUnpublishVolume` for the given node and the given volume, unless the Controller Plugin has the `UNPUBLISH_FENCE` capability and the Node Plugin has the `FORCE_UNPUBLISH` capability and the `force` flag is `true`.
23682368
The Plugin SHALL assume that this RPC will be executed on the node where the volume is being used.
23692369

23702370
If the Node Plugin has the `FORCE_UNPUBLISH` capability, the CO MAY specify `force` as `true` in which case the Node Plugin MUST support unpublishing volumes even when access has been revoked with `ControllerUnpublishVolume`.
23712371
Because data loss is inevitable in such circumstances, the `force` flag is an indication that success is desired even if it means losing data.
2372-
It is essential that after a successful call to `NodeUnpublishVolume` that there will be no buffered data on the node related to the volume which might result in unintetional modification of the volume if it was to be subsequently re-published to that node.
2372+
It is essential that after a successful call to `NodeUnpublishVolume` that there will be no buffered data on the node related to the volume that might result in unintentional modification of the volume if it was to be subsequently re-published to that node.
23732373

23742374
This RPC is typically called by the CO when the workload using the volume is being moved to a different node, or all the workload using the volume on a node has finished.
23752375

0 commit comments

Comments
 (0)