Switch to go modules

vendor/k8s.io/api/storage/v1beta1/generated.proto

@@ -29,9 +29,146 @@ import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
 // Package-wide variables from generator "generated".
 option go_package = "v1beta1";
 
+// CSIDriver captures information about a Container Storage Interface (CSI)
+// volume driver deployed on the cluster.
+// CSI drivers do not need to create the CSIDriver object directly. Instead they may use the
+// cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically
+// creates a CSIDriver object representing the driver.
+// Kubernetes attach detach controller uses this object to determine whether attach is required.
+// Kubelet uses this object to determine whether pod information needs to be passed on mount.
+// CSIDriver objects are non-namespaced.
+message CSIDriver {
+  // Standard object metadata.
+  // metadata.Name indicates the name of the CSI driver that this object
+  // refers to; it MUST be the same name returned by the CSI GetPluginName()
+  // call for that driver.
+  // The driver name must be 63 characters or less, beginning and ending with
+  // an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and
+  // alphanumerics between.
+  // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
+
+  // Specification of the CSI Driver.
+  optional CSIDriverSpec spec = 2;
+}
+
+// CSIDriverList is a collection of CSIDriver objects.
+message CSIDriverList {
+  // Standard list metadata
+  // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+  // +optional
+  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
+
+  // items is the list of CSIDriver
+  repeated CSIDriver items = 2;
+}
+
+// CSIDriverSpec is the specification of a CSIDriver.
+message CSIDriverSpec {
+  // 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.
+  // +optional
+  optional bool attachRequired = 1;
+
+  // If set to true, podInfoOnMount indicates this CSI volume driver
+  // requires additional pod information (like podName, podUID, etc.) during
+  // mount operations.
+  // If set to false, pod information will not be passed on mount.
+  // Default is false.
+  // 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.
+  // 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)
+  // +optional
+  optional bool podInfoOnMount = 2;
+}
+
+// CSINode holds information about all CSI drivers installed on a node.
+// CSI drivers do not need to create the CSINode object directly. As long as
+// they use the node-driver-registrar sidecar container, the kubelet will
+// automatically populate the CSINode object for the CSI driver as part of
+// kubelet plugin registration.
+// CSINode has the same name as a node. If the object is missing, it means either
+// there are no CSI Drivers available on the node, or the Kubelet version is low
+// enough that it doesn't create this object.
+// CSINode has an OwnerReference that points to the corresponding node object.
+message CSINode {
+  // metadata.name must be the Kubernetes node name.
+  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
+
+  // spec is the specification of CSINode
+  optional CSINodeSpec spec = 2;
+}
+
+// CSINodeDriver holds information about the specification of one CSI driver installed on a node
+message CSINodeDriver {
+  // This is the name of the CSI driver that this object refers to.
+  // This MUST be the same name returned by the CSI GetPluginName() call for
+  // that driver.
+  optional string name = 1;
+
+  // nodeID of the node from the driver point of view.
+  // This field enables Kubernetes to communicate with storage systems that do
+  // not share the same nomenclature for nodes. For example, Kubernetes may
+  // refer to a given node as "node1", but the storage system may refer to
+  // the same node as "nodeA". When Kubernetes issues a command to the storage
+  // system to attach a volume to a specific node, it can use this field to
+  // refer to the node name using the ID that the storage system will
+  // understand, e.g. "nodeA" instead of "node1". This field is required.
+  optional string nodeID = 2;
+
+  // topologyKeys is the list of keys supported by the driver.
+  // When a driver is initialized on a cluster, it provides a set of topology
+  // keys that it understands (e.g. "company.com/zone", "company.com/region").
+  // When a driver is initialized on a node, it provides the same topology keys
+  // along with values. Kubelet will expose these topology keys as labels
+  // on its own node object.
+  // When Kubernetes does topology aware provisioning, it can use this list to
+  // determine which labels it should retrieve from the node object and pass
+  // back to the driver.
+  // It is possible for different nodes to use different topology keys.
+  // This can be empty if driver does not support topology.
+  // +optional
+  repeated string topologyKeys = 3;
+}
+
+// CSINodeList is a collection of CSINode objects.
+message CSINodeList {
+  // Standard list metadata
+  // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+  // +optional
+  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
+
+  // items is the list of CSINode
+  repeated CSINode items = 2;
+}
+
+// CSINodeSpec holds information about the specification of all CSI drivers installed on a node
+message CSINodeSpec {
+  // drivers is a list of information of all CSI Drivers existing on a node.
+  // If all drivers in the list are uninstalled, this can become empty.
+  // +patchMergeKey=name
+  // +patchStrategy=merge
+  repeated CSINodeDriver drivers = 1;
+}
+
 // StorageClass describes the parameters for a class of storage for
 // which PersistentVolumes can be dynamically provisioned.
-// 
+//
 // StorageClasses are non-namespaced; the name of the storage class
 // according to etcd is in ObjectMeta.Name.
 message StorageClass {
@@ -90,7 +227,7 @@ message StorageClassList {
 
 // VolumeAttachment captures the intent to attach or detach the specified volume
 // to/from the specified node.
-// 
+//
 // VolumeAttachment objects are non-namespaced.
 message VolumeAttachment {
   // Standard object metadata.
@@ -178,7 +315,7 @@ message VolumeError {
   optional k8s.io.apimachinery.pkg.apis.meta.v1.Time time = 1;
 
   // String detailing the error encountered during Attach or Detach operation.
-  // This string maybe logged, so it should not contain sensitive
+  // This string may be logged, so it should not contain sensitive
   // information.
   // +optional
   optional string message = 2;