feat: support environment in ExtensionServicesConfig

Support setting extension services environment variables in `ExtensionServicesConfig` document. Fixes: #8271 Signed-off-by: Noel Georgi <[email protected]>
siderolabs · Feb 6, 2024 · 5b1bbec · 5b1bbec
1 parent 1e6c8c4
commit 5b1bbec
Show file tree

Hide file tree

Showing 13 changed files with 231 additions and 142 deletions.
diff --git a/api/resource/definitions/runtime/runtime.proto b/api/resource/definitions/runtime/runtime.proto
@@ -25,7 +25,8 @@ message ExtensionServicesConfigFile {
 
 // ExtensionServicesConfigSpec describes status of rendered extensions service config files.
 message ExtensionServicesConfigSpec {
-  repeated ExtensionServicesConfigFile files = 2;
+  repeated ExtensionServicesConfigFile files = 1;
+  repeated string environment = 2;
 }
 
 // ExtensionServicesConfigStatusSpec describes status of rendered extensions service config files.

diff --git a/internal/app/machined/pkg/controllers/runtime/extension_services_config.go b/internal/app/machined/pkg/controllers/runtime/extension_services_config.go
@@ -78,6 +78,9 @@ func (ctrl *ExtensionServicesConfigController) Run(ctx context.Context, r contro
 						}
 					})
 
+					logger.Info("extension services config", zap.String("name", ext.Name()), zap.Any("environment", ext.Environment()))
+					spec.TypedSpec().Environment = ext.Environment()
+
 					return nil
 				}); err != nil {
 					return err

diff --git a/internal/app/machined/pkg/controllers/runtime/extension_services_config_test.go b/internal/app/machined/pkg/controllers/runtime/extension_services_config_test.go
@@ -57,6 +57,7 @@ func (suite *ExtensionServicesConfigSuite) TestReconcileExtensionServicesConfig(
 					ExtensionMountPath: "/var/etc/foo",
 				},
 			},
+			ExtensionServiceEnvironment: []string{"FOO=BAR"},
 		},
 	}
 
@@ -72,6 +73,7 @@ func (suite *ExtensionServicesConfigSuite) TestReconcileExtensionServicesConfig(
 			content   string
 			mountPath string
 		}
+		environment []string
 	}{
 		{
 			extensionName: "test-extension-a",
@@ -100,6 +102,9 @@ func (suite *ExtensionServicesConfigSuite) TestReconcileExtensionServicesConfig(
 					mountPath: "/var/etc/foo",
 				},
 			},
+			environment: []string{
+				"FOO=BAR",
+			},
 		},
 	} {
 		ctest.AssertResource(suite, tt.extensionName, func(config *runtimeres.ExtensionServicesConfig, asrt *assert.Assertions) {
@@ -117,6 +122,7 @@ func (suite *ExtensionServicesConfigSuite) TestReconcileExtensionServicesConfig(
 			})
 
 			suite.Assert().Equal(configFileData, spec.Files)
+			suite.Assert().Equal(tt.environment, spec.Environment)
 		})
 	}
 

diff --git a/internal/app/machined/pkg/system/services/extension.go b/internal/app/machined/pkg/system/services/extension.go
@@ -166,6 +166,11 @@ func (svc *Extension) Runner(r runtime.Runtime) (runner.Runner, error) {
 
 	mounts := append([]specs.Mount{}, svc.Spec.Container.Mounts...)
 
+	envVars, err := svc.parseEnvironment()
+	if err != nil {
+		return nil, err
+	}
+
 	configSpec, err := safe.StateGetByID[*runtimeres.ExtensionServicesConfig](context.Background(), r.State().V1Alpha2().Resources(), svc.Spec.Name)
 	if err == nil {
 		spec := configSpec.TypedSpec()
@@ -178,6 +183,8 @@ func (svc *Extension) Runner(r runtime.Runtime) (runner.Runner, error) {
 				Options:     []string{"ro", "bind"},
 			})
 		}
+
+		envVars = append(envVars, spec.Environment...)
 	} else if !state.IsNotFoundError(err) {
 		return nil, err
 	}
@@ -193,11 +200,6 @@ func (svc *Extension) Runner(r runtime.Runtime) (runner.Runner, error) {
 		restartType = restart.UntilSuccess
 	}
 
-	envVars, err := svc.parseEnvironment()
-	if err != nil {
-		return nil, err
-	}
-
 	ociSpecOpts := svc.getOCIOptions(envVars, mounts)
 
 	debug := false

