v1

type VolumeGroup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the volume group requested by a user
	Spec VolumeGroupSpec `json:"spec,omitempty"`
	// Status represents the current information about a volume group
	// +optional
	Status VolumeGroupStatus `json:"status,omitempty"`
}

type VolumeGroupClass struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Driver is the driver expected to handle this VolumeGroupClass.
	Driver string `json:"driver"`

	// Parameters hold parameters for the driver.
	// These values are opaque to the system and are passed directly
	// to the driver.
	// +optional
	Parameters map[string]string `json:"parameters,omitempty"`

	// +optional
	VolumeGroupDeletionPolicy *VolumeGroupDeletionPolicy `json:"volumeGroupDeletionPolicy,omitempty"`

	// This field specifies whether group snapshot is supported.
	// The default is false.
	// +optional
	SupportVolumeGroupSnapshot *bool `json:"supportVolumeGroupSnapshot,omitempty"`
}

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

type VolumeGroupContent struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the volume group requested by a user
	Spec VolumeGroupContentSpec `json:"spec,omitempty"`
	// Status represents the current information about a volume group
	// +optional
	Status VolumeGroupContentStatus `json:"status,omitempty"`
}

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

type VolumeGroupContentSource struct {
	Driver string `json:"driver"`

	// VolumeGroupHandle is the unique volume group name returned by the
	// CSI volume plugin’s CreateVolumeGroup to refer to the volume group on
	// all subsequent calls.
	VolumeGroupHandle string `json:"volumeGroupHandle"`

	// +optional
	// Attributes of the volume group to publish.
	VolumeGroupAttributes map[string]string `json:"volumeGroupAttributes,omitempty"`
}

type VolumeGroupContentSpec struct {
	// +optional
	VolumeGroupClassName *string `json:"volumeGroupClassName,omitempty"`

	// +optional
	// VolumeGroupRef is part of a bi-directional binding between VolumeGroup and VolumeGroupContent.
	VolumeGroupRef *corev1.ObjectReference `json:"volumeGroupRef,omitempty"`

	// +optional
	Source *VolumeGroupContentSource `json:"source,omitempty"`

	// +optional
	VolumeGroupDeletionPolicy *VolumeGroupDeletionPolicy `json:"volumeGroupDeletionPolicy,omitempty"`

	// This field specifies whether group snapshot is supported.
	// The default is false.
	// +optional
	SupportVolumeGroupSnapshot *bool `json:"supportVolumeGroupSnapshot,omitempty"`

	// VolumeGroupSecretRef is a reference to the secret object containing
	// sensitive information to pass to the CSI driver to complete the CSI
	// calls for VolumeGroups.
	// This field is optional, and may be empty if no secret is required. If the
	// secret object contains more than one secret, all secrets are passed.
	// +optional
	VolumeGroupSecretRef *corev1.SecretReference `json:"volumeGroupSecretRef,omitempty"`
}

type VolumeGroupContentStatus struct {
	// +optional
	GroupCreationTime *metav1.Time `json:"groupCreationTime,omitempty"`

	// A list of persistent volumes
	// +optional
	PVList []corev1.PersistentVolume `json:"pvList,omitempty"`

	// +optional
	Ready *bool `json:"ready,omitempty"`

	// Last error encountered during group creation
	// +optional
	Error *VolumeGroupError `json:"error,omitempty"`
}

type VolumeGroupDeletionPolicy string

type VolumeGroupError struct {
	// time is the timestamp when the error was encountered.
	// +optional
	Time *metav1.Time `json:"time,omitempty"`

	// message details the encountered error
	// +optional
	Message *string `json:"message,omitempty"`
}

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

type VolumeGroupSource struct {
	// +optional
	// Pre-provisioned VolumeGroup
	VolumeGroupContentName *string `json:"volumeGroupContentName,omitempty"`

	// +optional
	// Dynamically provisioned VolumeGroup
	// A label query over persistent volume claims to be added to the volume group.
	// This labelSelector will be used to match the label added to a PVC.
	// In Phase 1, when the label is added to PVC, the PVC will be added to the matching group.
	// In Phase 2, this labelSelector will be used to find all PVCs with matching label and add them to the group when the group is being created.
	Selector *metav1.LabelSelector `json:"selector,omitempty"`
}

type VolumeGroupSpec struct {
	// +optional
	VolumeGroupClassName *string `json:"volumeGroupClassName,omitempty"`

	// Source has the information about where the group is created from.
	Source VolumeGroupSource `json:"source"`
}

type VolumeGroupStatus struct {
	// +optional
	BoundVolumeGroupContentName *string `json:"boundVolumeGroupContentName,omitempty"`

	// +optional
	GroupCreationTime *metav1.Time `json:"groupCreationTime,omitempty"`

	// A list of persistent volume claims
	// +optional
	PVCList []corev1.PersistentVolumeClaim `json:"pvcList,omitempty"`

	// +optional
	Ready *bool `json:"ready,omitempty"`

	// Last error encountered during group creation
	// +optional
	Error *VolumeGroupError `json:"error,omitempty"`
}