You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/reference/kubernetes-api/cluster-resources/api-service-v1.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ APIServiceSpec contains information for locating and communicating with a server
62
62
63
63
-**groupPriorityMinimum** (int32), required
64
64
65
-
GroupPriorityMinimum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMinimum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
65
+
GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
@@ -59,68 +59,68 @@ CSIDriverSpec is the specification of a CSIDriver.
59
59
-**attachRequired** (boolean)
60
60
61
61
attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called.
62
-
62
+
63
63
This field is immutable.
64
64
65
65
-**fsGroupPolicy** (string)
66
66
67
67
fsGroupPolicy defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details.
68
-
68
+
69
69
This field is immutable.
70
-
70
+
71
71
Defaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce.
72
72
73
73
-**podInfoOnMount** (boolean)
74
74
75
75
podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations, if set to true. If set to false, pod information will not be passed on mount. Default is false.
76
-
76
+
77
77
The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext.
78
-
79
-
The following VolumeContext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "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
78
+
79
+
The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "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
80
80
defined by a CSIVolumeSource, otherwise "false"
81
-
81
+
82
82
"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.
83
-
83
+
84
84
This field is immutable.
85
85
86
86
-**requiresRepublish** (boolean)
87
87
88
88
requiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false.
89
-
89
+
90
90
Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container.
91
91
92
92
-**seLinuxMount** (boolean)
93
93
94
94
seLinuxMount specifies if the CSI driver supports "-o context" mount option.
95
-
95
+
96
96
When "true", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different `-o context` options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with "-o context=xyz" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context.
97
-
97
+
98
98
When "false", Kubernetes won't pass any special SELinux mount options to the driver. This is typical for volumes that represent subdirectories of a bigger shared filesystem.
99
-
99
+
100
100
Default is "false".
101
101
102
102
-**storageCapacity** (boolean)
103
103
104
104
storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information, if set to true.
105
-
105
+
106
106
The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object.
107
-
107
+
108
108
Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published.
109
-
109
+
110
110
This field was immutable in Kubernetes \<= 1.22 and now is mutable.
111
111
112
112
-**tokenRequests** ([]TokenRequest)
113
113
114
114
*Atomic: will be replaced during a merge*
115
-
115
+
116
116
tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": {
117
117
"\<audience>": {
118
118
"token": \<token>,
119
119
"expirationTimestamp": \<expiration timestamp in RFC3339>,
120
120
},
121
121
...
122
122
}
123
-
123
+
124
124
Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically.
125
125
126
126
<aname="TokenRequest"></a>
@@ -137,13 +137,13 @@ CSIDriverSpec is the specification of a CSIDriver.
137
137
-**volumeLifecycleModes** ([]string)
138
138
139
139
*Set: unique values will be kept during a merge*
140
-
140
+
141
141
volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism.
142
-
142
+
143
143
The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume.
144
-
144
+
145
145
For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future.
146
-
146
+
147
147
This field is beta. This field is immutable.
148
148
149
149
@@ -297,7 +297,7 @@ POST /apis/storage.k8s.io/v1/csidrivers
Copy file name to clipboardExpand all lines: content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume-attachment-v1.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,7 @@ VolumeAttachmentSpec is the specification of a VolumeAttachment request.
75
75
source represents the volume that should be attached.
76
76
77
77
<aname="VolumeAttachmentSource"></a>
78
-
*VolumeAttachmentSource represents a volume that should be attached. Right now only PersistentVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.*
78
+
*VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.*
Copy file name to clipboardExpand all lines: content/en/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -139,7 +139,7 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
139
139
140
140
-**ports.name** (string)
141
141
142
-
name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
142
+
name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
0 commit comments