Provide env_vars fields to add custom env vars

closes: #1161

CHANGES/1161.feature

@@ -0,0 +1 @@
+Added `env_vars` field to define custom environment variables.

apis/repo-manager.pulpproject.org/v1beta2/pulp_types.go

@@ -463,6 +463,9 @@ type Api struct {
 
 	// InitContainer defines configuration of the init-containers that run in pulpcore pods
 	InitContainer PulpContainer `json:"init_container,omitempty"`
+
+	// Environment variables to add to pulpcore-api container
+	EnvVars []corev1.EnvVar `json:"env_vars,omitempty"`
 }
 
 // Content defines desired state of pulpcore-content resources
@@ -538,6 +541,9 @@ type Content struct {
 
 	// InitContainer defines configuration of the init-containers that run in pulpcore pods
 	InitContainer PulpContainer `json:"init_container,omitempty"`
+
+	// Environment variables to add to pulpcore-content container
+	EnvVars []corev1.EnvVar `json:"env_vars,omitempty"`
 }
 
 // Worker defines desired state of pulpcore-worker resources
@@ -599,6 +605,9 @@ type Worker struct {
 
 	// InitContainer defines configuration of the init-containers that run in pulpcore pods
 	InitContainer PulpContainer `json:"init_container,omitempty"`
+
+	// Environment variables to add to pulpcore-worker container
+	EnvVars []corev1.EnvVar `json:"env_vars,omitempty"`
 }
 
 // Web defines desired state of pulpcore-web (reverse-proxy) resources
@@ -654,6 +663,9 @@ type Web struct {
 	// +kubebuilder:validation:Enum:=edge;Edge;passthrough;Passthrough
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:advanced"}
 	TLSTerminationMechanism string `json:"tls_termination_mechanism,omitempty"`
+
+	// Environment variables to add to pulpcore-web container
+	EnvVars []corev1.EnvVar `json:"env_vars,omitempty"`
 }
 
 // Database defines desired state of postgres
@@ -880,6 +892,9 @@ type PulpContainer struct {
 	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:resourceRequirements","urn:alm:descriptor:com.tectonic.ui:advanced"}
 	ResourceRequirements corev1.ResourceRequirements `json:"resource_requirements,omitempty"`
+
+	// Environment variables to add to the container
+	EnvVars []corev1.EnvVar `json:"env_vars,omitempty"`
 }
 
 // PulpJob defines the jobs used by pulpcore containers to run single-shot administrative tasks

controllers/deployment.go

