Skip to content

Commit

Permalink
Change size limitation for paths and node_id
Browse files Browse the repository at this point in the history
- Change paths length limitation to 192 bytes
- Change node_id length limitation to 192 bytes
  • Loading branch information
Jiawei0227 committed Jan 14, 2021
1 parent baa71a3 commit 826e27d
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 0 deletions.
40 changes: 40 additions & 0 deletions csi.proto
Original file line number Diff line number Diff line change
Expand Up @@ -1206,6 +1206,10 @@ message NodeStageVolumeRequest {
// CO SHALL be responsible for creating the directory if it does not
// exist.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 3;

// Volume capability describing how the CO intends to use this volume.
Expand Down Expand Up @@ -1236,6 +1240,10 @@ message NodeUnstageVolumeRequest {
// The path at which the volume was staged. It MUST be an absolute
// path in the root filesystem of the process serving this request.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 2;
}

Expand All @@ -1259,6 +1267,10 @@ message NodePublishVolumeRequest {
// It MUST be set if the Node Plugin implements the
// `STAGE_UNSTAGE_VOLUME` node capability.
// This is an OPTIONAL field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 3;

// The path to which the volume will be published. It MUST be an
Expand All @@ -1273,6 +1285,10 @@ message NodePublishVolumeRequest {
// mounted directory at target_path.
// Creation of target_path is the responsibility of the SP.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string target_path = 4;

// Volume capability describing how the CO intends to use this volume.
Expand Down Expand Up @@ -1308,6 +1324,10 @@ message NodeUnpublishVolumeRequest {
// path in the root filesystem of the process serving this request.
// The SP MUST delete the file or directory it created at this path.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string target_path = 2;
}

Expand All @@ -1323,13 +1343,21 @@ message NodeGetVolumeStatsRequest {
// It MUST be an absolute path in the root filesystem of
// the process serving this request.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string volume_path = 2;

// The path where the volume is staged, if the plugin has the
// STAGE_UNSTAGE_VOLUME capability, otherwise empty.
// If not empty, it MUST be an absolute path in the root
// filesystem of the process serving this request.
// This field is OPTIONAL.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 3;
}

Expand Down Expand Up @@ -1434,6 +1462,10 @@ message NodeGetInfoResponse {
// `ControllerPublishVolume`, to refer to this node.
// The SP is NOT responsible for global uniqueness of node_id across
// multiple SPs.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string node_id = 1;

// Maximum number of volumes that controller can publish to the node.
Expand Down Expand Up @@ -1467,6 +1499,10 @@ message NodeExpandVolumeRequest {
string volume_id = 1;

// The path on which volume is available. This field is REQUIRED.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string volume_path = 2;

// This allows CO to specify the capacity requirements of the volume
Expand All @@ -1482,6 +1518,10 @@ message NodeExpandVolumeRequest {
// If not empty, it MUST be an absolute path in the root
// filesystem of the process serving this request.
// This field is OPTIONAL.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 4;

// Volume capability describing how the CO intends to use this volume.
Expand Down
40 changes: 40 additions & 0 deletions lib/go/csi/csi.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 40 additions & 0 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -2073,6 +2073,10 @@ message NodeStageVolumeRequest {
// CO SHALL be responsible for creating the directory if it does not
// exist.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 3;
// Volume capability describing how the CO intends to use this volume.
Expand Down Expand Up @@ -2138,6 +2142,10 @@ message NodeUnstageVolumeRequest {
// The path at which the volume was staged. It MUST be an absolute
// path in the root filesystem of the process serving this request.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 2;
}
Expand Down Expand Up @@ -2205,6 +2213,10 @@ message NodePublishVolumeRequest {
// It MUST be set if the Node Plugin implements the
// `STAGE_UNSTAGE_VOLUME` node capability.
// This is an OPTIONAL field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 3;
// The path to which the volume will be published. It MUST be an
Expand All @@ -2219,6 +2231,10 @@ message NodePublishVolumeRequest {
// mounted directory at target_path.
// Creation of target_path is the responsibility of the SP.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string target_path = 4;
// Volume capability describing how the CO intends to use this volume.
Expand Down Expand Up @@ -2285,6 +2301,10 @@ message NodeUnpublishVolumeRequest {
// path in the root filesystem of the process serving this request.
// The SP MUST delete the file or directory it created at this path.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string target_path = 2;
}
Expand Down Expand Up @@ -2326,13 +2346,21 @@ message NodeGetVolumeStatsRequest {
// It MUST be an absolute path in the root filesystem of
// the process serving this request.
// This is a REQUIRED field.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string volume_path = 2;
// The path where the volume is staged, if the plugin has the
// STAGE_UNSTAGE_VOLUME capability, otherwise empty.
// If not empty, it MUST be an absolute path in the root
// filesystem of the process serving this request.
// This field is OPTIONAL.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 3;
}
Expand Down Expand Up @@ -2472,6 +2500,10 @@ message NodeGetInfoResponse {
// `ControllerPublishVolume`, to refer to this node.
// The SP is NOT responsible for global uniqueness of node_id across
// multiple SPs.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string node_id = 1;
// Maximum number of volumes that controller can publish to the node.
Expand Down Expand Up @@ -2535,6 +2567,10 @@ message NodeExpandVolumeRequest {
string volume_id = 1;
// The path on which volume is available. This field is REQUIRED.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string volume_path = 2;
// This allows CO to specify the capacity requirements of the volume
Expand All @@ -2550,6 +2586,10 @@ message NodeExpandVolumeRequest {
// If not empty, it MUST be an absolute path in the root
// filesystem of the process serving this request.
// This field is OPTIONAL.
// This field overrides the general CSI size limit.
// The size of this field SHALL NOT exceed 192 bytes. The general
// CSI size limit, 128 byte, is RECOMMENDED for best backwards
// compatibility.
string staging_target_path = 4;
// Volume capability describing how the CO intends to use this volume.
Expand Down

0 comments on commit 826e27d

Please sign in to comment.