v1alpha1

type Checkout struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              CheckoutSpec `json:"spec"`

	// +optional
	Status CheckoutStatus `json:"status"`
}

type CheckoutCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=Acquired
	Type CheckoutConditionType `json:"type"`
}

type CheckoutConditionType string

type CheckoutList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Checkout `json:"items"`
}

type CheckoutSpec struct {
	// PoolRef is the pool to check out a PVC from.
	PoolRef PoolReference `json:"poolRef"`

	// AccessModes are the access modes to assign to the checked out PVC.
	// Defaults to ReadWriteOnce.
	//
	// +optional
	// +kubebuilder:default={"ReadWriteOnce"}
	AccessModes []corev1.PersistentVolumeAccessMode `json:"accessModes,omitempty"`
}

type CheckoutStatus struct {
	// VolumeName is the name of the volume being configured for the checkout.
	// It will track a volume from the upstream pool until its configuration is
	// copied to a new volume, at which point it will be permanently set to that
	// new volume.
	//
	// This field will be set as soon as a PVC is available in the pool.
	//
	// +optional
	VolumeName string `json:"volumeName,omitempty"`

	// VolumeClaimRef is a reference to the PVC checked out from the pool.
	//
	// This field will only be set when the checked out PVC is ready to be used.
	//
	// +optional
	VolumeClaimRef corev1.LocalObjectReference `json:"volumeClaimRef,omitempty"`

	// Conditions are the possible observable conditions for the checkout.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []CheckoutCondition `json:"conditions,omitempty"`
}

type Condition struct {
	Status             corev1.ConditionStatus `json:"status"`
	LastTransitionTime metav1.Time            `json:"lastTransitionTime"`

	// Reason identifies the cause of the given status using an API-locked
	// camel-case identifier.
	//
	// +optional
	Reason string `json:"reason,omitempty"`

	// Message is a human-readable description of the given status.
	//
	// +optional
	Message string `json:"message,omitempty"`
}

type JobTemplate struct {
	// +kubebuilder:pruning:PreserveUnknownFields
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec batchv1.JobSpec `json:"spec"`
}

type MountJob struct {
	// Template is the configuration for the job.
	Template JobTemplate `json:"template"`

	// VolumeName is the name of the volume to be added to the template to
	// access the persistent volume. The volume must either not exist in the
	// template or must have a persistent volume claim source.
	//
	// +optional
	// +kubebuilder:default="workspace"
	VolumeName string `json:"volumeName,omitempty"`
}

type PersistentVolumeClaimTemplate struct {
	// +kubebuilder:pruning:PreserveUnknownFields
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec corev1.PersistentVolumeClaimSpec `json:"spec"`
}

type Pool struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              PoolSpec `json:"spec"`

	// +optional
	Status PoolStatus `json:"status"`
}

type PoolCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=Available;Settlement
	Type PoolConditionType `json:"type"`
}

type PoolConditionType string

type PoolList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Pool `json:"items"`
}

type PoolReference struct {
	// Namespace identifies the Kubernetes namespace of the pool.
	//
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// Name identifies the name of the pool within the namespace.
	Name string `json:"name"`
}

type PoolSpec struct {
	// Replicas are the number of PVs to make available in the pool.
	//
	// Once a PV is checked out from the pool, it no longer counts toward the
	// number replicas. Setting this field to 0 will make the pool unusable.
	//
	// +optional
	// +kubebuilder:default=1
	Replicas *int32 `json:"replicas,omitempty"`

	// Selector is the label selector for PVCs maintained in the pool.
	//
	// The selector must match a subset of the labels in the template.
	Selector metav1.LabelSelector `json:"selector"`

	// Template describes the configuration of the dynamic PVCs that this
	// controller should manage.
	Template PersistentVolumeClaimTemplate `json:"template"`

	// InitJob configures a job to process newly created PVs before they are
	// made available as part of the pool.
	//
	// +optional
	InitJob *MountJob `json:"initJob,omitempty"`
}

type PoolStatus struct {
	// ObservedGeneration is the generation of the resource specification that
	// this status matches.
	//
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Replicas are the number of PVCs that currently exist that match this
	// pool's selector.
	//
	// +optional
	Replicas int32 `json:"replicas,omitempty"`

	// AvailableReplicas are the number of PVs from this pool that are ready to
	// be checked out.
	//
	// +optional
	AvailableReplicas int32 `json:"availableReplicas,omitempty"`

	// Conditions are the possible observable conditions for this pool.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []PoolCondition `json:"conditions,omitempty"`
}