diff --git a/pkg/machinery/api/resource/definitions/runtime/runtime.pb.go b/pkg/machinery/api/resource/definitions/runtime/runtime.pb.go
diff --git a/pkg/machinery/api/resource/definitions/runtime/runtime_vtproto.pb.go b/pkg/machinery/api/resource/definitions/runtime/runtime_vtproto.pb.go
diff --git a/pkg/machinery/config/config/extensions_service_config.go b/pkg/machinery/config/config/extensions_service_config.go
@@ -13,6 +13,7 @@ type ExtensionServicesConfigConfig interface {
 type ExtensionServicesConfig interface {
 	Name() string
 	ConfigFiles() []ExtensionServicesConfigFile
+	Environment() []string
 }
 
 // ExtensionServicesConfigFile is a config file for extension services.

diff --git a/pkg/machinery/config/types/extensionservicesconfig/deep_copy.generated.go b/pkg/machinery/config/types/extensionservicesconfig/deep_copy.generated.go
diff --git a/pkg/machinery/config/types/extensionservicesconfig/extension_services_config.go b/pkg/machinery/config/types/extensionservicesconfig/extension_services_config.go
@@ -49,6 +49,7 @@ type V1Alpha1 struct {
 type ExtensionServiceConfig struct {
 	ExtensionName               string                       `yaml:"name"`
 	ExtensionServiceConfigFiles []ExtensionServiceConfigFile `yaml:"configFiles"`
+	ExtensionServiceEnvironment []string                     `yaml:"environment"`
 }
 
 // ExtensionServiceConfigFile is a config file for extension services.
@@ -83,8 +84,14 @@ func (e *V1Alpha1) Validate(validation.RuntimeMode, ...validation.Option) ([]str
 			return nil, fmt.Errorf("extension name is required")
 		}
 
-		if len(ext.ExtensionServiceConfigFiles) == 0 {
-			return nil, fmt.Errorf("no config files found for extension %q", ext.ExtensionName)
+		if len(ext.ExtensionServiceConfigFiles) == 0 && len(ext.ExtensionServiceEnvironment) == 0 {
+			if len(ext.ExtensionServiceConfigFiles) == 0 {
+				return nil, fmt.Errorf("no config files found for extension %q", ext.ExtensionName)
+			}
+
+			if len(ext.ExtensionServiceEnvironment) == 0 {
+				return nil, fmt.Errorf("no environment defined for extension %q", ext.ExtensionName)
+			}
 		}
 
 		for _, file := range ext.ExtensionServiceConfigFiles {
@@ -101,12 +108,7 @@ func (e *V1Alpha1) Validate(validation.RuntimeMode, ...validation.Option) ([]str
 	return nil, nil
 }
 
-// ExtensionsCfg implements config.ExtensionsConfig interface.
-func (e *V1Alpha1) ExtensionsCfg() config.ExtensionServicesConfigConfig {
-	return e
-}
-
-// ConfigData implements config.ExtensionConfig interface.
+// ConfigData implements config.ExtensionServicesConfigConfig interface.
 func (e *V1Alpha1) ConfigData() []config.ExtensionServicesConfig {
 	return xslices.Map(e.Config, func(c ExtensionServiceConfig) config.ExtensionServicesConfig {
 		return &ExtensionServiceConfig{
@@ -116,12 +118,12 @@ func (e *V1Alpha1) ConfigData() []config.ExtensionServicesConfig {
 	})
 }
 
-// Name implements config.ExtensionConfig interface.
+// Name implements config.ExtensionServicesConfig interface.
 func (e *ExtensionServiceConfig) Name() string {
 	return e.ExtensionName
 }
 
-// ConfigFiles implements config.ExtensionConfig interface.
+// ConfigFiles implements config.ExtensionServicesConfig interface.
 func (e *ExtensionServiceConfig) ConfigFiles() []config.ExtensionServicesConfigFile {
 	return xslices.Map(e.ExtensionServiceConfigFiles, func(c ExtensionServiceConfigFile) config.ExtensionServicesConfigFile {
 		return &ExtensionServiceConfigFile{
@@ -131,12 +133,17 @@ func (e *ExtensionServiceConfig) ConfigFiles() []config.ExtensionServicesConfigF
 	})
 }
 
-// Content implements config.ConfigFile interface.
+// Environment implements config.ExtensionServicesConfig interface.
+func (e *ExtensionServiceConfig) Environment() []string {
+	return e.ExtensionServiceEnvironment
+}
+
+// Content implements config.ExtensionServicesConfigFile interface.
 func (e *ExtensionServiceConfigFile) Content() string {
 	return e.ExtensionContent
 }
 
-// Path implements config.ConfigFile interface.
+// Path implements config.ExtensionServicesConfigFile interface.
 func (e *ExtensionServiceConfigFile) Path() string {
 	return e.ExtensionMountPath
 }
diff --git a/pkg/machinery/config/types/extensionservicesconfig/extension_services_config_test.go b/pkg/machinery/config/types/extensionservicesconfig/extension_services_config_test.go
@@ -31,6 +31,7 @@ func TestExtensionServicesConfigMarshalStability(t *testing.T) {
 					ExtensionMountPath: "/etc/foo",
 				},
 			},
+			ExtensionServiceEnvironment: []string{"FOO=BAR"},
 		},
 	}
 

diff --git a/pkg/machinery/config/types/extensionservicesconfig/testdata/extension_service_config.yaml b/pkg/machinery/config/types/extensionservicesconfig/testdata/extension_service_config.yaml
@@ -5,3 +5,5 @@ config:
       configFiles:
         - content: hello
           mountPath: /etc/foo
+      environment:
+        - FOO=BAR
diff --git a/pkg/machinery/resources/runtime/deep_copy.generated.go b/pkg/machinery/resources/runtime/deep_copy.generated.go
diff --git a/pkg/machinery/resources/runtime/extension_services_config.go b/pkg/machinery/resources/runtime/extension_services_config.go
@@ -23,7 +23,8 @@ type ExtensionServicesConfig = typed.Resource[ExtensionServicesConfigSpec, Exten
 //
 //gotagsrewrite:gen
 type ExtensionServicesConfigSpec struct {
-	Files []ExtensionServicesConfigFile `yaml:"files" protobuf:"2"`
+	Files       []ExtensionServicesConfigFile `yaml:"files" protobuf:"1"`
+	Environment []string                      `yaml:"environment" protobuf:"2"`
 }
 
 // ExtensionServicesConfigFile describes extensions service config files.