189 lines
6.9 KiB
Protocol Buffer
189 lines
6.9 KiB
Protocol Buffer
/*
|
|
Copyright The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
|
|
// This file was autogenerated by go-to-protobuf. Do not edit it manually!
|
|
|
|
syntax = 'proto2';
|
|
|
|
package k8s.io.api.storage.v1beta1;
|
|
|
|
import "k8s.io/api/core/v1/generated.proto";
|
|
import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
|
|
import "k8s.io/apimachinery/pkg/runtime/generated.proto";
|
|
import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
|
|
|
|
// Package-wide variables from generator "generated".
|
|
option go_package = "v1beta1";
|
|
|
|
// 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 {
|
|
// Standard object's metadata.
|
|
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
|
|
|
|
// Provisioner indicates the type of the provisioner.
|
|
optional string provisioner = 2;
|
|
|
|
// Parameters holds the parameters for the provisioner that should
|
|
// create volumes of this storage class.
|
|
// +optional
|
|
map<string, string> parameters = 3;
|
|
|
|
// Dynamically provisioned PersistentVolumes of this storage class are
|
|
// created with this reclaimPolicy. Defaults to Delete.
|
|
// +optional
|
|
optional string reclaimPolicy = 4;
|
|
|
|
// Dynamically provisioned PersistentVolumes of this storage class are
|
|
// created with these mountOptions, e.g. ["ro", "soft"]. Not validated -
|
|
// mount of the PVs will simply fail if one is invalid.
|
|
// +optional
|
|
repeated string mountOptions = 5;
|
|
|
|
// AllowVolumeExpansion shows whether the storage class allow volume expand
|
|
// +optional
|
|
optional bool allowVolumeExpansion = 6;
|
|
|
|
// VolumeBindingMode indicates how PersistentVolumeClaims should be
|
|
// provisioned and bound. When unset, VolumeBindingImmediate is used.
|
|
// This field is alpha-level and is only honored by servers that enable
|
|
// the VolumeScheduling feature.
|
|
// +optional
|
|
optional string volumeBindingMode = 7;
|
|
|
|
// Restrict the node topologies where volumes can be dynamically provisioned.
|
|
// Each volume plugin defines its own supported topology specifications.
|
|
// An empty TopologySelectorTerm list means there is no topology restriction.
|
|
// This field is alpha-level and is only honored by servers that enable
|
|
// the DynamicProvisioningScheduling feature.
|
|
// +optional
|
|
repeated k8s.io.api.core.v1.TopologySelectorTerm allowedTopologies = 8;
|
|
}
|
|
|
|
// StorageClassList is a collection of storage classes.
|
|
message StorageClassList {
|
|
// 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 StorageClasses
|
|
repeated StorageClass items = 2;
|
|
}
|
|
|
|
// 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.
|
|
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
|
|
|
|
// Specification of the desired attach/detach volume behavior.
|
|
// Populated by the Kubernetes system.
|
|
optional VolumeAttachmentSpec spec = 2;
|
|
|
|
// Status of the VolumeAttachment request.
|
|
// Populated by the entity completing the attach or detach
|
|
// operation, i.e. the external-attacher.
|
|
// +optional
|
|
optional VolumeAttachmentStatus status = 3;
|
|
}
|
|
|
|
// VolumeAttachmentList is a collection of VolumeAttachment objects.
|
|
message VolumeAttachmentList {
|
|
// 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 VolumeAttachments
|
|
repeated VolumeAttachment items = 2;
|
|
}
|
|
|
|
// 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.
|
|
message VolumeAttachmentSource {
|
|
// Name of the persistent volume to attach.
|
|
// +optional
|
|
optional string persistentVolumeName = 1;
|
|
}
|
|
|
|
// VolumeAttachmentSpec is the specification of a VolumeAttachment request.
|
|
message VolumeAttachmentSpec {
|
|
// Attacher indicates the name of the volume driver that MUST handle this
|
|
// request. This is the name returned by GetPluginName().
|
|
optional string attacher = 1;
|
|
|
|
// Source represents the volume that should be attached.
|
|
optional VolumeAttachmentSource source = 2;
|
|
|
|
// The node that the volume should be attached to.
|
|
optional string nodeName = 3;
|
|
}
|
|
|
|
// VolumeAttachmentStatus is the status of a VolumeAttachment request.
|
|
message VolumeAttachmentStatus {
|
|
// Indicates the volume is successfully attached.
|
|
// This field must only be set by the entity completing the attach
|
|
// operation, i.e. the external-attacher.
|
|
optional bool attached = 1;
|
|
|
|
// Upon successful attach, this field is populated with any
|
|
// information returned by the attach operation that must be passed
|
|
// into subsequent WaitForAttach or Mount calls.
|
|
// This field must only be set by the entity completing the attach
|
|
// operation, i.e. the external-attacher.
|
|
// +optional
|
|
map<string, string> attachmentMetadata = 2;
|
|
|
|
// The last error encountered during attach operation, if any.
|
|
// This field must only be set by the entity completing the attach
|
|
// operation, i.e. the external-attacher.
|
|
// +optional
|
|
optional VolumeError attachError = 3;
|
|
|
|
// The last error encountered during detach operation, if any.
|
|
// This field must only be set by the entity completing the detach
|
|
// operation, i.e. the external-attacher.
|
|
// +optional
|
|
optional VolumeError detachError = 4;
|
|
}
|
|
|
|
// VolumeError captures an error encountered during a volume operation.
|
|
message VolumeError {
|
|
// Time the error was encountered.
|
|
// +optional
|
|
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
|
|
// information.
|
|
// +optional
|
|
optional string message = 2;
|
|
}
|
|
|