Skip to content

Commit 64b5733

Browse files
pohlyjdef
authored andcommitted
clarify origin of volume_context
The "volume context as returned by CO in CreateVolumeRequest" is misleading in several ways: - the volume context is return *to* the CO by the SP - it is returned in the CreateVolumeResponse
1 parent 4731db0 commit 64b5733

File tree

3 files changed

+48
-36
lines changed

3 files changed

+48
-36
lines changed

csi.proto

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -683,9 +683,10 @@ message ControllerPublishVolumeRequest {
683683
// `Secrets Requirements` section on how to use this field.
684684
map<string, string> secrets = 5 [(csi_secret) = true];
685685

686-
// Volume context as returned by CO in CreateVolumeRequest. This field
687-
// is OPTIONAL and MUST match the volume_context of the volume
688-
// identified by `volume_id`.
686+
// Volume context as returned by SP in
687+
// CreateVolumeResponse.Volume.volume_context.
688+
// This field is OPTIONAL and MUST match the volume_context of the
689+
// volume identified by `volume_id`.
689690
map<string, string> volume_context = 6;
690691
}
691692

@@ -731,9 +732,10 @@ message ValidateVolumeCapabilitiesRequest {
731732
// The ID of the volume to check. This field is REQUIRED.
732733
string volume_id = 1;
733734

734-
// Volume context as returned by CO in CreateVolumeRequest. This field
735-
// is OPTIONAL and MUST match the volume_context of the volume
736-
// identified by `volume_id`.
735+
// Volume context as returned by SP in
736+
// CreateVolumeResponse.Volume.volume_context.
737+
// This field is OPTIONAL and MUST match the volume_context of the
738+
// volume identified by `volume_id`.
737739
map<string, string> volume_context = 2;
738740

739741
// The capabilities that the CO wants to check for the volume. This
@@ -1119,9 +1121,10 @@ message NodeStageVolumeRequest {
11191121
// section on how to use this field.
11201122
map<string, string> secrets = 5 [(csi_secret) = true];
11211123

1122-
// Volume context as returned by CO in CreateVolumeRequest. This field
1123-
// is OPTIONAL and MUST match the volume_context of the volume
1124-
// identified by `volume_id`.
1124+
// Volume context as returned by SP in
1125+
// CreateVolumeResponse.Volume.volume_context.
1126+
// This field is OPTIONAL and MUST match the volume_context of the
1127+
// volume identified by `volume_id`.
11251128
map<string, string> volume_context = 6;
11261129
}
11271130

@@ -1189,9 +1192,10 @@ message NodePublishVolumeRequest {
11891192
// section on how to use this field.
11901193
map<string, string> secrets = 7 [(csi_secret) = true];
11911194

1192-
// Volume context as returned by CO in CreateVolumeRequest. This field
1193-
// is OPTIONAL and MUST match the volume_context of the volume
1194-
// identified by `volume_id`.
1195+
// Volume context as returned by SP in
1196+
// CreateVolumeResponse.Volume.volume_context.
1197+
// This field is OPTIONAL and MUST match the volume_context of the
1198+
// volume identified by `volume_id`.
11951199
map<string, string> volume_context = 8;
11961200
}
11971201

lib/go/csi/csi.pb.go

Lines changed: 16 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

spec.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1207,9 +1207,10 @@ message ControllerPublishVolumeRequest {
12071207
// `Secrets Requirements` section on how to use this field.
12081208
map<string, string> secrets = 5 [(csi_secret) = true];
12091209
1210-
// Volume context as returned by CO in CreateVolumeRequest. This field
1211-
// is OPTIONAL and MUST match the volume_context of the volume
1212-
// identified by `volume_id`.
1210+
// Volume context as returned by SP in
1211+
// CreateVolumeResponse.Volume.volume_context.
1212+
// This field is OPTIONAL and MUST match the volume_context of the
1213+
// volume identified by `volume_id`.
12131214
map<string, string> volume_context = 6;
12141215
}
12151216
@@ -1312,9 +1313,10 @@ message ValidateVolumeCapabilitiesRequest {
13121313
// The ID of the volume to check. This field is REQUIRED.
13131314
string volume_id = 1;
13141315
1315-
// Volume context as returned by CO in CreateVolumeRequest. This field
1316-
// is OPTIONAL and MUST match the volume_context of the volume
1317-
// identified by `volume_id`.
1316+
// Volume context as returned by SP in
1317+
// CreateVolumeResponse.Volume.volume_context.
1318+
// This field is OPTIONAL and MUST match the volume_context of the
1319+
// volume identified by `volume_id`.
13181320
map<string, string> volume_context = 2;
13191321
13201322
// The capabilities that the CO wants to check for the volume. This
@@ -1958,9 +1960,10 @@ message NodeStageVolumeRequest {
19581960
// section on how to use this field.
19591961
map<string, string> secrets = 5 [(csi_secret) = true];
19601962
1961-
// Volume context as returned by CO in CreateVolumeRequest. This field
1962-
// is OPTIONAL and MUST match the volume_context of the volume
1963-
// identified by `volume_id`.
1963+
// Volume context as returned by SP in
1964+
// CreateVolumeResponse.Volume.volume_context.
1965+
// This field is OPTIONAL and MUST match the volume_context of the
1966+
// volume identified by `volume_id`.
19641967
map<string, string> volume_context = 6;
19651968
}
19661969
@@ -2107,9 +2110,10 @@ message NodePublishVolumeRequest {
21072110
// section on how to use this field.
21082111
map<string, string> secrets = 7 [(csi_secret) = true];
21092112
2110-
// Volume context as returned by CO in CreateVolumeRequest. This field
2111-
// is OPTIONAL and MUST match the volume_context of the volume
2112-
// identified by `volume_id`.
2113+
// Volume context as returned by SP in
2114+
// CreateVolumeResponse.Volume.volume_context.
2115+
// This field is OPTIONAL and MUST match the volume_context of the
2116+
// volume identified by `volume_id`.
21132117
map<string, string> volume_context = 8;
21142118
}
21152119

0 commit comments

Comments
 (0)