@@ -228,7 +228,7 @@ func (d *CommonDeployment) setEnvVars(resources any, pulpcoreType settings.Pulpc
 	pulp := resources.(FunctionResources).Pulp
 	pulpcoreTypeField := reflect.ValueOf(pulp.Spec).FieldByName(string(pulpcoreType))
 
-	var envVars []corev1.EnvVar
+	envVars := SetPulpcoreCustomEnvVars(*pulp, pulpcoreType)
 
 	if pulpcoreType != settings.WORKER {
 		// gunicornWorkers definition
@@ -237,10 +237,11 @@ func (d *CommonDeployment) setEnvVars(resources any, pulpcoreType settings.Pulpc
 		// gunicornTimeout definition
 		gunicornTimeout := strconv.FormatInt(pulpcoreTypeField.FieldByName("GunicornTimeout").Int(), 10)
 
-		envVars = []corev1.EnvVar{
+		gunicornEnvVars := []corev1.EnvVar{
 			{Name: "PULP_GUNICORN_TIMEOUT", Value: gunicornTimeout},
 			{Name: "PULP_" + strings.ToUpper(string(pulpcoreType)) + "_WORKERS", Value: gunicornWorkers},
 		}
+		envVars = append(envVars, gunicornEnvVars...)
 	}
 
 	// add postgres env vars
@@ -329,9 +330,9 @@ func (d *CommonDeployment) setEnvVars(resources any, pulpcoreType settings.Pulpc
 }
 
 // setInitContainerEnvVars defines the list of init-containers' environment variables
-func (d *CommonDeployment) setInitContainerEnvVars(resources any) {
+func (d *CommonDeployment) setInitContainerEnvVars(resources any, pulpcoreType settings.PulpcoreType) {
 	pulp := resources.(FunctionResources).Pulp
-	d.initContainerEnvVars = append([]corev1.EnvVar(nil), GetPostgresEnvVars(*pulp)...)
+	d.initContainerEnvVars = append(GetPostgresEnvVars(*pulp), SetPulpcoreCustomEnvVars(*pulp, pulpcoreType)...)
 }
 
 // GetPostgresEnvVars return the list of postgres environment variables to use in containers
@@ -1068,7 +1069,6 @@ func (d *CommonDeployment) setLDAPConfigs(resources any) {
 		ReadOnly:  true,
 	}
 	d.volumeMounts = append(d.volumeMounts, volumeMount)
-
 }
 
 // build constructs the fields used in the deployment specification
@@ -1093,7 +1093,7 @@ func (d *CommonDeployment) build(resources any, pulpcoreType settings.PulpcoreTy
 	d.setInitContainerResourceRequirements(*pulp, pulpcoreType)
 	d.setInitContainerImage(*pulp, pulpcoreType)
 	d.setInitContainerVolumeMounts(*pulp)
-	d.setInitContainerEnvVars(resources)
+	d.setInitContainerEnvVars(resources, pulpcoreType)
 	d.setLDAPConfigs(resources)
 	d.setInitContainers(resources, *pulp, pulpcoreType)
 	d.setContainers(*pulp, pulpcoreType)

controllers/repo_manager/README.md

@@ -38,6 +38,7 @@ Api defines desired state of pulpcore-api resources
 | pdb | PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods | *policy.PodDisruptionBudgetSpec | false |
 | strategy | The deployment strategy to use to replace existing pods with new ones. | appsv1.DeploymentStrategy | false |
 | init_container | InitContainer defines configuration of the init-containers that run in pulpcore pods | [PulpContainer](#pulpcontainer) | false |
+| env_vars | Environment variables to add to pulpcore-api container | []corev1.EnvVar | false |
 
 [Back to Custom Resources](#custom-resources)
 
@@ -82,6 +83,7 @@ Content defines desired state of pulpcore-content resources
 | pdb | PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods | *policy.PodDisruptionBudgetSpec | false |
 | strategy | The deployment strategy to use to replace existing pods with new ones. | appsv1.DeploymentStrategy | false |
 | init_container | InitContainer defines configuration of the init-containers that run in pulpcore pods | [PulpContainer](#pulpcontainer) | false |
+| env_vars | Environment variables to add to pulpcore-content container | []corev1.EnvVar | false |
 
 [Back to Custom Resources](#custom-resources)
 
@@ -143,6 +145,7 @@ PulpContainer defines configuration of the \"auxiliary\" containers that run in
 | ----- | ----------- | ------ | -------- |
 | image | The image name for the container. By default, if not provided, it will use the same image from .Spec.Image. WARN: defining a different image than the one used by API pods can cause unexpected behaviors! | string | false |
 | resource_requirements | Resource requirements for pulpcore aux container. | corev1.ResourceRequirements | false |
+| env_vars | Environment variables to add to the container | []corev1.EnvVar | false |
 
 [Back to Custom Resources](#custom-resources)
 
@@ -292,6 +295,7 @@ Web defines desired state of pulpcore-web (reverse-proxy) resources
 | strategy | The deployment strategy to use to replace existing pods with new ones. | appsv1.DeploymentStrategy | false |
 | service_annotations | Annotations for the service | map[string]string | false |
 | tls_termination_mechanism | The secure TLS termination mechanism to use Default: \"edge\" | string | false |
+| env_vars | Environment variables to add to pulpcore-web container | []corev1.EnvVar | false |
 
 [Back to Custom Resources](#custom-resources)
 
@@ -312,5 +316,6 @@ Worker defines desired state of pulpcore-worker resources
 | pdb | PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods | *policy.PodDisruptionBudgetSpec | false |
 | strategy | The deployment strategy to use to replace existing pods with new ones. | appsv1.DeploymentStrategy | false |
 | init_container | InitContainer defines configuration of the init-containers that run in pulpcore pods | [PulpContainer](#pulpcontainer) | false |
+| env_vars | Environment variables to add to pulpcore-worker container | []corev1.EnvVar | false |
 
 [Back to Custom Resources](#custom-resources)

controllers/repo_manager/controller_test.go

@@ -162,12 +162,15 @@ var _ = Describe("Pulp controller", Ordered, func() {
 		{Name: "POSTGRES_HOST_AUTH_METHOD", Value: "scram-sha-256"},
 	}
 
+	customEnvVar := corev1.EnvVar{Name: "TEST", Value: "test ok"}
 	envVarsInitContainer := []corev1.EnvVar{
 		{Name: "POSTGRES_SERVICE_HOST", Value: PulpName + "-database-svc"},
 		{Name: "POSTGRES_SERVICE_PORT", Value: "5432"},
+		customEnvVar,
 	}
 
 	envVarsApi := []corev1.EnvVar{
+		customEnvVar,
 		{Name: "PULP_GUNICORN_TIMEOUT", Value: strconv.Itoa(90)},
 		{Name: "PULP_API_WORKERS", Value: strconv.Itoa(2)},
 		{Name: "POSTGRES_SERVICE_HOST", Value: PulpName + "-database-svc"},
@@ -177,6 +180,7 @@ var _ = Describe("Pulp controller", Ordered, func() {
 	}
 
 	envVarsContent := []corev1.EnvVar{
+		customEnvVar,
 		{Name: "PULP_GUNICORN_TIMEOUT", Value: strconv.Itoa(90)},
 		{Name: "PULP_CONTENT_WORKERS", Value: strconv.Itoa(2)},
 		{Name: "POSTGRES_SERVICE_HOST", Value: PulpName + "-database-svc"},
@@ -186,6 +190,7 @@ var _ = Describe("Pulp controller", Ordered, func() {
 	}
 
 	envVarsWorker := []corev1.EnvVar{
+		customEnvVar,
 		{Name: "POSTGRES_SERVICE_HOST", Value: PulpName + "-database-svc"},
 		{Name: "POSTGRES_SERVICE_PORT", Value: "5432"},
 		{Name: "REDIS_SERVICE_HOST", Value: PulpName + "-redis-svc." + PulpNamespace},
@@ -820,12 +825,15 @@ var _ = Describe("Pulp controller", Ordered, func() {
 				ImageWebVersion: "latest",
 				Api: repomanagerpulpprojectorgv1beta2.Api{
 					Replicas: 1,
+					EnvVars:  []corev1.EnvVar{customEnvVar},
 				},
 				Content: repomanagerpulpprojectorgv1beta2.Content{
 					Replicas: 1,
+					EnvVars:  []corev1.EnvVar{customEnvVar},
 				},
 				Worker: repomanagerpulpprojectorgv1beta2.Worker{
 					Replicas: 1,
+					EnvVars:  []corev1.EnvVar{customEnvVar},
 				},
 				Web: repomanagerpulpprojectorgv1beta2.Web{
 					Replicas: 1,

controllers/repo_manager/job.go

@@ -155,6 +155,7 @@ func pulpcoreVolumeMounts(pulp *repomanagerpulpprojectorgv1beta2.Pulp) []corev1.
 func resetAdminPasswordContainer(pulp *repomanagerpulpprojectorgv1beta2.Pulp) corev1.Container {
 	// env vars
 	envVars := controllers.GetPostgresEnvVars(*pulp)
+	envVars = append(envVars, controllers.SetCustomEnvVars(*pulp, "AdminPasswordJob")...)
 
 	// volume mounts
 	volumeMounts := pulpcoreVolumeMounts(pulp)
@@ -230,6 +231,7 @@ func (r *RepoManagerReconciler) migrationJob(ctx context.Context, pulp *repomana
 func migrationContainer(pulp *repomanagerpulpprojectorgv1beta2.Pulp) corev1.Container {
 	// env vars
 	envVars := controllers.GetPostgresEnvVars(*pulp)
+	envVars = append(envVars, controllers.SetCustomEnvVars(*pulp, "MigrationJob")...)
 
 	// volume mounts
 	volumeMounts := pulpcoreVolumeMounts(pulp)
@@ -303,6 +305,7 @@ func (r *RepoManagerReconciler) updateContentChecksumsJob(ctx context.Context, p
 func contentChecksumsContainer(pulp *repomanagerpulpprojectorgv1beta2.Pulp) corev1.Container {
 	// env vars
 	envVars := controllers.GetPostgresEnvVars(*pulp)
+	envVars = append(envVars, controllers.SetCustomEnvVars(*pulp, string(settings.API))...)
 
 	// volume mounts
 	volumeMounts := pulpcoreVolumeMounts(pulp)
@@ -390,6 +393,7 @@ func signingScriptContainer(pulp *repomanagerpulpprojectorgv1beta2.Pulp, scripts
 
 	// env vars
 	envVars := controllers.GetPostgresEnvVars(*pulp)
+	envVars = append(envVars, controllers.SetCustomEnvVars(*pulp, "SigningJob")...)
 	envVars = append(envVars, corev1.EnvVar{Name: "PULP_SIGNING_KEY_FINGERPRINT", Value: fingerprint})
 	envVars = append(envVars, corev1.EnvVar{Name: "HOME", Value: "/var/lib/pulp"})
 
@@ -525,6 +529,10 @@ func initContainer(pulp *repomanagerpulpprojectorgv1beta2.Pulp, resources corev1
 /usr/bin/wait_on_database_migrations.sh`,
 	}
 
+	// env vars
+	envVars := controllers.GetPostgresEnvVars(*pulp)
+	envVars = append(envVars, controllers.SetCustomEnvVars(*pulp, "SigningJob")...)
+
 	volumeMounts := []corev1.VolumeMount{
 		{
 			Name:      pulp.Name + "-server",
@@ -556,7 +564,7 @@ func initContainer(pulp *repomanagerpulpprojectorgv1beta2.Pulp, resources corev1
 		Name:            "init-container",
 		Image:           image,
 		ImagePullPolicy: corev1.PullPolicy(pulp.Spec.ImagePullPolicy),
-		Env:             controllers.GetPostgresEnvVars(*pulp),
+		Env:             envVars,
 		Command:         []string{"/bin/sh"},
 		Args:            args,
 		VolumeMounts:    volumeMounts,

controllers/repo_manager/web.go

@@ -185,6 +185,18 @@ func (r *RepoManagerReconciler) deploymentForPulpWeb(m *repomanagerpulpprojector
 		nodeSelector = m.Spec.Web.NodeSelector
 	}
 
+	envVars := []corev1.EnvVar{
+		{
+			Name: "NODE_IP",
+			ValueFrom: &corev1.EnvVarSource{
+				FieldRef: &corev1.ObjectFieldSelector{
+					FieldPath: "status.hostIP",
+				},
+			},
+		},
+	}
+	envVars = append(envVars, m.Spec.Web.EnvVars...)
+
 	dep := &appsv1.Deployment{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      settings.WEB.DeploymentName(m.Name),
@@ -208,16 +220,7 @@ func (r *RepoManagerReconciler) deploymentForPulpWeb(m *repomanagerpulpprojector
 						Image:     ImageWeb,
 						Name:      "web",
 						Resources: resources,
-						Env: []corev1.EnvVar{
-							{
-								Name: "NODE_IP",
-								ValueFrom: &corev1.EnvVarSource{
-									FieldRef: &corev1.ObjectFieldSelector{
-										FieldPath: "status.hostIP",
-									},
-								},
-							},
-						},
+						Env:       envVars,
 						Ports: []corev1.ContainerPort{{
 							ContainerPort: 8080,
 							Protocol:      "TCP",