feat: env variables for provider name and namespace

Author: robertgraeff

api/constants/constants.go

@@ -21,4 +21,11 @@ const (
 	OnboardingNameLabel = OpenMCPGroupName + "/onboarding-name"
 	// OnboardingNamespaceLabel is used to store the namespace on the onboarding cluster of a resource.
 	OnboardingNamespaceLabel = OpenMCPGroupName + "/onboarding-namespace"
+
+	// EnvVariableProviderName is the name of an environment variable passed to providers.
+	// It contains the name of the provider resource.
+	EnvVariableProviderName = "OPENMCP_PROVIDER_NAME"
+	// EnvVariablePlatformClusterNamespace is the name of an environment variable passed to providers.
+	// It contains the namespace on the platform cluster in which the provider is running.
+	EnvVariablePlatformClusterNamespace = "OPENMCP_PLATFORM_CLUSTER_NAMESPACE"
 )

docs/controller/deployment.md

@@ -26,6 +26,16 @@ run
 --verbosity <DEBUG|INFO|ERROR>
 ```
 
+### Env Variables
+
+The environment variables below are available in the pods of the init job and the deployment of providers:
+
+- the environment variables specified in the [provider resource](#provider-resource), in field `spec.env`;
+- the following predefined environment variables:
+  - `OPENMCP_PROVIDER_NAME`: the name of the provider resource;
+  - `OPENMCP_PLATFORM_CLUSTER_NAMESPACE`: the namespace on the platform cluster in which the provider is running.
+
+
 ## Provider Resource
 
 The provider resources specify how to deploy the providers. They are of the kind `ClusterProvider`, `ServiceProvider`, or `PlatformService`. They are cluster-scoped, and have the following common structure:

internal/controllers/provider/controller_test.go

@@ -64,7 +64,7 @@ var _ = Describe("Deployment Controller", func() {
 			Expect(job.Spec.Template.Spec.Containers[0].Args).To(ContainElement("init"), "Job container args should contain the init command")
 			Expect(job.Spec.Template.Spec.Containers[0].Args).To(ContainElement("--environment=test-environment"), "Job container args should contain the environment")
 			Expect(job.Spec.Template.Spec.Containers[0].Args).To(ContainElement("--verbosity=DEBUG"), "Job container args should contain the verbosity")
-			Expect(job.Spec.Template.Spec.Containers[0].Env).To(HaveLen(1), "Job container should have an environment variables")
+			Expect(job.Spec.Template.Spec.Containers[0].Env).To(HaveLen(3), "Job container should have an environment variables")
 			Expect(job.Spec.Template.Spec.Containers[0].Env[0].Name).To(Equal("NAME"), "Job container environment variable name should match the provider spec")
 			Expect(job.Spec.Template.Spec.Containers[0].Env[0].Value).To(Equal("test-name"), "Job container environment variable value should match the provider spec")
 
@@ -82,7 +82,7 @@ var _ = Describe("Deployment Controller", func() {
 			Expect(deploy.Spec.Template.Spec.Containers[0].Args).To(ContainElement("run"), "Deployment container args should contain the run command")
 			Expect(deploy.Spec.Template.Spec.Containers[0].Args).To(ContainElement("--environment=test-environment"), "Deployment container args should contain the environment")
 			Expect(deploy.Spec.Template.Spec.Containers[0].Args).To(ContainElement("--verbosity=DEBUG"), "Deployment container args should contain the verbosity")
-			Expect(deploy.Spec.Template.Spec.Containers[0].Env).To(HaveLen(1), "Deployment container should have an environment variables")
+			Expect(deploy.Spec.Template.Spec.Containers[0].Env).To(HaveLen(3), "Deployment container should have an environment variables")
 			Expect(deploy.Spec.Template.Spec.Containers[0].Env[0].Name).To(Equal("NAME"), "Deployment container environment variable name should match the provider spec")
 			Expect(deploy.Spec.Template.Spec.Containers[0].Env[0].Value).To(Equal("test-name"), "Deployment container environment variable value should match the provider spec")
 

internal/controllers/provider/install/deployment.go

@@ -49,6 +49,11 @@ func (m *deploymentMutator) Empty() *appsv1.Deployment {
 }
 
 func (m *deploymentMutator) Mutate(d *appsv1.Deployment) error {
+	env, err := m.values.EnvironmentVariables()
+	if err != nil {
+		return err
+	}
+
 	d.Spec = appsv1.DeploymentSpec{
 		Replicas: ptr.To[int32](1),
 		Selector: &metav1.LabelSelector{
@@ -69,7 +74,7 @@ func (m *deploymentMutator) Mutate(d *appsv1.Deployment) error {
 							"--environment=" + m.values.Environment(),
 							"--verbosity=" + m.values.Verbosity(),
 						},
-						Env: m.values.EnvironmentVariables(),
+						Env: env,
 					},
 				},
 				ImagePullSecrets:   m.values.ImagePullSecrets(),

internal/controllers/provider/install/job.go

@@ -55,6 +55,11 @@ func (m *jobMutator) Empty() *v1.Job {
 }
 
 func (m *jobMutator) Mutate(j *v1.Job) error {
+	env, err := m.values.EnvironmentVariables()
+	if err != nil {
+		return err
+	}
+
 	j.Spec = v1.JobSpec{
 		BackoffLimit: ptr.To[int32](4),
 		Template: corev1.PodTemplateSpec{
@@ -72,7 +77,7 @@ func (m *jobMutator) Mutate(j *v1.Job) error {
 							"--environment=" + m.values.Environment(),
 							"--verbosity=" + m.values.Verbosity(),
 						},
-						Env: m.values.EnvironmentVariables(),
+						Env: env,
 					},
 				},
 				ServiceAccountName: m.values.NamespacedResourceName(initPrefix),

internal/controllers/provider/install/suite_test.go

@@ -0,0 +1,14 @@
+package install
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestComponentUtils(t *testing.T) {
+	RegisterFailHandler(Fail)
+
+	RunSpecs(t, "Installer Test Suite")
+}

internal/controllers/provider/install/values.go

@@ -7,6 +7,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 
+	"github.com/openmcp-project/openmcp-operator/api/constants"
 	"github.com/openmcp-project/openmcp-operator/api/provider/v1alpha1"
 )
 
@@ -35,11 +36,11 @@ func (v *Values) Environment() string {
 func determineNamespace(provider *unstructured.Unstructured) string {
 	var namespacePrefix string
 	switch provider.GroupVersionKind().Kind {
-	case "ServiceProvider":
+	case v1alpha1.ServiceProviderGKV().Kind:
 		namespacePrefix = "sp"
-	case "ClusterProvider":
+	case v1alpha1.ClusterProviderGKV().Kind:
 		namespacePrefix = "cp"
-	case "PlatformService":
+	case v1alpha1.PlatformServiceGKV().Kind:
 		namespacePrefix = "ps"
 	default:
 		namespacePrefix = provider.GroupVersionKind().Kind
@@ -105,7 +106,23 @@ func (v *Values) Verbosity() string {
 	return v.deploymentSpec.Verbosity
 }
 
-func (v *Values) EnvironmentVariables() []corev1.EnvVar {
+// EnvironmentVariables returns the environment variables set in the provider resource, enriched by the following:
+// - OPENMCP_PROVIDER_NAME: the name of the provider resource,
+// - OPENMCP_PROVIDER_NAMESPACE: the namespace in which the provider will be deployed.
+func (v *Values) EnvironmentVariables() ([]corev1.EnvVar, error) {
+	varList := append(
+		v.providerEnvironmentVariables(),
+		corev1.EnvVar{Name: constants.EnvVariableProviderName, Value: v.provider.GetName()},
+		corev1.EnvVar{Name: constants.EnvVariablePlatformClusterNamespace, Value: v.namespace},
+	)
+
+	if err := v.checkUniquenessOfVariableNames(varList); err != nil {
+		return nil, err
+	}
+	return varList, nil
+}
+
+func (v *Values) providerEnvironmentVariables() []corev1.EnvVar {
 	env := make([]corev1.EnvVar, len(v.deploymentSpec.Env))
 	for i, e := range v.deploymentSpec.Env {
 		env[i] = corev1.EnvVar{
@@ -115,3 +132,14 @@ func (v *Values) EnvironmentVariables() []corev1.EnvVar {
 	}
 	return env
 }
+
+func (v *Values) checkUniquenessOfVariableNames(varList []corev1.EnvVar) error {
+	varMap := make(map[string]bool)
+	for _, e := range varList {
+		if varMap[e.Name] {
+			return fmt.Errorf("environment variable is not unique: %s", e.Name)
+		}
+		varMap[e.Name] = true
+	}
+	return nil
+}

internal/controllers/provider/install/values_test.go

@@ -0,0 +1,54 @@
+package install
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+
+	"github.com/openmcp-project/openmcp-operator/api/constants"
+	"github.com/openmcp-project/openmcp-operator/api/provider/v1alpha1"
+)
+
+var _ = Describe("Installer", func() {
+
+	Context("Env Variables", func() {
+
+		const (
+			providerName = "test-provider"
+			envName1     = "NAME_1"
+			envValue1    = "VALUE_1"
+		)
+
+		It("should contain provider variables and predefined openmcp variables", func() {
+			provider := &unstructured.Unstructured{}
+			provider.SetGroupVersionKind(v1alpha1.ClusterProviderGKV())
+			provider.SetName(providerName)
+			spec := &v1alpha1.DeploymentSpec{
+				Env: []v1alpha1.EnvVar{
+					{Name: envName1, Value: envValue1},
+				},
+			}
+			v := NewValues(provider, spec, "test")
+			env, err := v.EnvironmentVariables()
+			Expect(err).NotTo(HaveOccurred())
+			Expect(env).To(ContainElement(corev1.EnvVar{Name: envName1, Value: envValue1}))
+			Expect(env).To(ContainElement(corev1.EnvVar{Name: constants.EnvVariableProviderName, Value: providerName}))
+			Expect(env).To(ContainElement(corev1.EnvVar{Name: constants.EnvVariablePlatformClusterNamespace, Value: v.Namespace()}))
+		})
+
+		It("should detect a name conflict", func() {
+			provider := &unstructured.Unstructured{}
+			provider.SetGroupVersionKind(v1alpha1.ClusterProviderGKV())
+			provider.SetName(providerName)
+			spec := &v1alpha1.DeploymentSpec{
+				Env: []v1alpha1.EnvVar{
+					{Name: constants.EnvVariableProviderName, Value: envValue1},
+				},
+			}
+			v := NewValues(provider, spec, "test")
+			_, err := v.EnvironmentVariables()
+			Expect(err).To(HaveOccurred())
+		})
+	})
+})