storage

type Volume struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   VolumeSpec
	Status VolumeStatus
}

type VolumeAccess struct {
	// SecretRef references the Secret containing the access credentials to consume a Volume.
	SecretRef *corev1.LocalObjectReference
	// Driver is the name of the drive to use for this volume. Required.
	Driver string
	// VolumeAttributes are attributes of the volume to use.
	VolumeAttributes map[string]string
}

type VolumeClaim struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   VolumeClaimSpec
	Status VolumeClaimStatus
}

type VolumeClaimList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []VolumeClaim
}

type VolumeClaimPhase string

type VolumeClaimSpec struct {
	// VolumeRef is the reference to the Volume used by the VolumeClaim
	VolumeRef *corev1.LocalObjectReference
	// Selector is a label query over volumes to consider for binding.
	Selector *metav1.LabelSelector
	// Resources are the requested Volume resources.
	Resources corev1.ResourceList
	// Image is an optional image to bootstrap the volume with.
	Image string
	// ImagePullSecretRef is an optional secret for pulling the image of a volume.
	ImagePullSecretRef *corev1.LocalObjectReference
	// VolumeClassRef references the VolumeClass used by the Volume.
	VolumeClassRef corev1.LocalObjectReference
}

type VolumeClaimStatus struct {
	// Phase represents the state a VolumeClaim can be in.
	Phase VolumeClaimPhase
}

type VolumeClass struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// Capabilities describes the capabilities of a volume class
	Capabilities corev1.ResourceList
}

type VolumeClassList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []VolumeClass
}

type VolumeCondition struct {
	// Type is the type of the condition.
	Type VolumeConditionType
	// Status is the status of the condition.
	Status corev1.ConditionStatus
	// Reason is a machine-readable indication of why the condition is in a certain state.
	Reason string
	// Message is a human-readable explanation of why the condition has a certain reason / state.
	Message string
	// ObservedGeneration represents the .metadata.generation that the condition was set based upon.
	ObservedGeneration int64
	// LastTransitionTime is the last time the status of a condition has transitioned from one state to another.
	LastTransitionTime metav1.Time
}

type VolumeConditionType string

type VolumeList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []Volume
}

type VolumePhase string

type VolumePool struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   VolumePoolSpec
	Status VolumePoolStatus
}

type VolumePoolCondition struct {
	// Type is the type of the condition.
	Type VolumePoolConditionType
	// Status is the status of the condition.
	Status corev1.ConditionStatus
	// Reason is a machine-readable indication of why the condition is in a certain state.
	Reason string
	// Message is a human-readable explanation of why the condition has a certain reason / state.
	Message string
	// ObservedGeneration represents the .metadata.generation that the condition was set based upon.
	ObservedGeneration int64
	// LastTransitionTime is the last time the status of a condition has transitioned from one state to another.
	LastTransitionTime metav1.Time
}

type VolumePoolConditionType string

type VolumePoolList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []VolumePool
}

type VolumePoolSpec struct {
	// ProviderID identifies the VolumePool on provider side.
	ProviderID string
	// Taints of the VolumePool. Only Volumes who tolerate all the taints
	// will land in the VolumePool.
	Taints []commonv1alpha1.Taint
}

type VolumePoolState string

type VolumePoolStatus struct {
	State      VolumePoolState
	Conditions []VolumePoolCondition
	// AvailableVolumeClasses list the references of any supported VolumeClass of this pool
	AvailableVolumeClasses []corev1.LocalObjectReference
	// Available list the available capacity of a volume pool
	Available corev1.ResourceList
	// Used indicates how much capacity has been used in a volume pool
	Used corev1.ResourceList
}

type VolumeSpec struct {
	// VolumeClassRef is the volume class of a volume
	VolumeClassRef corev1.LocalObjectReference
	// VolumePoolSelector selects a suitable VolumePoolRef by the given labels.
	VolumePoolSelector map[string]string
	// VolumePoolRef indicates which volume pool to use for a volume.
	// If unset, the scheduler will figure out a suitable VolumePoolRef.
	VolumePoolRef *corev1.LocalObjectReference
	// ClaimRef is the reference to the VolumeClaim used by the Volume.
	ClaimRef *commonv1alpha1.LocalUIDReference
	// Resources is a description of the volume's resources and capacity.
	Resources corev1.ResourceList
	// Image is an optional image to bootstrap the volume with.
	Image string
	// ImagePullSecretRef is an optional secret for pulling the image of a volume.
	ImagePullSecretRef *corev1.LocalObjectReference
	// Tolerations define tolerations the Volume has. Only a VolumePool whose taints
	// covered by Tolerations will be considered to host the Volume.
	Tolerations []commonv1alpha1.Toleration
}

type VolumeState string

type VolumeStatus struct {
	// State represents the infrastructure state of a Volume.
	State VolumeState
	// LastStateTransitionTime is the last time the State transitioned between values.
	LastStateTransitionTime *metav1.Time

	// Phase represents the binding phase of a Volume.
	Phase VolumePhase
	// LastPhaseTransitionTime is the last time the Phase transitioned between values.
	LastPhaseTransitionTime *metav1.Time

	// Access specifies how to access a Volume.
	// This is set by the volume provider when the volume is provisioned.
	Access *VolumeAccess

	// Conditions are the conditions of a volume.
	Conditions []VolumeCondition
}