Merge pull request #6 from cybozu-go/add-nodeimageset-crd

Create a template for the NodeImageSet CRD

Author: zeroalphat

PROJECT

@@ -13,4 +13,12 @@ resources:
   kind: ImagePrefetch
   path: github.com/cybozu-go/ofen/api/v1
   version: v1
+- api:
+    crdVersion: v1
+  controller: true
+  domain: cybozu.io
+  group: ofen
+  kind: NodeImageSet
+  path: github.com/cybozu-go/ofen/api/v1
+  version: v1
 version: "3"

api/v1/imageprefetch_types.go

@@ -57,9 +57,9 @@ type ImagePrefetchStatus struct {
 }
 
 const (
-	ConditionReady               = "Ready"
-	ConditionProgressing         = "Progressing"
-	ConditionImageDownloadFailed = "ImageDownloadFailed"
+	ConditionReady           = "Ready"
+	ConditionProgressing     = "Progressing"
+	ConditionImagePullFailed = "ImagePullFailed"
 )
 
 // +kubebuilder:object:root=true

api/v1/nodeimageset_types.go

@@ -0,0 +1,104 @@
+package v1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// NodeImageSetSpec defines the desired state of NodeImageSet
+type NodeImageSetSpec struct {
+	// ImageSet is a list of image sets to be downloaded.
+	ImageSet []ImageSet `json:"imageSet"`
+
+	// NodeName is the name of the node where the image is downloaded.
+	NodeName string `json:"nodeName"`
+
+	// ImagePullSecrets is a list of secret names that contain credentials for authenticating with container registries
+	// +optional
+	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
+
+	// ImageDownloadRetryLimit specifies the maximum number of retry attempts for image downloads
+	// +optional
+	// +kubebuilder:default:=3
+	ImageDownloadRetryLimit int32 `json:"imageDownloadRetryLimit,omitempty"`
+}
+
+type ImageSet struct {
+	// image is the name of the image.
+	Image string `json:"image"`
+
+	// Registry Policy is the policy for downloading images from the registry.
+	RegistryPolicy RegistryPolicy `json:"registryPolicy"`
+}
+
+type RegistryPolicy string
+
+const (
+	// RegistryPolicyDefault download images according to containerd host configuration.
+	// If registry mirror are configured, it attempts to download images from registry mirror first,
+	// then falls back to upstream registry.
+	RegistryPolicyDefault RegistryPolicy = "Default"
+
+	// RegistryPolicyMirrorOnly downloads images only from registry mirrors defined in the containerd host configuration.
+	RegistryPolicyMirrorOnly RegistryPolicy = "MirrorOnly"
+)
+
+// NodeImageSetStatus defines the observed state of NodeImageSet
+type NodeImageSetStatus struct {
+	// The generation observed by the controller.
+	// +optional
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+
+	// Conditions represent the latest available observations of an object's state
+	// +listType=map
+	// +listMapKey=type
+	// +optional
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
+
+	// DesiredImages is the number of images that need to be downloaded.
+	// +optional
+	//+kubebuilder:default:=0
+	DesiredImages int `json:"desiredImages,omitempty"`
+
+	// AvailableImages is the number of images that have completed downloading.
+	// +optional
+	//+kubebuilder:default:=0
+	AvailableImages int `json:"availableImages,omitempty"`
+
+	// DownloadFailedImages is the number of images that failed to download.
+	// +optional
+	//+kubebuilder:default:=0
+	DownloadFailedImages int `json:"downloadFailedImages,omitempty"`
+}
+
+const (
+	ConditionImageAvailable        = "ImageAvailable"
+	ConditionImageDownloadComplete = "ImageDownloadComplete"
+	ConditionImageDownloadFailed   = "ImageDownloadFailed"
+)
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+// +kubebuilder:resource:scope=Cluster
+
+// NodeImageSet is the Schema for the nodeimagesets API
+type NodeImageSet struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   NodeImageSetSpec   `json:"spec,omitempty"`
+	Status NodeImageSetStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// NodeImageSetList contains a list of NodeImageSet
+type NodeImageSetList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []NodeImageSet `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&NodeImageSet{}, &NodeImageSetList{})
+}

api/v1/zz_generated.deepcopy.go

@@ -133,6 +133,13 @@ func main() {
 		setupLog.Error(err, "unable to create controller", "controller", "ImagePrefetch")
 		os.Exit(1)
 	}
+	if err = (&controller.NodeImageSetReconciler{
+		Client: mgr.GetClient(),
+		Scheme: mgr.GetScheme(),
+	}).SetupWithManager(mgr); err != nil {
+		setupLog.Error(err, "unable to create controller", "controller", "NodeImageSet")
+		os.Exit(1)
+	}
 	// +kubebuilder:scaffold:builder
 
 	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {