cmd/bpa-operator/vendor/k8s.io/api/storage/v1beta1/generated.proto

   1 /*
   2 Copyright The Kubernetes Authors.
   3
   4 Licensed under the Apache License, Version 2.0 (the "License");
   5 you may not use this file except in compliance with the License.
   6 You may obtain a copy of the License at
   7
   8     http://www.apache.org/licenses/LICENSE-2.0
   9
  10 Unless required by applicable law or agreed to in writing, software
  11 distributed under the License is distributed on an "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 See the License for the specific language governing permissions and
  14 limitations under the License.
  15 */
  16
  17
  18 // This file was autogenerated by go-to-protobuf. Do not edit it manually!
  19
  20 syntax = 'proto2';
  21
  22 package k8s.io.api.storage.v1beta1;
  23
  24 import "k8s.io/api/core/v1/generated.proto";
  25 import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
  26 import "k8s.io/apimachinery/pkg/runtime/generated.proto";
  27 import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
  28
  29 // Package-wide variables from generator "generated".
  30 option go_package = "v1beta1";
  31
  32 // StorageClass describes the parameters for a class of storage for
  33 // which PersistentVolumes can be dynamically provisioned.
  34 //
  35 // StorageClasses are non-namespaced; the name of the storage class
  36 // according to etcd is in ObjectMeta.Name.
  37 message StorageClass {
  38   // Standard object's metadata.
  39   // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
  40   // +optional
  41   optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  42
  43   // Provisioner indicates the type of the provisioner.
  44   optional string provisioner = 2;
  45
  46   // Parameters holds the parameters for the provisioner that should
  47   // create volumes of this storage class.
  48   // +optional
  49   map<string, string> parameters = 3;
  50
  51   // Dynamically provisioned PersistentVolumes of this storage class are
  52   // created with this reclaimPolicy. Defaults to Delete.
  53   // +optional
  54   optional string reclaimPolicy = 4;
  55
  56   // Dynamically provisioned PersistentVolumes of this storage class are
  57   // created with these mountOptions, e.g. ["ro", "soft"]. Not validated -
  58   // mount of the PVs will simply fail if one is invalid.
  59   // +optional
  60   repeated string mountOptions = 5;
  61
  62   // AllowVolumeExpansion shows whether the storage class allow volume expand
  63   // +optional
  64   optional bool allowVolumeExpansion = 6;
  65
  66   // VolumeBindingMode indicates how PersistentVolumeClaims should be
  67   // provisioned and bound.  When unset, VolumeBindingImmediate is used.
  68   // This field is only honored by servers that enable the VolumeScheduling feature.
  69   // +optional
  70   optional string volumeBindingMode = 7;
  71
  72   // Restrict the node topologies where volumes can be dynamically provisioned.
  73   // Each volume plugin defines its own supported topology specifications.
  74   // An empty TopologySelectorTerm list means there is no topology restriction.
  75   // This field is only honored by servers that enable the VolumeScheduling feature.
  76   // +optional
  77   repeated k8s.io.api.core.v1.TopologySelectorTerm allowedTopologies = 8;
  78 }
  79
  80 // StorageClassList is a collection of storage classes.
  81 message StorageClassList {
  82   // Standard list metadata
  83   // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
  84   // +optional
  85   optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  86
  87   // Items is the list of StorageClasses
  88   repeated StorageClass items = 2;
  89 }
  90
  91 // VolumeAttachment captures the intent to attach or detach the specified volume
  92 // to/from the specified node.
  93 //
  94 // VolumeAttachment objects are non-namespaced.
  95 message VolumeAttachment {
  96   // Standard object metadata.
  97   // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
  98   // +optional
  99   optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
 100
 101   // Specification of the desired attach/detach volume behavior.
 102   // Populated by the Kubernetes system.
 103   optional VolumeAttachmentSpec spec = 2;
 104
 105   // Status of the VolumeAttachment request.
 106   // Populated by the entity completing the attach or detach
 107   // operation, i.e. the external-attacher.
 108   // +optional
 109   optional VolumeAttachmentStatus status = 3;
 110 }
 111
 112 // VolumeAttachmentList is a collection of VolumeAttachment objects.
 113 message VolumeAttachmentList {
 114   // Standard list metadata
 115   // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
 116   // +optional
 117   optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
 118
 119   // Items is the list of VolumeAttachments
 120   repeated VolumeAttachment items = 2;
 121 }
 122
 123 // VolumeAttachmentSource represents a volume that should be attached.
 124 // Right now only PersistenVolumes can be attached via external attacher,
 125 // in future we may allow also inline volumes in pods.
 126 // Exactly one member can be set.
 127 message VolumeAttachmentSource {
 128   // Name of the persistent volume to attach.
 129   // +optional
 130   optional string persistentVolumeName = 1;
 131 }
 132
 133 // VolumeAttachmentSpec is the specification of a VolumeAttachment request.
 134 message VolumeAttachmentSpec {
 135   // Attacher indicates the name of the volume driver that MUST handle this
 136   // request. This is the name returned by GetPluginName().
 137   optional string attacher = 1;
 138
 139   // Source represents the volume that should be attached.
 140   optional VolumeAttachmentSource source = 2;
 141
 142   // The node that the volume should be attached to.
 143   optional string nodeName = 3;
 144 }
 145
 146 // VolumeAttachmentStatus is the status of a VolumeAttachment request.
 147 message VolumeAttachmentStatus {
 148   // Indicates the volume is successfully attached.
 149   // This field must only be set by the entity completing the attach
 150   // operation, i.e. the external-attacher.
 151   optional bool attached = 1;
 152
 153   // Upon successful attach, this field is populated with any
 154   // information returned by the attach operation that must be passed
 155   // into subsequent WaitForAttach or Mount calls.
 156   // This field must only be set by the entity completing the attach
 157   // operation, i.e. the external-attacher.
 158   // +optional
 159   map<string, string> attachmentMetadata = 2;
 160
 161   // The last error encountered during attach operation, if any.
 162   // This field must only be set by the entity completing the attach
 163   // operation, i.e. the external-attacher.
 164   // +optional
 165   optional VolumeError attachError = 3;
 166
 167   // The last error encountered during detach operation, if any.
 168   // This field must only be set by the entity completing the detach
 169   // operation, i.e. the external-attacher.
 170   // +optional
 171   optional VolumeError detachError = 4;
 172 }
 173
 174 // VolumeError captures an error encountered during a volume operation.
 175 message VolumeError {
 176   // Time the error was encountered.
 177   // +optional
 178   optional k8s.io.apimachinery.pkg.apis.meta.v1.Time time = 1;
 179
 180   // String detailing the error encountered during Attach or Detach operation.
 181   // This string maybe logged, so it should not contain sensitive
 182   // information.
 183   // +optional
 184   optional string message = 2;
 185 }
 186