kubernetes-models
Version:
61 lines (60 loc) • 4.48 kB
TypeScript
import { IIoK8sApiCoreV1TypedLocalObjectReference } from "./TypedLocalObjectReference";
import { IIoK8sApiCoreV1ResourceRequirements } from "./ResourceRequirements";
import { IIoK8sApimachineryPkgApisMetaV1LabelSelector } from "@kubernetes-models/apimachinery/apis/meta/v1/LabelSelector";
import { Model } from "@kubernetes-models/base";
/**
* PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
*/
export interface IPersistentVolumeClaimSpec {
/**
* accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
*/
"accessModes"?: Array<string>;
/**
* dataSource field can be used to specify either: \* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) \* An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
*/
"dataSource"?: IIoK8sApiCoreV1TypedLocalObjectReference;
/**
* dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: \* While DataSource only allows two specific types of objects, DataSourceRef
* allows any non-core object, as well as PersistentVolumeClaim objects.
* \* While DataSource ignores disallowed values (dropping them), DataSourceRef
* preserves all values, and generates an error if a disallowed value is
* specified.
* (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
*/
"dataSourceRef"?: IIoK8sApiCoreV1TypedLocalObjectReference;
/**
* resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
*/
"resources"?: IIoK8sApiCoreV1ResourceRequirements;
/**
* selector is a label query over volumes to consider for binding.
*/
"selector"?: IIoK8sApimachineryPkgApisMetaV1LabelSelector;
/**
* storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
*/
"storageClassName"?: string;
/**
* volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
*/
"volumeMode"?: string;
/**
* volumeName is the binding reference to the PersistentVolume backing this claim.
*/
"volumeName"?: string;
}
/**
* PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
*/
export declare class PersistentVolumeClaimSpec extends Model<IPersistentVolumeClaimSpec> implements IPersistentVolumeClaimSpec {
"accessModes"?: Array<string>;
"dataSource"?: IIoK8sApiCoreV1TypedLocalObjectReference;
"dataSourceRef"?: IIoK8sApiCoreV1TypedLocalObjectReference;
"resources"?: IIoK8sApiCoreV1ResourceRequirements;
"selector"?: IIoK8sApimachineryPkgApisMetaV1LabelSelector;
"storageClassName"?: string;
"volumeMode"?: string;
"volumeName"?: string;
}
export { IPersistentVolumeClaimSpec as IIoK8sApiCoreV1PersistentVolumeClaimSpec, PersistentVolumeClaimSpec as IoK8sApiCoreV1PersistentVolumeClaimSpec };