Expose placement-api logs as the pod logs

mrkisaolamb · openshift-merge-bot[bot] · commit ed3136b34441 · 2023-12-18T15:59:41.000Z
diff --git a/api/bases/placement.openstack.org_placementapis.yaml b/api/bases/placement.openstack.org_placementapis.yaml
@@ -88,9 +88,9 @@ spec:
                 additionalProperties:
                   type: string
                 description: 'ConfigOverwrite - interface to overwrite default config
-                  files like e.g. logging.conf or policy.json. But can also be used
-                  to add additional files. Those get added to the service config dir
-                  in /etc/<service> . TODO: -> implement'
+                  files like e.g. policy.json. But can also be used to add additional
+                  files. Those get added to the service config dir in /etc/<service>
+                  . TODO: -> implement'
                 type: object
               networkAttachments:
                 description: NetworkAttachments is a list of NetworkAttachment resource
diff --git a/api/v1beta1/placementapi_types.go b/api/v1beta1/placementapi_types.go
@@ -98,7 +98,7 @@ type PlacementAPISpec struct {
 	CustomServiceConfig string `json:"customServiceConfig"`
 
 	// +kubebuilder:validation:Optional
-	// ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json.
+	// ConfigOverwrite - interface to overwrite default config files like e.g. policy.json.
 	// But can also be used to add additional files. Those get added to the service config dir in /etc/<service> .
 	// TODO: -> implement
 	DefaultConfigOverwrite map[string]string `json:"defaultConfigOverwrite,omitempty"`
diff --git a/config/crd/bases/placement.openstack.org_placementapis.yaml b/config/crd/bases/placement.openstack.org_placementapis.yaml
@@ -88,9 +88,9 @@ spec:
                 additionalProperties:
                   type: string
                 description: 'ConfigOverwrite - interface to overwrite default config
-                  files like e.g. logging.conf or policy.json. But can also be used
-                  to add additional files. Those get added to the service config dir
-                  in /etc/<service> . TODO: -> implement'
+                  files like e.g. policy.json. But can also be used to add additional
+                  files. Those get added to the service config dir in /etc/<service>
+                  . TODO: -> implement'
                 type: object
               networkAttachments:
                 description: NetworkAttachments is a list of NetworkAttachment resource
diff --git a/controllers/placementapi_controller.go b/controllers/placementapi_controller.go
@@ -792,7 +792,7 @@ func (r *PlacementAPIReconciler) generateServiceConfigMaps(
 
 	// customData hold any customization for the service.
 	// custom.conf is going to /etc/<service>/<service>.conf.d
-	// all other files get placed into /etc/<service> to allow overwrite of e.g. logging.conf or policy.json
+	// all other files get placed into /etc/<service> to allow overwrite of e.g. policy.json
 	// TODO: make sure custom.conf can not be overwritten
 	customData := map[string]string{common.CustomServiceConfigFileName: instance.Spec.CustomServiceConfig}
 	for key, data := range instance.Spec.DefaultConfigOverwrite {
@@ -811,10 +811,12 @@ func (r *PlacementAPIReconciler) generateServiceConfigMaps(
 	if err != nil {
 		return err
 	}
-	templateParameters := make(map[string]interface{})
-	templateParameters["ServiceUser"] = instance.Spec.ServiceUser
-	templateParameters["KeystoneInternalURL"] = keystoneInternalURL
-	templateParameters["KeystonePublicURL"] = keystonePublicURL
+	templateParameters := map[string]interface{}{
+		"ServiceUser":         instance.Spec.ServiceUser,
+		"KeystoneInternalURL": keystoneInternalURL,
+		"KeystonePublicURL":   keystonePublicURL,
+		"log_file":            "/var/log/placement/placement-api.log",
+	}
 
 	cms := []util.Template{
 		// ScriptsConfigMap
diff --git a/pkg/placement/deployment.go b/pkg/placement/deployment.go
@@ -98,6 +98,29 @@ func Deployment(
 				Spec: corev1.PodSpec{
 					ServiceAccountName: instance.RbacResourceName(),
 					Containers: []corev1.Container{
+						{
+							Name: ServiceName + "-log",
+							Command: []string{
+								"/usr/bin/dumb-init",
+							},
+							Args: []string{
+								"--single-child",
+								"--",
+								"/usr/bin/tail",
+								"-n+1",
+								"-F",
+								"/var/log/placement/placement-api.log",
+							},
+							Image: instance.Spec.ContainerImage,
+							SecurityContext: &corev1.SecurityContext{
+								RunAsUser: ptr.To(PlacementUserID),
+							},
+							Env:            env.MergeEnvs([]corev1.EnvVar{}, envVars),
+							VolumeMounts:   getVolumeMounts("api"),
+							Resources:      instance.Spec.Resources,
+							ReadinessProbe: readinessProbe,
+							LivenessProbe:  livenessProbe,
+						},
 						{
 							Name: ServiceName + "-api",
 							Command: []string{
diff --git a/pkg/placement/volumes.go b/pkg/placement/volumes.go
@@ -53,6 +53,12 @@ func getVolumes(name string) []corev1.Volume {
 				EmptyDir: &corev1.EmptyDirVolumeSource{Medium: ""},
 			},
 		},
+		{
+			Name: "logs",
+			VolumeSource: corev1.VolumeSource{
+				EmptyDir: &corev1.EmptyDirVolumeSource{Medium: ""},
+			},
+		},
 	}
 
 }
@@ -75,6 +81,11 @@ func getInitVolumeMounts() []corev1.VolumeMount {
 			MountPath: "/var/lib/config-data/merged",
 			ReadOnly:  false,
 		},
+		{
+			Name:      "logs",
+			MountPath: "/var/log/placement",
+			ReadOnly:  false,
+		},
 	}
 }
 
@@ -97,5 +108,10 @@ func getVolumeMounts(serviceName string) []corev1.VolumeMount {
 			SubPath:   "placement-" + serviceName + "-config.json",
 			ReadOnly:  true,
 		},
+		{
+			Name:      "logs",
+			MountPath: "/var/log/placement",
+			ReadOnly:  false,
+		},
 	}
 }
diff --git a/templates/placementapi/config/logging.conf b/templates/placementapi/config/logging.conf
diff --git a/templates/placementapi/config/placement-api-config.json b/templates/placementapi/config/placement-api-config.json
@@ -18,12 +18,6 @@
             "dest": "/etc/httpd/conf/httpd.conf",
             "owner": "apache",
             "perm": "0644"
-        },
-        {
-            "source": "/var/lib/config-data/merged/logging.conf",
-            "dest": "/etc/placement/logging.conf",
-            "owner": "placement",
-            "perm": "0600"
         }
     ],
     "permissions": [
diff --git a/templates/placementapi/config/placement.conf b/templates/placementapi/config/placement.conf
@@ -1,5 +1,12 @@
 [DEFAULT]
-log_config_append = /etc/placement/logging.conf
+# enable log rotation in oslo config by default
+max_logfile_count=5
+max_logfile_size_mb=50
+log_rotation_type=size
+{{if (index . "log_file") }}
+log_file = {{ .log_file }}
+{{end}}
+debug = true
 
 [api]
 auth_strategy = keystone
diff --git a/tests/functional/placementapi_controller_test.go b/tests/functional/placementapi_controller_test.go
@@ -326,12 +326,12 @@ var _ = Describe("PlacementAPI controller", func() {
 			)
 
 			job := th.GetJob(names.DBSyncJobName)
-			Expect(job.Spec.Template.Spec.Volumes).To(HaveLen(3))
+			Expect(job.Spec.Template.Spec.Volumes).To(HaveLen(4))
 			Expect(job.Spec.Template.Spec.InitContainers).To(HaveLen(1))
 			Expect(job.Spec.Template.Spec.Containers).To(HaveLen(1))
 
 			init := job.Spec.Template.Spec.InitContainers[0]
-			Expect(init.VolumeMounts).To(HaveLen(3))
+			Expect(init.VolumeMounts).To(HaveLen(4))
 			Expect(init.Args[1]).To(ContainSubstring("init.sh"))
 			Expect(init.Image).To(Equal("quay.io/podified-antelope-centos9/openstack-placement-api:current-podified"))
 			env := &corev1.EnvVar{}
@@ -349,7 +349,7 @@ var _ = Describe("PlacementAPI controller", func() {
 			Expect(env.ValueFrom.SecretKeyRef.Key).To(Equal("PlacementPassword"))
 
 			container := job.Spec.Template.Spec.Containers[0]
-			Expect(container.VolumeMounts).To(HaveLen(3))
+			Expect(container.VolumeMounts).To(HaveLen(4))
 			Expect(container.Image).To(Equal("quay.io/podified-antelope-centos9/openstack-placement-api:current-podified"))
 
 			th.SimulateJobSuccess(names.DBSyncJobName)
@@ -381,6 +381,8 @@ var _ = Describe("PlacementAPI controller", func() {
 			Expect(int(*deployment.Spec.Replicas)).To(Equal(1))
 			Expect(deployment.Spec.Selector.MatchLabels).To(Equal(map[string]string{"service": "placement"}))
 			Expect(deployment.Spec.Template.Spec.ServiceAccountName).To(Equal(names.ServiceAccountName.Name))
+			Expect(len(deployment.Spec.Template.Spec.Containers)).To(Equal(2))
+
 			th.SimulateDeploymentReplicaReady(names.DeploymentName)
 
 			th.ExpectCondition(
diff --git a/tests/kuttl/common/assert_sample_deployment.yaml b/tests/kuttl/common/assert_sample_deployment.yaml
@@ -101,6 +101,54 @@ spec:
               topologyKey: kubernetes.io/hostname
             weight: 1
       containers:
+      - args:
+        - --single-child
+        - --
+        - /usr/bin/tail
+        - -n+1
+        - -F
+        - /var/log/placement/placement-api.log
+        command:
+        - /usr/bin/dumb-init
+        imagePullPolicy: IfNotPresent
+        livenessProbe:
+          failureThreshold: 3
+          httpGet:
+            path: /
+            port: 8778
+            scheme: HTTP
+          initialDelaySeconds: 3
+          periodSeconds: 3
+          successThreshold: 1
+          timeoutSeconds: 5
+        name: placement-log
+        readinessProbe:
+          failureThreshold: 3
+          httpGet:
+            path: /
+            port: 8778
+            scheme: HTTP
+          initialDelaySeconds: 5
+          periodSeconds: 5
+          successThreshold: 1
+          timeoutSeconds: 5
+        resources: {}
+        securityContext:
+          runAsUser: 42482
+        terminationMessagePath: /dev/termination-log
+        terminationMessagePolicy: File
+        volumeMounts:
+        - mountPath: /usr/local/bin/container-scripts
+          name: scripts
+          readOnly: true
+        - mountPath: /var/lib/config-data/merged
+          name: config-data-merged
+        - mountPath: /var/lib/kolla/config_files/config.json
+          name: config-data-merged
+          readOnly: true
+          subPath: placement-api-config.json
+        - mountPath: /var/log/placement
+          name: logs
       - args:
         - -c
         - /usr/local/bin/kolla_start

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,12 @@ func getVolumes(name string) []corev1.Volume {`
`53`	`53`	`EmptyDir: &corev1.EmptyDirVolumeSource{Medium: ""},`
`54`	`54`	`},`
`55`	`55`	`},`
	`56`	`+ {`
	`57`	`+ Name: "logs",`
	`58`	`+ VolumeSource: corev1.VolumeSource{`
	`59`	`+ EmptyDir: &corev1.EmptyDirVolumeSource{Medium: ""},`
	`60`	`+ },`
	`61`	`+ },`
`56`	`62`	`}`
`57`	`63`
`58`	`64`	`}`
`@@ -75,6 +81,11 @@ func getInitVolumeMounts() []corev1.VolumeMount {`
`75`	`81`	`MountPath: "/var/lib/config-data/merged",`
`76`	`82`	`ReadOnly: false,`
`77`	`83`	`},`
	`84`	`+ {`
	`85`	`+ Name: "logs",`
	`86`	`+ MountPath: "/var/log/placement",`
	`87`	`+ ReadOnly: false,`
	`88`	`+ },`
`78`	`89`	`}`
`79`	`90`	`}`
`80`	`91`
`@@ -97,5 +108,10 @@ func getVolumeMounts(serviceName string) []corev1.VolumeMount {`
`97`	`108`	`SubPath: "placement-" + serviceName + "-config.json",`
`98`	`109`	`ReadOnly: true,`
`99`	`110`	`},`
	`111`	`+ {`
	`112`	`+ Name: "logs",`
	`113`	`+ MountPath: "/var/log/placement",`
	`114`	`+ ReadOnly: false,`
	`115`	`+ },`
`100`	`116`	`}`
`101`	`117`	`}`