Introduce VolumeSnapshot API type (#1347)

Author: kasabe28

api/storage/v1alpha1/register.go

@@ -37,6 +37,8 @@ func addKnownTypes(scheme *runtime.Scheme) error {
 		&VolumePoolList{},
 		&Volume{},
 		&VolumeList{},
+		&VolumeSnapshot{},
+		&VolumeSnapshotList{},
 		&BucketClass{},
 		&BucketClassList{},
 		&BucketPool{},

api/storage/v1alpha1/volume_types.go

@@ -32,6 +32,7 @@ type VolumeSpec struct {
 	// Resources is a description of the volume's resources and capacity.
 	Resources corev1alpha1.ResourceList `json:"resources,omitempty"`
 	// Image is an optional image to bootstrap the volume with.
+	// To be deprecated
 	Image string `json:"image,omitempty"`
 	// ImagePullSecretRef is an optional secret for pulling the image of a volume.
 	ImagePullSecretRef *corev1.LocalObjectReference `json:"imagePullSecretRef,omitempty"`
@@ -42,6 +43,16 @@ type VolumeSpec struct {
 	Tolerations []commonv1alpha1.Toleration `json:"tolerations,omitempty"`
 	// Encryption is an optional field which provides attributes to encrypt Volume.
 	Encryption *VolumeEncryption `json:"encryption,omitempty"`
+	// VolumeDataSource is the source where the storage for the Volume resides at.
+	VolumeDataSource `json:",inline"`
+}
+
+// VolumeDataSource specifies the source to use for a Volume.
+type VolumeDataSource struct {
+	// VolumeSnapshotRef instructs to use the specified VolumeSnapshot as the data source.
+	VolumeSnapshotRef *corev1.LocalObjectReference `json:"volumeSnapshotRef,omitempty"`
+	// OSImage is an optional os image to bootstrap the volume.
+	OSImage *string `json:"osImage,omitempty"`
 }
 
 // VolumeAccess represents information on how to access a volume.

api/storage/v1alpha1/volumesnapshot_types.go

@@ -0,0 +1,61 @@
+// SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and IronCore contributors
+// SPDX-License-Identifier: Apache-2.0
+
+package v1alpha1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// VolumeSnapshotSpec defines the desired state of VolumeSnapshot
+type VolumeSnapshotSpec struct {
+	// VolumeRef indicates which Volume to refer for VolumeSnapshot
+	VolumeRef *corev1.LocalObjectReference `json:"volumeRef"`
+}
+
+// VolumeSnapshotStatus defines the observed state of VolumeSnapshot
+type VolumeSnapshotStatus struct {
+	// SnapshotID is the provider-specific snapshot ID in the format 'TYPE://SNAPSHOT_ID'.
+	SnapshotID string `json:"snapshotID,omitempty"`
+	// State represents the storage provider state of VolumeSnapshot
+	State VolumeSnapshotState `json:"state,omitempty"`
+	// LastStateTransitionTime is the last time the State transitioned between values.
+	LastStateTransitionTime *metav1.Time `json:"lastStateTransitionTime,omitempty"`
+	// Size is the storage size used by VolumeSnapshot
+	Size *resource.Quantity `json:"size,omitempty"`
+}
+
+// VolumeSnapshotState is the state of a VolumeSnapshot
+type VolumeSnapshotState string
+
+const (
+	// VolumeSnapshotStatePending reports whether a VolumeSnapshot is about to be ready.
+	VolumeSnapshotStatePending VolumeSnapshotState = "Pending"
+	// VolumeSnapshotStateReady reports whether a VolumeSnapshot is ready to be used.
+	VolumeSnapshotStateReady VolumeSnapshotState = "Ready"
+	// VolumeSnapshotStateFailed reports that a VolumeSnapshot is in failed state.
+	VolumeSnapshotStateFailed VolumeSnapshotState = "Failed"
+)
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +genclient
+
+// VolumeSnapshot is the Schema for the VolumeSnapshots API
+type VolumeSnapshot struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   VolumeSnapshotSpec   `json:"spec,omitempty"`
+	Status VolumeSnapshotStatus `json:"status,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// VolumeSnapshotList contains a list of VolumeSnapshot
+type VolumeSnapshotList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []VolumeSnapshot `json:"items"`
+}