github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

storage: document csi.storage.k8s.io/ephemeral also for internal type

Browse Source 
This was added to staging/src/k8s.io/api/storage/v1beta1/types.go but
unintentionally left out for the internal type. Both docs should
better match because it is uncertain which one will be looked at by
developers.

The original "iff" for "if and only if" is unnecessary because the
comment about "otherwise false" avoids ambiguity.
This commit is contained in:
Patrick Ohly
2020-01-21 10:18:50 +01:00
parent b8f24173da
commit f1101a3318
8 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pkg/apis/storage/types.go
View File

@@ -291,6 +291,15 @@ type CSIDriverSpec struct {
// "csi.storage.k8s.io/pod.name": pod.Name
// "csi.storage.k8s.io/pod.namespace": pod.Namespace
// "csi.storage.k8s.io/pod.uid": string(pod.UID)
// "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume
// defined by a CSIVolumeSource, otherwise "false"
//
// "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only
// required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode.
// Other drivers can leave pod info disabled and/or ignore this field.
// As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when
// deployed on such a cluster and the deployment determines which mode that is, for example
// via a command line parameter of the driver.
// +optional
PodInfoOnMount *bool