Modify DataSource comments

This commit is contained in:
Xing Yang 2018-08-28 13:22:47 -07:00
parent 9c1b29ece1
commit de00a66370
2 changed files with 16 additions and 16 deletions

View File

@ -413,14 +413,14 @@ type PersistentVolumeClaimSpec struct {
// This is an alpha feature and may change in the future. // This is an alpha feature and may change in the future.
// +optional // +optional
VolumeMode *PersistentVolumeMode VolumeMode *PersistentVolumeMode
// If specified, volume will be prepopulated with data from the specified data source. // This field requires the VolumeSnapshotDataSource alpha feature gate to be
// This depends on the provisioner for this volume being able to use the specified source. // enabled and currently VolumeSnapshot is the only supported data source.
// If the provisioner failed to create volume from the data source, the behavior will be // If the provisioner can support VolumeSnapshot data source, it will create
// the same as the no data source case. In this failure case, PV will not be created, PVC // a new volume and data will be restored to the volume at the same time.
// will be in the pending state, and the controller will keep retrying to create the volume. // If the provisioner does not support VolumeSnapshot data source, volume will
// This requires the VolumeSnapshotDataSource alpha feature gate to be enabled and // not be created and the failure will be reported as an event.
// currently VolumeSnapshot is the only supported data source. // In the future, we plan to support more data source types and the behavior
// In the future, we will allow more data source types when new feature is ready. // of the provisioner may change.
// +optional // +optional
DataSource *TypedLocalObjectReference DataSource *TypedLocalObjectReference
} }

View File

@ -458,14 +458,14 @@ type PersistentVolumeClaimSpec struct {
// This is an alpha feature and may change in the future. // This is an alpha feature and may change in the future.
// +optional // +optional
VolumeMode *PersistentVolumeMode `json:"volumeMode,omitempty" protobuf:"bytes,6,opt,name=volumeMode,casttype=PersistentVolumeMode"` VolumeMode *PersistentVolumeMode `json:"volumeMode,omitempty" protobuf:"bytes,6,opt,name=volumeMode,casttype=PersistentVolumeMode"`
// If specified, volume will be prepopulated with data from the specified data source. // This field requires the VolumeSnapshotDataSource alpha feature gate to be
// This depends on the provisioner for this volume being able to use the specified source. // enabled and currently VolumeSnapshot is the only supported data source.
// If the provisioner failed to create volume from the data source, the behavior will be // If the provisioner can support VolumeSnapshot data source, it will create
// the same as the no data source case. In this failure case, PV will not be created, PVC // a new volume and data will be restored to the volume at the same time.
// will be in the pending state, and the controller will keep retrying to create the volume. // If the provisioner does not support VolumeSnapshot data source, volume will
// This requires the VolumeSnapshotDataSource alpha feature gate to be enabled and // not be created and the failure will be reported as an event.
// currently VolumeSnapshot is the only supported data source. // In the future, we plan to support more data source types and the behavior
// In the future, we will allow more data source types when new feature is ready. // of the provisioner may change.
// +optional // +optional
DataSource *TypedLocalObjectReference `json:"dataSource" protobuf:"bytes,7,opt,name=dataSource"` DataSource *TypedLocalObjectReference `json:"dataSource" protobuf:"bytes,7,opt,name=dataSource"`
} }