mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-12-18 11:00:25 +00:00
270 lines
11 KiB
Protocol Buffer
270 lines
11 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.v1alpha1;
|
|
|
|
import "k8s.io/api/core/v1/generated.proto";
|
|
import "k8s.io/apimachinery/pkg/api/resource/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 = "k8s.io/api/storage/v1alpha1";
|
|
|
|
// CSIStorageCapacity stores the result of one CSI GetCapacity call.
|
|
// For a given StorageClass, this describes the available capacity in a
|
|
// particular topology segment. This can be used when considering where to
|
|
// instantiate new PersistentVolumes.
|
|
//
|
|
// For example this can express things like:
|
|
// - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1"
|
|
// - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123"
|
|
//
|
|
// The following three cases all imply that no capacity is available for
|
|
// a certain combination:
|
|
// - no object exists with suitable topology and storage class name
|
|
// - such an object exists, but the capacity is unset
|
|
// - such an object exists, but the capacity is zero
|
|
//
|
|
// The producer of these objects can decide which approach is more suitable.
|
|
//
|
|
// They are consumed by the kube-scheduler when a CSI driver opts into
|
|
// capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler
|
|
// compares the MaximumVolumeSize against the requested size of pending volumes
|
|
// to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back
|
|
// to a comparison against the less precise Capacity. If that is also unset,
|
|
// the scheduler assumes that capacity is insufficient and tries some other
|
|
// node.
|
|
message CSIStorageCapacity {
|
|
// Standard object's metadata. The name has no particular meaning. It must be
|
|
// be a DNS subdomain (dots allowed, 253 characters). To ensure that
|
|
// there are no conflicts with other CSI drivers on the cluster, the recommendation
|
|
// is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends
|
|
// with the unique CSI driver name.
|
|
//
|
|
// Objects are namespaced.
|
|
//
|
|
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
|
|
|
|
// nodeTopology defines which nodes have access to the storage
|
|
// for which capacity was reported. If not set, the storage is
|
|
// not accessible from any node in the cluster. If empty, the
|
|
// storage is accessible from all nodes. This field is
|
|
// immutable.
|
|
//
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector nodeTopology = 2;
|
|
|
|
// storageClassName represents the name of the StorageClass that the reported capacity applies to.
|
|
// It must meet the same requirements as the name of a StorageClass
|
|
// object (non-empty, DNS subdomain). If that object no longer exists,
|
|
// the CSIStorageCapacity object is obsolete and should be removed by its
|
|
// creator.
|
|
// This field is immutable.
|
|
optional string storageClassName = 3;
|
|
|
|
// capacity is the value reported by the CSI driver in its GetCapacityResponse
|
|
// for a GetCapacityRequest with topology and parameters that match the
|
|
// previous fields.
|
|
//
|
|
// The semantic is currently (CSI spec 1.2) defined as:
|
|
// The available capacity, in bytes, of the storage that can be used
|
|
// to provision volumes. If not set, that information is currently
|
|
// unavailable.
|
|
//
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.api.resource.Quantity capacity = 4;
|
|
|
|
// maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse
|
|
// for a GetCapacityRequest with topology and parameters that match the
|
|
// previous fields.
|
|
//
|
|
// This is defined since CSI spec 1.4.0 as the largest size
|
|
// that may be used in a
|
|
// CreateVolumeRequest.capacity_range.required_bytes field to
|
|
// create a volume with the same parameters as those in
|
|
// GetCapacityRequest. The corresponding value in the Kubernetes
|
|
// API is ResourceRequirements.Requests in a volume claim.
|
|
//
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.api.resource.Quantity maximumVolumeSize = 5;
|
|
}
|
|
|
|
// CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
|
|
message CSIStorageCapacityList {
|
|
// Standard list metadata
|
|
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
|
|
|
|
// items is the list of CSIStorageCapacity objects.
|
|
repeated CSIStorageCapacity 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/sig-architecture/api-conventions.md#metadata
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
|
|
|
|
// spec represents specification of the desired attach/detach volume behavior.
|
|
// Populated by the Kubernetes system.
|
|
optional VolumeAttachmentSpec spec = 2;
|
|
|
|
// status represents 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/sig-architecture/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 {
|
|
// persistentVolumeName represents the name of the persistent volume to attach.
|
|
// +optional
|
|
optional string persistentVolumeName = 1;
|
|
|
|
// inlineVolumeSpec contains all the information necessary to attach
|
|
// a persistent volume defined by a pod's inline VolumeSource. This field
|
|
// is populated only for the CSIMigration feature. It contains
|
|
// translated fields from a pod's inline VolumeSource to a
|
|
// PersistentVolumeSpec. This field is alpha-level and is only
|
|
// honored by servers that enabled the CSIMigration feature.
|
|
// +optional
|
|
optional k8s.io.api.core.v1.PersistentVolumeSpec inlineVolumeSpec = 2;
|
|
}
|
|
|
|
// 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;
|
|
|
|
// nodeName represents the node that the volume should be attached to.
|
|
optional string nodeName = 3;
|
|
}
|
|
|
|
// VolumeAttachmentStatus is the status of a VolumeAttachment request.
|
|
message VolumeAttachmentStatus {
|
|
// attached 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;
|
|
|
|
// attachmentMetadata is populated with any
|
|
// information returned by the attach operation, upon successful attach, 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;
|
|
|
|
// attachError represents 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;
|
|
|
|
// detachError represents 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;
|
|
}
|
|
|
|
// VolumeAttributesClass represents a specification of mutable volume attributes
|
|
// defined by the CSI driver. The class can be specified during dynamic provisioning
|
|
// of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.
|
|
message VolumeAttributesClass {
|
|
// Standard object's metadata.
|
|
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
|
|
|
|
// Name of the CSI driver
|
|
// This field is immutable.
|
|
optional string driverName = 2;
|
|
|
|
// parameters hold volume attributes defined by the CSI driver. These values
|
|
// are opaque to the Kubernetes and are passed directly to the CSI driver.
|
|
// The underlying storage provider supports changing these attributes on an
|
|
// existing volume, however the parameters field itself is immutable. To
|
|
// invoke a volume update, a new VolumeAttributesClass should be created with
|
|
// new parameters, and the PersistentVolumeClaim should be updated to reference
|
|
// the new VolumeAttributesClass.
|
|
//
|
|
// This field is required and must contain at least one key/value pair.
|
|
// The keys cannot be empty, and the maximum number of parameters is 512, with
|
|
// a cumulative max size of 256K. If the CSI driver rejects invalid parameters,
|
|
// the target PersistentVolumeClaim will be set to an "Infeasible" state in the
|
|
// modifyVolumeStatus field.
|
|
map<string, string> parameters = 3;
|
|
}
|
|
|
|
// VolumeAttributesClassList is a collection of VolumeAttributesClass objects.
|
|
message VolumeAttributesClassList {
|
|
// Standard list metadata
|
|
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
|
|
|
|
// items is the list of VolumeAttributesClass objects.
|
|
repeated VolumeAttributesClass items = 2;
|
|
}
|
|
|
|
// VolumeError captures an error encountered during a volume operation.
|
|
message VolumeError {
|
|
// time represents the time the error was encountered.
|
|
// +optional
|
|
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time time = 1;
|
|
|
|
// message represents the error encountered during Attach or Detach operation.
|
|
// This string maybe logged, so it should not contain sensitive
|
|
// information.
|
|
// +optional
|
|
optional string message = 2;
|
|
}
|
|
|