chore: update image cache config

Make it nested, so that we can expand easily to support e.g. distributed cache. Signed-off-by: Andrey Smirnov <[email protected]>
siderolabs · Nov 27, 2024 · af91c99 · af91c99
1 parent e10e90b
commit af91c99
Show file tree

Hide file tree

Showing 11 changed files with 110 additions and 14 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,8 @@
 blank_issues_enabled: false
 contact_links:
   - name: Question
+    url: https://github.com/siderolabs/talos/discussions
+    about: Ask a question about Talos Linux.
+  - name: Community
     url: https://taloscommunity.slack.com
-    about: Ask a question. Get your invite by visiting https://slack.dev.talos-systems.io.
+    about: Join the community. Get your invite by visiting https://slack.dev.talos-systems.io.
diff --git a/internal/app/machined/pkg/controllers/cri/image_cache_config.go b/internal/app/machined/pkg/controllers/cri/image_cache_config.go
@@ -119,7 +119,7 @@ func (ctrl *ImageCacheConfigController) Run(ctx context.Context, r controller.Ru
 		}
 
 		// image cache is disabled
-		imageCacheDisabled := cfg == nil || cfg.Config().Machine() == nil || !cfg.Config().Machine().Features().ImageCacheEnabled()
+		imageCacheDisabled := cfg == nil || cfg.Config().Machine() == nil || !cfg.Config().Machine().Features().ImageCache().LocalEnabled()
 
 		var (
 			status cri.ImageCacheStatus

diff --git a/internal/app/machined/pkg/controllers/cri/image_cache_config_test.go b/internal/app/machined/pkg/controllers/cri/image_cache_config_test.go
@@ -51,7 +51,9 @@ func (suite *ImageCacheConfigSuite) TestReconcileFeatureEnabled() {
 	cfg := config.NewMachineConfig(container.NewV1Alpha1(&v1alpha1.Config{
 		MachineConfig: &v1alpha1.MachineConfig{
 			MachineFeatures: &v1alpha1.FeaturesConfig{
-				ImageCache: pointer.To(true),
+				ImageCacheSupport: &v1alpha1.ImageCacheConfig{
+					CacheLocalEnabled: pointer.To(true),
+				},
 			},
 		},
 	}))
@@ -117,7 +119,9 @@ func (suite *ImageCacheConfigSuite) TestReconcileWithImageCacheVolume() {
 	v1alpha1Cfg := &v1alpha1.Config{
 		MachineConfig: &v1alpha1.MachineConfig{
 			MachineFeatures: &v1alpha1.FeaturesConfig{
-				ImageCache: pointer.To(true),
+				ImageCacheSupport: &v1alpha1.ImageCacheConfig{
+					CacheLocalEnabled: pointer.To(true),
+				},
 			},
 		},
 	}

diff --git a/internal/app/machined/pkg/runtime/v1alpha1/v1alpha1_runtime.go b/internal/app/machined/pkg/runtime/v1alpha1/v1alpha1_runtime.go
@@ -164,7 +164,7 @@ func (r *Runtime) CanApplyImmediate(cfg config.Provider) error {
 			newConfig.MachineConfig.MachineFeatures.KubernetesTalosAPIAccessConfig = currentConfig.MachineConfig.MachineFeatures.KubernetesTalosAPIAccessConfig
 			newConfig.MachineConfig.MachineFeatures.KubePrismSupport = currentConfig.MachineConfig.MachineFeatures.KubePrismSupport
 			newConfig.MachineConfig.MachineFeatures.HostDNSSupport = currentConfig.MachineConfig.MachineFeatures.HostDNSSupport
-			newConfig.MachineConfig.MachineFeatures.ImageCache = currentConfig.MachineConfig.MachineFeatures.ImageCache
+			newConfig.MachineConfig.MachineFeatures.ImageCacheSupport = currentConfig.MachineConfig.MachineFeatures.ImageCacheSupport
 		}
 	}
 

diff --git a/pkg/machinery/config/config/machine.go b/pkg/machinery/config/config/machine.go
@@ -448,7 +448,7 @@ type Features interface {
 	DiskQuotaSupportEnabled() bool
 	HostDNS() HostDNS
 	KubePrism() KubePrism
-	ImageCacheEnabled() bool
+	ImageCache() ImageCache
 }
 
 // KubernetesTalosAPIAccess describes the Kubernetes Talos API access features.
@@ -471,6 +471,11 @@ type HostDNS interface {
 	ResolveMemberNames() bool
 }
 
+// ImageCache describes the image cache configuration.
+type ImageCache interface {
+	LocalEnabled() bool
+}
+
 // UdevConfig describes configuration for udev.
 type UdevConfig interface {
 	Rules() []string

diff --git a/pkg/machinery/config/schemas/config.schema.json b/pkg/machinery/config/schemas/config.schema.json
@@ -2072,7 +2072,7 @@
           "x-intellij-html-description": "\u003cp\u003eConfigures host DNS caching resolver.\u003c/p\u003e\n"
         },
         "imageCache": {
-          "type": "boolean",
+          "$ref": "#/$defs/v1alpha1.ImageCacheConfig",
           "title": "imageCache",
           "description": "Enable Image Cache feature.\n",
           "markdownDescription": "Enable Image Cache feature.",
@@ -2125,6 +2125,19 @@
       "additionalProperties": false,
       "type": "object"
     },
+    "v1alpha1.ImageCacheConfig": {
+      "properties": {
+        "localEnabled": {
+          "type": "boolean",
+          "title": "localEnabled",
+          "description": "Enable local image cache.\n",
+          "markdownDescription": "Enable local image cache.",
+          "x-intellij-html-description": "\u003cp\u003eEnable local image cache.\u003c/p\u003e\n"
+        }
+      },
+      "additionalProperties": false,
+      "type": "object"
+    },
     "v1alpha1.InstallConfig": {
       "properties": {
         "disk": {

diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_features.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_features.go
@@ -57,9 +57,13 @@ func (f *FeaturesConfig) KubePrism() config.KubePrism {
 	return f.KubePrismSupport
 }
 
-// ImageCacheEnabled implements config.Features interface.
-func (f *FeaturesConfig) ImageCacheEnabled() bool {
-	return pointer.SafeDeref(f.ImageCache)
+// ImageCache implements config.Features interface.
+func (f *FeaturesConfig) ImageCache() config.ImageCache {
+	if f.ImageCacheSupport == nil {
+		return &ImageCacheConfig{}
+	}
+
+	return f.ImageCacheSupport
 }
 
 const defaultKubePrismPort = 7445
@@ -92,3 +96,8 @@ func (h *HostDNSConfig) ForwardKubeDNSToHost() bool {
 func (h *HostDNSConfig) ResolveMemberNames() bool {
 	return pointer.SafeDeref(h.HostDNSResolveMemberNames)
 }
+
+// LocalEnabled implements config.ImageCache.
+func (i *ImageCacheConfig) LocalEnabled() bool {
+	return pointer.SafeDeref(i.CacheLocalEnabled)
+}
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
@@ -2169,7 +2169,7 @@ type FeaturesConfig struct {
 	HostDNSSupport *HostDNSConfig `yaml:"hostDNS,omitempty"`
 	//   description: |
 	//     Enable Image Cache feature.
-	ImageCache *bool `yaml:"imageCache,omitempty"`
+	ImageCacheSupport *ImageCacheConfig `yaml:"imageCache,omitempty"`
 }
 
 // KubePrism describes the configuration for the KubePrism load balancer.
@@ -2182,6 +2182,13 @@ type KubePrism struct {
 	ServerPort int `yaml:"port,omitempty"`
 }
 
+// ImageCacheConfig describes the configuration for the Image Cache feature.
+type ImageCacheConfig struct {
+	//   description: |
+	//     Enable local image cache.
+	CacheLocalEnabled *bool `yaml:"localEnabled,omitempty"`
+}
+
 // KubernetesTalosAPIAccessConfig describes the configuration for the Talos API access from Kubernetes pods.
 type KubernetesTalosAPIAccessConfig struct {
 	//   description: |

diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
diff --git a/website/content/v1.9/reference/configuration/v1alpha1/config.md b/website/content/v1.9/reference/configuration/v1alpha1/config.md
@@ -2627,7 +2627,7 @@ kubernetesTalosAPIAccess:
 |`diskQuotaSupport` |bool |<details><summary>Enable XFS project quota support for EPHEMERAL partition and user disks.</summary>Also enables kubelet tracking of ephemeral disk usage in the kubelet via quota.</details>  | |
 |`kubePrism` |<a href="#Config.machine.features.kubePrism">KubePrism</a> |<details><summary>KubePrism - local proxy/load balancer on defined port that will distribute</summary>requests to all API servers in the cluster.</details>  | |
 |`hostDNS` |<a href="#Config.machine.features.hostDNS">HostDNSConfig</a> |Configures host DNS caching resolver.  | |
-|`imageCache` |bool |Enable Image Cache feature.  | |
+|`imageCache` |<a href="#Config.machine.features.imageCache">ImageCacheConfig</a> |Enable Image Cache feature.  | |
 
 
 
@@ -2698,6 +2698,22 @@ HostDNSConfig describes the configuration for the host DNS resolver.
 
 
 
+#### imageCache {#Config.machine.features.imageCache}
+
+ImageCacheConfig describes the configuration for the Image Cache feature.
+
+
+
+
+| Field | Type | Description | Value(s) |
+|-------|------|-------------|----------|
+|`localEnabled` |bool |Enable local image cache.  | |
+
+
+
+
+
+
 
 
 ### udev {#Config.machine.udev}

diff --git a/website/content/v1.9/schemas/config.schema.json b/website/content/v1.9/schemas/config.schema.json
@@ -2072,7 +2072,7 @@
           "x-intellij-html-description": "\u003cp\u003eConfigures host DNS caching resolver.\u003c/p\u003e\n"
         },
         "imageCache": {
-          "type": "boolean",
+          "$ref": "#/$defs/v1alpha1.ImageCacheConfig",
           "title": "imageCache",
           "description": "Enable Image Cache feature.\n",
           "markdownDescription": "Enable Image Cache feature.",
@@ -2125,6 +2125,19 @@
       "additionalProperties": false,
       "type": "object"
     },
+    "v1alpha1.ImageCacheConfig": {
+      "properties": {
+        "localEnabled": {
+          "type": "boolean",
+          "title": "localEnabled",
+          "description": "Enable local image cache.\n",
+          "markdownDescription": "Enable local image cache.",
+          "x-intellij-html-description": "\u003cp\u003eEnable local image cache.\u003c/p\u003e\n"
+        }
+      },
+      "additionalProperties": false,
+      "type": "object"
+    },
     "v1alpha1.InstallConfig": {
       "properties": {
         "disk": {