generated.proto 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664
  1. /*
  2. Copyright The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. // This file was autogenerated by go-to-protobuf. Do not edit it manually!
  14. syntax = "proto2";
  15. package k8s.io.api.storage.v1beta1;
  16. import "k8s.io/api/core/v1/generated.proto";
  17. import "k8s.io/apimachinery/pkg/api/resource/generated.proto";
  18. import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
  19. import "k8s.io/apimachinery/pkg/runtime/generated.proto";
  20. import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
  21. // Package-wide variables from generator "generated".
  22. option go_package = "k8s.io/api/storage/v1beta1";
  23. // CSIDriver captures information about a Container Storage Interface (CSI)
  24. // volume driver deployed on the cluster.
  25. // CSI drivers do not need to create the CSIDriver object directly. Instead they may use the
  26. // cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically
  27. // creates a CSIDriver object representing the driver.
  28. // Kubernetes attach detach controller uses this object to determine whether attach is required.
  29. // Kubelet uses this object to determine whether pod information needs to be passed on mount.
  30. // CSIDriver objects are non-namespaced.
  31. message CSIDriver {
  32. // Standard object metadata.
  33. // metadata.Name indicates the name of the CSI driver that this object
  34. // refers to; it MUST be the same name returned by the CSI GetPluginName()
  35. // call for that driver.
  36. // The driver name must be 63 characters or less, beginning and ending with
  37. // an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and
  38. // alphanumerics between.
  39. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  40. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  41. // spec represents the specification of the CSI Driver.
  42. optional CSIDriverSpec spec = 2;
  43. }
  44. // CSIDriverList is a collection of CSIDriver objects.
  45. message CSIDriverList {
  46. // Standard list metadata
  47. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  48. // +optional
  49. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  50. // items is the list of CSIDriver
  51. repeated CSIDriver items = 2;
  52. }
  53. // CSIDriverSpec is the specification of a CSIDriver.
  54. message CSIDriverSpec {
  55. // attachRequired indicates this CSI volume driver requires an attach
  56. // operation (because it implements the CSI ControllerPublishVolume()
  57. // method), and that the Kubernetes attach detach controller should call
  58. // the attach volume interface which checks the volumeattachment status
  59. // and waits until the volume is attached before proceeding to mounting.
  60. // The CSI external-attacher coordinates with CSI volume driver and updates
  61. // the volumeattachment status when the attach operation is complete.
  62. // If the value is specified to false, the attach operation will be skipped.
  63. // Otherwise the attach operation will be called.
  64. //
  65. // This field is immutable.
  66. //
  67. // +optional
  68. optional bool attachRequired = 1;
  69. // podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.)
  70. // during mount operations, if set to true.
  71. // If set to false, pod information will not be passed on mount.
  72. // Default is false.
  73. //
  74. // The CSI driver specifies podInfoOnMount as part of driver deployment.
  75. // If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls.
  76. // The CSI driver is responsible for parsing and validating the information passed in as VolumeContext.
  77. //
  78. // The following VolumeContext will be passed if podInfoOnMount is set to true.
  79. // This list might grow, but the prefix will be used.
  80. // "csi.storage.k8s.io/pod.name": pod.Name
  81. // "csi.storage.k8s.io/pod.namespace": pod.Namespace
  82. // "csi.storage.k8s.io/pod.uid": string(pod.UID)
  83. // "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume
  84. // defined by a CSIVolumeSource, otherwise "false"
  85. //
  86. // "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only
  87. // required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode.
  88. // Other drivers can leave pod info disabled and/or ignore this field.
  89. // As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when
  90. // deployed on such a cluster and the deployment determines which mode that is, for example
  91. // via a command line parameter of the driver.
  92. //
  93. // This field is immutable.
  94. //
  95. // +optional
  96. optional bool podInfoOnMount = 2;
  97. // volumeLifecycleModes defines what kind of volumes this CSI volume driver supports.
  98. // The default if the list is empty is "Persistent", which is the usage defined by the
  99. // CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism.
  100. //
  101. // The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec
  102. // with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod.
  103. // A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume.
  104. //
  105. // For more information about implementing this mode, see
  106. // https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html
  107. // A driver can support one or more of these modes and
  108. // more modes may be added in the future.
  109. //
  110. // This field is immutable.
  111. //
  112. // +optional
  113. // +listType=atomic
  114. repeated string volumeLifecycleModes = 3;
  115. // storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage
  116. // capacity that the driver deployment will report by creating
  117. // CSIStorageCapacity objects with capacity information, if set to true.
  118. //
  119. // The check can be enabled immediately when deploying a driver.
  120. // In that case, provisioning new volumes with late binding
  121. // will pause until the driver deployment has published
  122. // some suitable CSIStorageCapacity object.
  123. //
  124. // Alternatively, the driver can be deployed with the field
  125. // unset or false and it can be flipped later when storage
  126. // capacity information has been published.
  127. //
  128. // This field was immutable in Kubernetes <= 1.22 and now is mutable.
  129. //
  130. // +optional
  131. optional bool storageCapacity = 4;
  132. // fsGroupPolicy defines if the underlying volume supports changing ownership and
  133. // permission of the volume before being mounted.
  134. // Refer to the specific FSGroupPolicy values for additional details.
  135. //
  136. // This field is immutable.
  137. //
  138. // Defaults to ReadWriteOnceWithFSType, which will examine each volume
  139. // to determine if Kubernetes should modify ownership and permissions of the volume.
  140. // With the default policy the defined fsGroup will only be applied
  141. // if a fstype is defined and the volume's access mode contains ReadWriteOnce.
  142. //
  143. // +optional
  144. optional string fsGroupPolicy = 5;
  145. // tokenRequests indicates the CSI driver needs pods' service account
  146. // tokens it is mounting volume for to do necessary authentication. Kubelet
  147. // will pass the tokens in VolumeContext in the CSI NodePublishVolume calls.
  148. // The CSI driver should parse and validate the following VolumeContext:
  149. // "csi.storage.k8s.io/serviceAccount.tokens": {
  150. // "<audience>": {
  151. // "token": <token>,
  152. // "expirationTimestamp": <expiration timestamp in RFC3339>,
  153. // },
  154. // ...
  155. // }
  156. //
  157. // Note: Audience in each TokenRequest should be different and at
  158. // most one token is empty string. To receive a new token after expiry,
  159. // RequiresRepublish can be used to trigger NodePublishVolume periodically.
  160. //
  161. // +optional
  162. // +listType=atomic
  163. repeated TokenRequest tokenRequests = 6;
  164. // requiresRepublish indicates the CSI driver wants `NodePublishVolume`
  165. // being periodically called to reflect any possible change in the mounted
  166. // volume. This field defaults to false.
  167. //
  168. // Note: After a successful initial NodePublishVolume call, subsequent calls
  169. // to NodePublishVolume should only update the contents of the volume. New
  170. // mount points will not be seen by a running container.
  171. //
  172. // +optional
  173. optional bool requiresRepublish = 7;
  174. // seLinuxMount specifies if the CSI driver supports "-o context"
  175. // mount option.
  176. //
  177. // When "true", the CSI driver must ensure that all volumes provided by this CSI
  178. // driver can be mounted separately with different `-o context` options. This is
  179. // typical for storage backends that provide volumes as filesystems on block
  180. // devices or as independent shared volumes.
  181. // Kubernetes will call NodeStage / NodePublish with "-o context=xyz" mount
  182. // option when mounting a ReadWriteOncePod volume used in Pod that has
  183. // explicitly set SELinux context. In the future, it may be expanded to other
  184. // volume AccessModes. In any case, Kubernetes will ensure that the volume is
  185. // mounted only with a single SELinux context.
  186. //
  187. // When "false", Kubernetes won't pass any special SELinux mount options to the driver.
  188. // This is typical for volumes that represent subdirectories of a bigger shared filesystem.
  189. //
  190. // Default is "false".
  191. //
  192. // +featureGate=SELinuxMountReadWriteOncePod
  193. // +optional
  194. optional bool seLinuxMount = 8;
  195. // nodeAllocatableUpdatePeriodSeconds specifies the interval between periodic updates of
  196. // the CSINode allocatable capacity for this driver. When set, both periodic updates and
  197. // updates triggered by capacity-related failures are enabled. If not set, no updates
  198. // occur (neither periodic nor upon detecting capacity-related failures), and the
  199. // allocatable.count remains static. The minimum allowed value for this field is 10 seconds.
  200. //
  201. // This is a beta feature and requires the MutableCSINodeAllocatableCount feature gate to be enabled.
  202. //
  203. // This field is mutable.
  204. //
  205. // +featureGate=MutableCSINodeAllocatableCount
  206. // +optional
  207. optional int64 nodeAllocatableUpdatePeriodSeconds = 9;
  208. // serviceAccountTokenInSecrets is an opt-in for CSI drivers to indicate that
  209. // service account tokens should be passed via the Secrets field in NodePublishVolumeRequest
  210. // instead of the VolumeContext field. The CSI specification provides a dedicated Secrets
  211. // field for sensitive information like tokens, which is the appropriate mechanism for
  212. // handling credentials. This addresses security concerns where sensitive tokens were being
  213. // logged as part of volume context.
  214. //
  215. // When "true", kubelet will pass the tokens only in the Secrets field with the key
  216. // "csi.storage.k8s.io/serviceAccount.tokens". The CSI driver must be updated to read
  217. // tokens from the Secrets field instead of VolumeContext.
  218. //
  219. // When "false" or not set, kubelet will pass the tokens in VolumeContext with the key
  220. // "csi.storage.k8s.io/serviceAccount.tokens" (existing behavior). This maintains backward
  221. // compatibility with existing CSI drivers.
  222. //
  223. // This field can only be set when TokenRequests is configured. The API server will reject
  224. // CSIDriver specs that set this field without TokenRequests.
  225. //
  226. // Default behavior if unset is to pass tokens in the VolumeContext field.
  227. //
  228. // +featureGate=CSIServiceAccountTokenSecrets
  229. // +optional
  230. optional bool serviceAccountTokenInSecrets = 10;
  231. }
  232. // DEPRECATED - This group version of CSINode is deprecated by storage/v1/CSINode.
  233. // See the release notes for more information.
  234. // CSINode holds information about all CSI drivers installed on a node.
  235. // CSI drivers do not need to create the CSINode object directly. As long as
  236. // they use the node-driver-registrar sidecar container, the kubelet will
  237. // automatically populate the CSINode object for the CSI driver as part of
  238. // kubelet plugin registration.
  239. // CSINode has the same name as a node. If the object is missing, it means either
  240. // there are no CSI Drivers available on the node, or the Kubelet version is low
  241. // enough that it doesn't create this object.
  242. // CSINode has an OwnerReference that points to the corresponding node object.
  243. message CSINode {
  244. // metadata.name must be the Kubernetes node name.
  245. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  246. // spec is the specification of CSINode
  247. optional CSINodeSpec spec = 2;
  248. }
  249. // CSINodeDriver holds information about the specification of one CSI driver installed on a node
  250. message CSINodeDriver {
  251. // name represents the name of the CSI driver that this object refers to.
  252. // This MUST be the same name returned by the CSI GetPluginName() call for
  253. // that driver.
  254. optional string name = 1;
  255. // nodeID of the node from the driver point of view.
  256. // This field enables Kubernetes to communicate with storage systems that do
  257. // not share the same nomenclature for nodes. For example, Kubernetes may
  258. // refer to a given node as "node1", but the storage system may refer to
  259. // the same node as "nodeA". When Kubernetes issues a command to the storage
  260. // system to attach a volume to a specific node, it can use this field to
  261. // refer to the node name using the ID that the storage system will
  262. // understand, e.g. "nodeA" instead of "node1". This field is required.
  263. optional string nodeID = 2;
  264. // topologyKeys is the list of keys supported by the driver.
  265. // When a driver is initialized on a cluster, it provides a set of topology
  266. // keys that it understands (e.g. "company.com/zone", "company.com/region").
  267. // When a driver is initialized on a node, it provides the same topology keys
  268. // along with values. Kubelet will expose these topology keys as labels
  269. // on its own node object.
  270. // When Kubernetes does topology aware provisioning, it can use this list to
  271. // determine which labels it should retrieve from the node object and pass
  272. // back to the driver.
  273. // It is possible for different nodes to use different topology keys.
  274. // This can be empty if driver does not support topology.
  275. // +optional
  276. // +listType=atomic
  277. repeated string topologyKeys = 3;
  278. // allocatable represents the volume resources of a node that are available for scheduling.
  279. // +optional
  280. optional VolumeNodeResources allocatable = 4;
  281. }
  282. // CSINodeList is a collection of CSINode objects.
  283. message CSINodeList {
  284. // Standard list metadata
  285. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  286. // +optional
  287. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  288. // items is the list of CSINode
  289. repeated CSINode items = 2;
  290. }
  291. // CSINodeSpec holds information about the specification of all CSI drivers installed on a node
  292. message CSINodeSpec {
  293. // drivers is a list of information of all CSI Drivers existing on a node.
  294. // If all drivers in the list are uninstalled, this can become empty.
  295. // +patchMergeKey=name
  296. // +patchStrategy=merge
  297. // +listType=map
  298. // +listMapKey=name
  299. repeated CSINodeDriver drivers = 1;
  300. }
  301. // CSIStorageCapacity stores the result of one CSI GetCapacity call.
  302. // For a given StorageClass, this describes the available capacity in a
  303. // particular topology segment. This can be used when considering where to
  304. // instantiate new PersistentVolumes.
  305. //
  306. // For example this can express things like:
  307. // - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1"
  308. // - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123"
  309. //
  310. // The following three cases all imply that no capacity is available for
  311. // a certain combination:
  312. // - no object exists with suitable topology and storage class name
  313. // - such an object exists, but the capacity is unset
  314. // - such an object exists, but the capacity is zero
  315. //
  316. // The producer of these objects can decide which approach is more suitable.
  317. //
  318. // They are consumed by the kube-scheduler when a CSI driver opts into
  319. // capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler
  320. // compares the MaximumVolumeSize against the requested size of pending volumes
  321. // to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back
  322. // to a comparison against the less precise Capacity. If that is also unset,
  323. // the scheduler assumes that capacity is insufficient and tries some other
  324. // node.
  325. message CSIStorageCapacity {
  326. // Standard object's metadata. The name has no particular meaning. It must be
  327. // be a DNS subdomain (dots allowed, 253 characters). To ensure that
  328. // there are no conflicts with other CSI drivers on the cluster, the recommendation
  329. // is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends
  330. // with the unique CSI driver name.
  331. //
  332. // Objects are namespaced.
  333. //
  334. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  335. // +optional
  336. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  337. // nodeTopology defines which nodes have access to the storage
  338. // for which capacity was reported. If not set, the storage is
  339. // not accessible from any node in the cluster. If empty, the
  340. // storage is accessible from all nodes. This field is
  341. // immutable.
  342. //
  343. // +optional
  344. optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector nodeTopology = 2;
  345. // storageClassName represents the name of the StorageClass that the reported capacity applies to.
  346. // It must meet the same requirements as the name of a StorageClass
  347. // object (non-empty, DNS subdomain). If that object no longer exists,
  348. // the CSIStorageCapacity object is obsolete and should be removed by its
  349. // creator.
  350. // This field is immutable.
  351. optional string storageClassName = 3;
  352. // capacity is the value reported by the CSI driver in its GetCapacityResponse
  353. // for a GetCapacityRequest with topology and parameters that match the
  354. // previous fields.
  355. //
  356. // The semantic is currently (CSI spec 1.2) defined as:
  357. // The available capacity, in bytes, of the storage that can be used
  358. // to provision volumes. If not set, that information is currently
  359. // unavailable.
  360. //
  361. // +optional
  362. optional .k8s.io.apimachinery.pkg.api.resource.Quantity capacity = 4;
  363. // maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse
  364. // for a GetCapacityRequest with topology and parameters that match the
  365. // previous fields.
  366. //
  367. // This is defined since CSI spec 1.4.0 as the largest size
  368. // that may be used in a
  369. // CreateVolumeRequest.capacity_range.required_bytes field to
  370. // create a volume with the same parameters as those in
  371. // GetCapacityRequest. The corresponding value in the Kubernetes
  372. // API is ResourceRequirements.Requests in a volume claim.
  373. //
  374. // +optional
  375. optional .k8s.io.apimachinery.pkg.api.resource.Quantity maximumVolumeSize = 5;
  376. }
  377. // CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
  378. message CSIStorageCapacityList {
  379. // Standard list metadata
  380. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  381. // +optional
  382. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  383. // items is the list of CSIStorageCapacity objects.
  384. repeated CSIStorageCapacity items = 2;
  385. }
  386. // StorageClass describes the parameters for a class of storage for
  387. // which PersistentVolumes can be dynamically provisioned.
  388. //
  389. // StorageClasses are non-namespaced; the name of the storage class
  390. // according to etcd is in ObjectMeta.Name.
  391. message StorageClass {
  392. // Standard object's metadata.
  393. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  394. // +optional
  395. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  396. // provisioner indicates the type of the provisioner.
  397. // +required
  398. // +k8s:required
  399. optional string provisioner = 2;
  400. // parameters holds the parameters for the provisioner that should
  401. // create volumes of this storage class.
  402. // +optional
  403. map<string, string> parameters = 3;
  404. // reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class.
  405. // Defaults to Delete.
  406. // +optional
  407. optional string reclaimPolicy = 4;
  408. // mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class.
  409. // e.g. ["ro", "soft"]. Not validated -
  410. // mount of the PVs will simply fail if one is invalid.
  411. // +optional
  412. // +listType=atomic
  413. repeated string mountOptions = 5;
  414. // allowVolumeExpansion shows whether the storage class allow volume expand
  415. // +optional
  416. optional bool allowVolumeExpansion = 6;
  417. // volumeBindingMode indicates how PersistentVolumeClaims should be
  418. // provisioned and bound. When unset, VolumeBindingImmediate is used.
  419. // This field is only honored by servers that enable the VolumeScheduling feature.
  420. // +optional
  421. optional string volumeBindingMode = 7;
  422. // allowedTopologies restrict the node topologies where volumes can be dynamically provisioned.
  423. // Each volume plugin defines its own supported topology specifications.
  424. // An empty TopologySelectorTerm list means there is no topology restriction.
  425. // This field is only honored by servers that enable the VolumeScheduling feature.
  426. // +optional
  427. // +listType=atomic
  428. repeated .k8s.io.api.core.v1.TopologySelectorTerm allowedTopologies = 8;
  429. }
  430. // StorageClassList is a collection of storage classes.
  431. message StorageClassList {
  432. // Standard list metadata
  433. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  434. // +optional
  435. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  436. // items is the list of StorageClasses
  437. repeated StorageClass items = 2;
  438. }
  439. // TokenRequest contains parameters of a service account token.
  440. message TokenRequest {
  441. // audience is the intended audience of the token in "TokenRequestSpec".
  442. // It will default to the audiences of kube apiserver.
  443. optional string audience = 1;
  444. // expirationSeconds is the duration of validity of the token in "TokenRequestSpec".
  445. // It has the same default value of "ExpirationSeconds" in "TokenRequestSpec"
  446. //
  447. // +optional
  448. optional int64 expirationSeconds = 2;
  449. }
  450. // VolumeAttachment captures the intent to attach or detach the specified volume
  451. // to/from the specified node.
  452. //
  453. // VolumeAttachment objects are non-namespaced.
  454. message VolumeAttachment {
  455. // Standard object metadata.
  456. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  457. // +optional
  458. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  459. // spec represents specification of the desired attach/detach volume behavior.
  460. // Populated by the Kubernetes system.
  461. optional VolumeAttachmentSpec spec = 2;
  462. // status represents status of the VolumeAttachment request.
  463. // Populated by the entity completing the attach or detach
  464. // operation, i.e. the external-attacher.
  465. // +optional
  466. optional VolumeAttachmentStatus status = 3;
  467. }
  468. // VolumeAttachmentList is a collection of VolumeAttachment objects.
  469. message VolumeAttachmentList {
  470. // Standard list metadata
  471. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  472. // +optional
  473. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  474. // items is the list of VolumeAttachments
  475. repeated VolumeAttachment items = 2;
  476. }
  477. // VolumeAttachmentSource represents a volume that should be attached.
  478. // Right now only PersistentVolumes can be attached via external attacher,
  479. // in the future we may allow also inline volumes in pods.
  480. // Exactly one member can be set.
  481. message VolumeAttachmentSource {
  482. // persistentVolumeName represents the name of the persistent volume to attach.
  483. // +optional
  484. optional string persistentVolumeName = 1;
  485. // inlineVolumeSpec contains all the information necessary to attach
  486. // a persistent volume defined by a pod's inline VolumeSource. This field
  487. // is populated only for the CSIMigration feature. It contains
  488. // translated fields from a pod's inline VolumeSource to a
  489. // PersistentVolumeSpec. This field is beta-level and is only
  490. // honored by servers that enabled the CSIMigration feature.
  491. // +optional
  492. optional .k8s.io.api.core.v1.PersistentVolumeSpec inlineVolumeSpec = 2;
  493. }
  494. // VolumeAttachmentSpec is the specification of a VolumeAttachment request.
  495. message VolumeAttachmentSpec {
  496. // attacher indicates the name of the volume driver that MUST handle this
  497. // request. This is the name returned by GetPluginName().
  498. optional string attacher = 1;
  499. // source represents the volume that should be attached.
  500. optional VolumeAttachmentSource source = 2;
  501. // nodeName represents the node that the volume should be attached to.
  502. optional string nodeName = 3;
  503. }
  504. // VolumeAttachmentStatus is the status of a VolumeAttachment request.
  505. message VolumeAttachmentStatus {
  506. // attached indicates the volume is successfully attached.
  507. // This field must only be set by the entity completing the attach
  508. // operation, i.e. the external-attacher.
  509. optional bool attached = 1;
  510. // attachmentMetadata is populated with any
  511. // information returned by the attach operation, upon successful attach, that must be passed
  512. // into subsequent WaitForAttach or Mount calls.
  513. // This field must only be set by the entity completing the attach
  514. // operation, i.e. the external-attacher.
  515. // +optional
  516. map<string, string> attachmentMetadata = 2;
  517. // attachError represents the last error encountered during attach operation, if any.
  518. // This field must only be set by the entity completing the attach
  519. // operation, i.e. the external-attacher.
  520. // +optional
  521. optional VolumeError attachError = 3;
  522. // detachError represents the last error encountered during detach operation, if any.
  523. // This field must only be set by the entity completing the detach
  524. // operation, i.e. the external-attacher.
  525. // +optional
  526. optional VolumeError detachError = 4;
  527. }
  528. // VolumeAttributesClass represents a specification of mutable volume attributes
  529. // defined by the CSI driver. The class can be specified during dynamic provisioning
  530. // of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.
  531. message VolumeAttributesClass {
  532. // Standard object's metadata.
  533. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  534. // +optional
  535. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  536. // Name of the CSI driver
  537. // This field is immutable.
  538. optional string driverName = 2;
  539. // parameters hold volume attributes defined by the CSI driver. These values
  540. // are opaque to the Kubernetes and are passed directly to the CSI driver.
  541. // The underlying storage provider supports changing these attributes on an
  542. // existing volume, however the parameters field itself is immutable. To
  543. // invoke a volume update, a new VolumeAttributesClass should be created with
  544. // new parameters, and the PersistentVolumeClaim should be updated to reference
  545. // the new VolumeAttributesClass.
  546. //
  547. // This field is required and must contain at least one key/value pair.
  548. // The keys cannot be empty, and the maximum number of parameters is 512, with
  549. // a cumulative max size of 256K. If the CSI driver rejects invalid parameters,
  550. // the target PersistentVolumeClaim will be set to an "Infeasible" state in the
  551. // modifyVolumeStatus field.
  552. map<string, string> parameters = 3;
  553. }
  554. // VolumeAttributesClassList is a collection of VolumeAttributesClass objects.
  555. message VolumeAttributesClassList {
  556. // Standard list metadata
  557. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  558. // +optional
  559. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  560. // items is the list of VolumeAttributesClass objects.
  561. repeated VolumeAttributesClass items = 2;
  562. }
  563. // VolumeError captures an error encountered during a volume operation.
  564. message VolumeError {
  565. // time represents the time the error was encountered.
  566. // +optional
  567. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time time = 1;
  568. // message represents the error encountered during Attach or Detach operation.
  569. // This string may be logged, so it should not contain sensitive
  570. // information.
  571. // +optional
  572. optional string message = 2;
  573. // errorCode is a numeric gRPC code representing the error encountered during Attach or Detach operations.
  574. //
  575. // This is an optional, beta field that requires the MutableCSINodeAllocatableCount feature gate being enabled to be set.
  576. //
  577. // +featureGate=MutableCSINodeAllocatableCount
  578. // +optional
  579. optional int32 errorCode = 3;
  580. }
  581. // VolumeNodeResources is a set of resource limits for scheduling of volumes.
  582. message VolumeNodeResources {
  583. // count indicates the maximum number of unique volumes managed by the CSI driver that can be used on a node.
  584. // A volume that is both attached and mounted on a node is considered to be used once, not twice.
  585. // The same rule applies for a unique volume that is shared among multiple pods on the same node.
  586. // If this field is nil, then the supported number of volumes on this node is unbounded.
  587. // +optional
  588. optional int32 count = 1;
  589. }