feat: mirror images according to ClusterImageSetMirrors

Author: plaffitt

api/kuik/v1alpha1/clusterimagesetmirror_types.go

@@ -4,27 +4,15 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
-
 // ClusterImageSetMirrorSpec defines the desired state of ClusterImageSetMirror.
-type ClusterImageSetMirrorSpec struct {
-	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
-
-	// Foo is an example field of ClusterImageSetMirror. Edit clusterimagesetmirror_types.go to remove/update
-	Foo string `json:"foo,omitempty"`
-}
+type ClusterImageSetMirrorSpec ImageSetMirrorSpec
 
 // ClusterImageSetMirrorStatus defines the observed state of ClusterImageSetMirror.
-type ClusterImageSetMirrorStatus struct {
-	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
-}
+type ClusterImageSetMirrorStatus ImageSetMirrorStatus
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
-// +kubebuilder:resource:scope=Cluster
+// +kubebuilder:resource:scope=Cluster,shortName=cism
 
 // ClusterImageSetMirror is the Schema for the clusterimagesetmirrors API.
 type ClusterImageSetMirror struct {

api/kuik/v1alpha1/imagesetmirror_types.go

@@ -1,29 +1,29 @@
 package v1alpha1
 
 import (
+	"path"
+	"strings"
+
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
-
 // ImageSetMirrorSpec defines the desired state of ImageSetMirror.
 type ImageSetMirrorSpec struct {
-	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
-
-	// Foo is an example field of ImageSetMirror. Edit imagesetmirror_types.go to remove/update
-	Foo string `json:"foo,omitempty"`
+	ImageMatcher string  `json:"imageMatcher,omitempty"`
+	Cleanup      Cleanup `json:"cleanup,omitempty"`
+	Mirrors      Mirrors `json:"mirrors,omitempty"`
 }
 
 // ImageSetMirrorStatus defines the observed state of ImageSetMirror.
 type ImageSetMirrorStatus struct {
-	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
+	// +listType=map
+	// +listMapKey=image
+	MatchedImages []MatchedImage `json:"matchedImages,omitempty"`
 }
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:resource:shortName=ism
 
 // ImageSetMirror is the Schema for the imagesetmirrors API.
 type ImageSetMirror struct {
@@ -43,6 +43,54 @@ type ImageSetMirrorList struct {
 	Items           []ImageSetMirror `json:"items"`
 }
 
+// Cleanup defines a cleanup strategy
+type Cleanup struct {
+	Enabled   bool            `json:"enabled,omitempty"`
+	Retention metav1.Duration `json:"retention,omitempty"`
+}
+
+type Mirror struct {
+	Registry         string            `json:"registry,omitempty"`
+	Path             string            `json:"path,omitempty"`
+	CredentialSecret *CredentialSecret `json:"credentialSecret,omitempty"`
+	Cleanup          *Cleanup          `json:"cleanup,omitempty"`
+}
+
+type Mirrors []Mirror
+
+type CredentialSecret struct {
+	// Name is the name of the secret
+	Name string `json:"name,omitempty"`
+	// Namespace is the namespace where the secret is located.
+	// This value is ignored for namespaced resources and the namespace of the parent object is used instead.
+	Namespace string `json:"namespace,omitempty"` // TODO: make this field required for ClusterImageSetMirrors and prohibited for ImageSetMirrors
+}
+
+type MatchedImage struct {
+	Image string `json:"image"`
+	// +listType=map
+	// +listMapKey=image
+	Mirrors     []MirrorStatus   `json:"mirrors,omitempty"`
+	UnusedSince *metav1.Duration `json:"unusedSince,omitempty"`
+}
+
+type MirrorStatus struct {
+	Image      string       `json:"image"`
+	MirroredAt *metav1.Time `json:"mirroredAt,omitempty"`
+}
+
 func init() {
 	SchemeBuilder.Register(&ImageSetMirror{}, &ImageSetMirrorList{})
 }
+
+func (m Mirrors) GetCredentialSecretForImage(image string) (cred *CredentialSecret) {
+	longestPrefixLen := 0
+	for _, mirror := range m {
+		prefix := path.Join(mirror.Registry, mirror.Path)
+		if strings.HasPrefix(image, prefix) && len(prefix) > longestPrefixLen {
+			cred = mirror.CredentialSecret
+			longestPrefixLen = len(prefix)
+		}
+	}
+	return
+}