Skip to content

Commit 256bee5

Browse files
Update based on comments
1 parent d41665c commit 256bee5

File tree

1 file changed

+1
-66
lines changed
  • keps/sig-storage/3751-volume-attributes-class

1 file changed

+1
-66
lines changed

keps/sig-storage/3751-volume-attributes-class/README.md

Lines changed: 1 addition & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -225,51 +225,6 @@ Cluster administrators can use K8s quota to specify how many PVCs can use a spec
225225
### CSI API
226226
The CSI create request will be extended to add mutable parameters. A new ControllerModifyVolume RPC will be added. More details in [CSI Spec PR](https://github.com/container-storage-interface/spec/pull/544).
227227

228-
```
229-
// ControllerServer is the server API for Controller service.
230-
type ControllerServer interface {
231-
...
232-
rpc ControllerModifyVolume (ControllerModifyVolumeRequest)
233-
returns (ControllerModifyVolumeResponse) {
234-
option (alpha_method) = true;
235-
}
236-
...
237-
}
238-
239-
message ControllerModifyVolumeRequest {
240-
// Contains identity information for the existing volume.
241-
// This field is REQUIRED.
242-
string volume_id = 1;
243-
244-
// Secrets required by plugin to complete modify volume request.
245-
// This field is OPTIONAL. Refer to the `Secrets Requirements`
246-
// section on how to use this field.
247-
map<string, string> secrets = 2 [(csi_secret) = true];
248-
249-
// Plugin specific volume attributes to mutate, passed in as
250-
// opaque key-value pairs.
251-
// This field is REQUIRED. The Plugin is responsible for
252-
// parsing and validating these parameters. COs will treat these
253-
// as opaque. The CO SHOULD specify the intended values of all mutable
254-
// parameters it intends to modify. SPs MUST NOT modify volumes based
255-
// on the absence of keys, only keys that are specified should result
256-
// in modifications to the volume.
257-
map<string, string> mutable_parameters = 3;
258-
}
259-
message ControllerModifyVolumeResponse {}
260-
261-
message CreateVolumeRequest {
262-
...
263-
// See CreateVolumeRequest.parameters.
264-
// This field is OPTIONAL.
265-
map<string, string> parameters = 4;
266-
// Plugins MUST treat these
267-
// as if they take precedence over the parameters field.
268-
// This field SHALL NOT be specified unless the SP has the
269-
// MODIFY_VOLUME plugin capability.
270-
map<string, string> mutable_parameters = 8;
271-
}
272-
```
273228

274229
### User Stories (Optional)
275230

@@ -446,28 +401,8 @@ The resource quota controller is the only component capable of monitoring and re
446401

447402
### 3. Add new statuses in PVC API to indicate changes of VolumeAttributesClass and the status of the ModifyVolume operation.
448403

449-
```
450-
type ModifyVolumeStatus struct {
451-
ActualClassName string
452-
TargetClassName string
453-
Status *PersistentVolumeClaimModifyVolumeStatus
454-
}
455-
456-
// +enum
457-
type PersistentVolumeClaimModifyVolumeStatus string
404+
Please see session "Kubernetes API" above.
458405

459-
const (
460-
// Pending indicates that the PersistentVolumeClaim cannot be modified due to requirements not being met, such as
461-
// the PersistentVolumeClaim being in an invalid state or the specified VolumeAttributesClass is existing
462-
PersistentVolumeClaimControllerModifyVolumePending PersistentVolumeClaimModifyVolumeStatus = "ControllerModifyVolumePending"
463-
// State set when modify volume controller starts modifying the volume in control-plane
464-
// When the request has been rejected as invalid by the CSI driver. To resolve this error,
465-
// the PersistentVolumeClaim needs to specify a valid VolumeAttributesClass.
466-
PersistentVolumeClaimControllerModifyVolumeInProgress PersistentVolumeClaimModifyVolumeStatus = "ControllerModifyVolumeInProgress"
467-
// State set when modify volume has failed in modify volume controller with a terminal error.
468-
PersistentVolumeClaimControllerModifyVolumeInfeasible PersistentVolumeClaimModifyVolumeStatus = "ControllerModifyVolumeInfeasible"
469-
)
470-
```
471406
### 4. Add new CSI API ControllerModifyVolume, when there is a change of VolumeAttributesClass in PVC, external-resizer triggers a ControllerModifyVolume operation against a CSI endpoint. A Controller Plugin MUST implement this RPC call if it has MODIFY_VOLUME capability.
472407

473408
### 5. Add new operation metrics for ModifyVolume operations

0 commit comments

Comments
 (0)