feat: Add cachedimage pulling progress status

README.md

@@ -217,7 +217,7 @@ Note that persistence requires your cluster to have some PersistentVolumes. If y
 Sometimes, you want images to stay cached even when they are not used anymore (for instance when you run a workload for a fixed amount of time, stop it, and run it again later). You can choose to prevent `CachedImages` from expiring by manually setting the `spec.retain` flag to `true` like shown below:
 
 ```yaml
-apiVersion: kuik.enix.io/v1alpha1
+apiVersion: kuik.enix.io/v1alpha1ext1
 kind: CachedImage
 metadata:
   name: docker.io-library-nginx-1.25

api/kuik/v1alpha1/cachedimage_types.go → api/kuik/v1alpha1ext1/cachedimage_types.go

@@ -1,4 +1,4 @@
-package v1alpha1
+package v1alpha1ext1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -26,12 +26,19 @@ type UsedBy struct {
 	Count int `json:"count,omitempty"`
 }
 
+type Progress struct {
+	Total     int64 `json:"total,omitempty"`
+	Available int64 `json:"available,omitempty"`
+}
+
 // CachedImageStatus defines the observed state of CachedImage
 type CachedImageStatus struct {
 	IsCached bool   `json:"isCached,omitempty"`
 	Phase    string `json:"phase,omitempty"`
 	UsedBy   UsedBy `json:"usedBy,omitempty"`
 
+	Progress Progress `json:"progress,omitempty"`
+
 	Digest             string      `json:"digest,omitempty"`
 	UpstreamDigest     string      `json:"upstreamDigest,omitempty"`
 	UpToDate           bool        `json:"upToDate,omitempty"`

api/kuik/v1alpha1/cachedimage_utils.go → api/kuik/v1alpha1ext1/cachedimage_utils.go

@@ -1,4 +1,4 @@
-package v1alpha1
+package v1alpha1ext1
 
 import (
 	"context"

api/kuik/v1alpha1/cachedimage_webhook.go → api/kuik/v1alpha1ext1/cachedimage_webhook.go

@@ -1,4 +1,4 @@
-package v1alpha1
+package v1alpha1ext1
 
 import (
 	"context"

api/kuik/v1alpha1/cachedimage_webhook_test.go → api/kuik/v1alpha1ext1/cachedimage_webhook_test.go

@@ -1,4 +1,4 @@
-package v1alpha1
+package v1alpha1ext1
 
 import (
 	"context"

api/kuik/v1alpha1/groupversion_info.go → api/kuik/v1alpha1ext1/groupversion_info.go

@@ -1,7 +1,7 @@
-// Package v1alpha1 contains API Schema definitions for the kuik.enix.io v1alpha1 API group
+// Package v1alpha1ext1 contains API Schema definitions for the kuik.enix.io v1alpha1ext1 API group
 // +kubebuilder:object:generate=true
 // +groupName=kuik.enix.io
-package v1alpha1
+package v1alpha1ext1
 
 import (
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -10,7 +10,7 @@ import (
 
 var (
 	// GroupVersion is group version used to register these objects
-	GroupVersion = schema.GroupVersion{Group: "kuik.enix.io", Version: "v1alpha1"}
+	GroupVersion = schema.GroupVersion{Group: "kuik.enix.io", Version: "v1alpha1ext1"}
 
 	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
 	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

api/kuik/v1alpha1/repository_types.go → api/kuik/v1alpha1ext1/repository_types.go

@@ -1,4 +1,4 @@
-package v1alpha1
+package v1alpha1ext1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

api/kuik/v1alpha1/repository_utils.go → api/kuik/v1alpha1ext1/repository_utils.go

@@ -1,4 +1,4 @@
-package v1alpha1
+package v1alpha1ext1
 
 import (
 	"regexp"

cmd/cache/main.go

@@ -18,7 +18,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
 
 	kuikenixiov1 "github.com/enix/kube-image-keeper/api/core/v1"
-	kuikv1alpha1 "github.com/enix/kube-image-keeper/api/kuik/v1alpha1"
+	kuikv1alpha1ext1 "github.com/enix/kube-image-keeper/api/kuik/v1alpha1ext1"
 	"github.com/enix/kube-image-keeper/internal"
 	kuikController "github.com/enix/kube-image-keeper/internal/controller"
 	"github.com/enix/kube-image-keeper/internal/controller/core"
@@ -116,7 +116,7 @@ func main() {
 		Decoder:                admission.NewDecoder(mgr.GetScheme()),
 	}
 	mgr.GetWebhookServer().Register("/mutate-core-v1-pod", &webhook.Admission{Handler: &imageRewriter})
-	if err = (&kuikv1alpha1.CachedImage{}).SetupWebhookWithManager(mgr); err != nil {
+	if err = (&kuikv1alpha1ext1.CachedImage{}).SetupWebhookWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create webhook", "webhook", "CachedImage")
 		os.Exit(1)
 	}

config/crd/bases/kuik.enix.io_cachedimages.yaml

@@ -35,7 +35,7 @@ spec:
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    name: v1alpha1
+    name: v1alpha1ext1
     schema:
       openAPIV3Schema:
         description: CachedImage is the Schema for the cachedimages API
@@ -90,6 +90,15 @@ spec:
                 type: string
               phase:
                 type: string
+              progress:
+                properties:
+                  available:
+                    format: int64
+                    type: integer
+                  total:
+                    format: int64
+                    type: integer
+                type: object
               upToDate:
                 type: boolean
               upstreamDigest:

config/crd/bases/kuik.enix.io_repositories.yaml

@@ -26,7 +26,7 @@ spec:
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    name: v1alpha1
+    name: v1alpha1ext1
     schema:
       openAPIV3Schema:
         description: Repository is the Schema for the repositories API

config/samples/kuik_v1alpha1_cachedimage.yaml

@@ -1,4 +1,4 @@
-apiVersion: kuik.enix.io/v1alpha1
+apiVersion: kuik.enix.io/v1alpha1ext1
 kind: CachedImage
 metadata:
   labels:

config/samples/kuik_v1alpha1_repository.yaml

@@ -1,4 +1,4 @@
-apiVersion: kuik.enix.io/v1alpha1
+apiVersion: kuik.enix.io/v1alpha1ext1
 kind: Repository
 metadata:
   labels:

helm/kube-image-keeper/crds/cachedimage-crd.yaml

@@ -34,7 +34,10 @@ spec:
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    name: v1alpha1
+    - jsonPath: .status.progress.available
+      name: Downloaded
+      type: integer
+    name: v1alpha1ext1
     schema:
       openAPIV3Schema:
         description: CachedImage is the Schema for the cachedimages API
@@ -93,6 +96,15 @@ spec:
                 type: boolean
               upstreamDigest:
                 type: string
+              progress:
+                type: object
+                properties:
+                  total:
+                    type: integer
+                    description: Total size of the compressed blob in bytes, including all layers.
+                  available:
+                    type: integer
+                    description: Total downloaded / available size of the compressed blob in bytes, including all layers.
               usedBy:
                 properties:
                   count:

helm/kube-image-keeper/crds/repository-crd.yaml

@@ -25,7 +25,7 @@ spec:
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    name: v1alpha1
+    name: v1alpha1ext1
     schema:
       openAPIV3Schema:
         description: Repository is the Schema for the repositories API

internal/controller/collector.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"strconv"
 
-	kuikv1alpha1 "github.com/enix/kube-image-keeper/api/kuik/v1alpha1"
+	kuikv1alpha1ext1 "github.com/enix/kube-image-keeper/api/kuik/v1alpha1ext1"
 	kuikMetrics "github.com/enix/kube-image-keeper/internal/metrics"
 	"github.com/prometheus/client_golang/prometheus"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -70,7 +70,7 @@ func RegisterMetrics(client client.Client) {
 	)
 }
 
-func cachedImagesWithLabelValues(gaugeVec *prometheus.GaugeVec, cachedImage *kuikv1alpha1.CachedImage) prometheus.Gauge {
+func cachedImagesWithLabelValues(gaugeVec *prometheus.GaugeVec, cachedImage *kuikv1alpha1ext1.CachedImage) prometheus.Gauge {
 	return gaugeVec.WithLabelValues(strconv.FormatBool(cachedImage.Status.IsCached), strconv.FormatBool(cachedImage.Spec.ExpiresAt != nil))
 }
 
@@ -83,7 +83,7 @@ func (c *ControllerCollector) Describe(ch chan<- *prometheus.Desc) {
 }
 
 func (c *ControllerCollector) Collect(ch chan<- prometheus.Metric) {
-	cachedImageList := &kuikv1alpha1.CachedImageList{}
+	cachedImageList := &kuikv1alpha1ext1.CachedImageList{}
 	if err := c.List(context.Background(), cachedImageList); err == nil {
 		cachedImageGaugeVec := prometheus.NewGaugeVec(
 			prometheus.GaugeOpts{

internal/controller/core/pod_controller.go

@@ -12,7 +12,7 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 
 	"github.com/distribution/reference"
-	kuikv1alpha1 "github.com/enix/kube-image-keeper/api/kuik/v1alpha1"
+	kuikv1alpha1ext1 "github.com/enix/kube-image-keeper/api/kuik/v1alpha1ext1"
 	"github.com/enix/kube-image-keeper/internal/registry"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -92,7 +92,7 @@ func (r *PodReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.R
 	}
 
 	for _, cachedImage := range cachedImages {
-		var ci kuikv1alpha1.CachedImage
+		var ci kuikv1alpha1ext1.CachedImage
 		err := r.Get(ctx, client.ObjectKeyFromObject(&cachedImage), &ci)
 		if err != nil && !apierrors.IsNotFound(err) {
 			return ctrl.Result{}, err
@@ -141,7 +141,7 @@ func (r *PodReconciler) SetupWithManager(mgr ctrl.Manager) error {
 			return ok
 		}))).
 		Watches(
-			&kuikv1alpha1.CachedImage{},
+			&kuikv1alpha1ext1.CachedImage{},
 			handler.EnqueueRequestsFromMapFunc(r.podsWithDeletingCachedImages),
 			builder.WithPredicates(p),
 		).
@@ -154,8 +154,8 @@ func (r *PodReconciler) podsWithDeletingCachedImages(ctx context.Context, obj cl
 		WithName("controller-runtime.manager.controller.pod.deletingCachedImages").
 		WithValues("cachedImage", klog.KObj(obj))
 
-	cachedImage := obj.(*kuikv1alpha1.CachedImage)
-	var currentCachedImage kuikv1alpha1.CachedImage
+	cachedImage := obj.(*kuikv1alpha1ext1.CachedImage)
+	var currentCachedImage kuikv1alpha1ext1.CachedImage
 	// wait for the CachedImage to be really deleted
 	if err := r.Get(ctx, client.ObjectKeyFromObject(cachedImage), &currentCachedImage); err == nil || !apierrors.IsNotFound(err) {
 		return make([]ctrl.Request, 0)
@@ -187,8 +187,8 @@ func (r *PodReconciler) podsWithDeletingCachedImages(ctx context.Context, obj cl
 	return make([]ctrl.Request, 0)
 }
 
-func (r *PodReconciler) desiredRepositories(ctx context.Context, pod *corev1.Pod, cachedImages []kuikv1alpha1.CachedImage) ([]kuikv1alpha1.Repository, error) {
-	repositories := map[string]kuikv1alpha1.Repository{}
+func (r *PodReconciler) desiredRepositories(ctx context.Context, pod *corev1.Pod, cachedImages []kuikv1alpha1ext1.CachedImage) ([]kuikv1alpha1ext1.Repository, error) {
+	repositories := map[string]kuikv1alpha1ext1.Repository{}
 
 	pullSecretNames, err := r.imagePullSecretNamesFromPod(ctx, pod)
 	if err != nil {
@@ -201,11 +201,11 @@ func (r *PodReconciler) desiredRepositories(ctx context.Context, pod *corev1.Pod
 			return nil, err
 		}
 		repositoryName := named.Name()
-		repositories[repositoryName] = kuikv1alpha1.Repository{
+		repositories[repositoryName] = kuikv1alpha1ext1.Repository{
 			ObjectMeta: metav1.ObjectMeta{
 				Name: registry.SanitizeName(repositoryName),
 			},
-			Spec: kuikv1alpha1.RepositorySpec{
+			Spec: kuikv1alpha1ext1.RepositorySpec{
 				Name:                 repositoryName,
 				PullSecretNames:      pullSecretNames,
 				PullSecretsNamespace: pod.Namespace,
@@ -216,15 +216,15 @@ func (r *PodReconciler) desiredRepositories(ctx context.Context, pod *corev1.Pod
 	return maps.Values(repositories), nil
 }
 
-func DesiredCachedImages(ctx context.Context, pod *corev1.Pod) []kuikv1alpha1.CachedImage {
+func DesiredCachedImages(ctx context.Context, pod *corev1.Pod) []kuikv1alpha1ext1.CachedImage {
 	cachedImages := desiredCachedImagesForContainers(ctx, pod.Spec.Containers, pod.Annotations, false)
 	cachedImages = append(cachedImages, desiredCachedImagesForContainers(ctx, pod.Spec.InitContainers, pod.Annotations, true)...)
 	return cachedImages
 }
 
-func desiredCachedImagesForContainers(ctx context.Context, containers []corev1.Container, annotations map[string]string, initContainer bool) []kuikv1alpha1.CachedImage {
+func desiredCachedImagesForContainers(ctx context.Context, containers []corev1.Container, annotations map[string]string, initContainer bool) []kuikv1alpha1ext1.CachedImage {
 	log := log.FromContext(ctx)
-	cachedImages := []kuikv1alpha1.CachedImage{}
+	cachedImages := []kuikv1alpha1ext1.CachedImage{}
 
 	for _, container := range containers {
 		annotationKey := registry.ContainerAnnotationKey(container.Name, initContainer)
@@ -249,7 +249,7 @@ func desiredCachedImagesForContainers(ctx context.Context, containers []corev1.C
 	return cachedImages
 }
 
-func cachedImageFromSourceImage(sourceImage string) (*kuikv1alpha1.CachedImage, error) {
+func cachedImageFromSourceImage(sourceImage string) (*kuikv1alpha1ext1.CachedImage, error) {
 	ref, err := reference.ParseAnyReference(sourceImage)
 	if err != nil {
 		return nil, err
@@ -260,12 +260,12 @@ func cachedImageFromSourceImage(sourceImage string) (*kuikv1alpha1.CachedImage,
 		sanitizedName += "-latest"
 	}
 
-	cachedImage := kuikv1alpha1.CachedImage{
-		TypeMeta: metav1.TypeMeta{APIVersion: kuikv1alpha1.GroupVersion.String(), Kind: "CachedImage"},
+	cachedImage := kuikv1alpha1ext1.CachedImage{
+		TypeMeta: metav1.TypeMeta{APIVersion: kuikv1alpha1ext1.GroupVersion.String(), Kind: "CachedImage"},
 		ObjectMeta: metav1.ObjectMeta{
 			Name: sanitizedName,
 		},
-		Spec: kuikv1alpha1.CachedImageSpec{
+		Spec: kuikv1alpha1ext1.CachedImageSpec{
 			SourceImage: sourceImage,
 		},
 	}

internal/controller/core/pod_controller_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	kuikv1alpha1 "github.com/enix/kube-image-keeper/api/kuik/v1alpha1"
+	kuikv1alpha1ext1 "github.com/enix/kube-image-keeper/api/kuik/v1alpha1ext1"
 	"github.com/enix/kube-image-keeper/internal/registry"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -57,19 +57,19 @@ func TestDesiredCachedImages(t *testing.T) {
 	tests := []struct {
 		name         string
 		pod          corev1.Pod
-		cachedImages []kuikv1alpha1.CachedImage
+		cachedImages []kuikv1alpha1ext1.CachedImage
 	}{
 		{
 			name: "basic",
 			pod:  podStub,
-			cachedImages: []kuikv1alpha1.CachedImage{
-				{Spec: kuikv1alpha1.CachedImageSpec{
+			cachedImages: []kuikv1alpha1ext1.CachedImage{
+				{Spec: kuikv1alpha1ext1.CachedImageSpec{
 					SourceImage: "nginx",
 				}},
-				{Spec: kuikv1alpha1.CachedImageSpec{
+				{Spec: kuikv1alpha1ext1.CachedImageSpec{
 					SourceImage: "busybox",
 				}},
-				{Spec: kuikv1alpha1.CachedImageSpec{
+				{Spec: kuikv1alpha1ext1.CachedImageSpec{
 					SourceImage: "alpine",
 				}},
 			},
@@ -146,16 +146,16 @@ var _ = Describe("Pod Controller", func() {
 		podStubNotRewritten.ResourceVersion = ""
 
 		By("Deleting all cached images")
-		Expect(k8sClient.DeleteAllOf(context.Background(), &kuikv1alpha1.CachedImage{})).Should(Succeed())
+		Expect(k8sClient.DeleteAllOf(context.Background(), &kuikv1alpha1ext1.CachedImage{})).Should(Succeed())
 	})
 
 	Context("Pod with containers and init containers", func() {
 		It("Should handle CachedImages creation and deletion", func() {
 			By("Creating a pod")
 			Expect(k8sClient.Create(context.Background(), &podStub)).Should(Succeed())
 
-			fetched := &kuikv1alpha1.CachedImageList{}
-			Eventually(func() []kuikv1alpha1.CachedImage {
+			fetched := &kuikv1alpha1ext1.CachedImageList{}
+			Eventually(func() []kuikv1alpha1ext1.CachedImage {
 				_ = k8sClient.List(context.Background(), fetched)
 				return fetched.Items
 			}, timeout, interval).Should(HaveLen(len(podStub.Spec.Containers) + len(podStub.Spec.InitContainers)))
@@ -177,8 +177,8 @@ var _ = Describe("Pod Controller", func() {
 			By("Creating a pod without rewriting images")
 			Expect(k8sClient.Create(context.Background(), &podStubNotRewritten)).Should(Succeed())
 
-			fetched := &kuikv1alpha1.CachedImageList{}
-			Eventually(func() []kuikv1alpha1.CachedImage {
+			fetched := &kuikv1alpha1ext1.CachedImageList{}
+			Eventually(func() []kuikv1alpha1ext1.CachedImage {
 				_ = k8sClient.List(context.Background(), fetched)
 				return fetched.Items
 			}, timeout, interval).Should(HaveLen(0))