Skip to content

Add dumb-init to service containers #785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-bot merged 1 commit into from
Nov 6, 2026
+48 −4
Merged

Add dumb-init to service containers #785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion internal/heatapi/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,14 @@ func Deployment(
{
Name: heat.ServiceName + "-" + heat.APIComponent,
Command: []string{
"/usr/bin/dumb-init",

@rabi rabi Nov 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have that in base image right? https://github.com/openstack-k8s-operators/s2i-openstack-containers/blob/main/containers/base/Containerfile#L131

@amartyasinha amartyasinha Nov 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When Command (which correspond to container's ENTRYPOINT) and Args (correspond to container's CMD) are set, both ENTRYPOINT and CMD are overriden.
See: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#:~:text=The%20command%20and%20arguments%20that%20you%20define%20in%20the%20configuration%20file%20override%20the%20default%20command%20and%20arguments%20provided%20by%20the%20container%20image.%20If%20you%20define%20args%2C%20but%20do%20not%20define%20a%20command%2C%20the%20default%20command%20is%20used%20with%20your%20new%20arguments. and the note just below the highlight.

Due to this behavior, it is overridden here.

@rabi rabi Nov 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I understand we don't need Command here. Setting only Args: ["/usr/sbin/httpd", "-DFOREGROUND"] keeps the image ENTRYPOINT and replaces CMD.

@amartyasinha amartyasinha Nov 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that’s true. We set both Command and Args so the pod spec shows the full process invocation without needing to check the Containerfile.

The behavior should be the same either way. If you want to drop the Command part, I can do that.

@rabi rabi Nov 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's duplication and something that does not have to repeated in all services as base image has it. But I see it's repeated in every operator, so we can leave it here too. Is there a jira reference you can add to the PR?

@amartyasinha amartyasinha Nov 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ack! updated the jira ref in the description

},
Args: []string{
"--single-child",
"--",
"/usr/sbin/httpd",
"-DFOREGROUND",
},
Args: []string{"-DFOREGROUND"},
Image: instance.Spec.ContainerImage,
SecurityContext: pod.RestrictiveSecurityContext(users.HeatUID, users.HeatGID),
Env: env.MergeEnvs([]corev1.EnvVar{}, envVars),
Expand Down
7 changes: 6 additions & 1 deletion internal/heatcfnapi/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,14 @@ func Deployment(
{
Name: heat.ServiceName + "-" + heat.CfnAPIComponent,
Command: []string{
"/usr/bin/dumb-init",
},
Args: []string{
"--single-child",
"--",
"/usr/sbin/httpd",
"-DFOREGROUND",
},
Args: []string{"-DFOREGROUND"},
Image: instance.Spec.ContainerImage,
SecurityContext: pod.RestrictiveSecurityContext(users.HeatUID, users.HeatGID),
Env: env.MergeEnvs([]corev1.EnvVar{}, envVars),
Expand Down
5 changes: 5 additions & 0 deletions internal/heatengine/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,11 @@ func Deployment(instance *heatv1beta1.HeatEngine, configHash string, labels map[
{
Name: fmt.Sprintf("%s-%s", heat.ServiceName, heat.EngineComponent),
Command: []string{
"/usr/bin/dumb-init",
},
Args: []string{
"--single-child",
"--",
"/usr/bin/heat-engine",
"--config-dir", "/etc/heat/heat.conf.d",
},
Expand Down
19 changes: 19 additions & 0 deletions test/functional/heat_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1502,6 +1502,25 @@ var _ = Describe("Heat controller", func() {
th.SimulateJobSuccess(heatDbSyncName)
})

It("should wrap all service commands with dumb-init", func() {
for _, service := range []struct {
name string
args []string
}{
{"heat-api", []string{"--single-child", "--", "/usr/sbin/httpd", "-DFOREGROUND"}},
{"heat-cfnapi", []string{"--single-child", "--", "/usr/sbin/httpd", "-DFOREGROUND"}},
{"heat-engine", []string{"--single-child", "--", "/usr/bin/heat-engine", "--config-dir", "/etc/heat/heat.conf.d"}},
} {
Eventually(func(g Gomega) {
deployment := th.GetDeployment(types.NamespacedName{Namespace: namespace, Name: service.name})
g.Expect(deployment.Spec.Template.Spec.Containers).NotTo(BeEmpty())
container := deployment.Spec.Template.Spec.Containers[0]
g.Expect(container.Command).To(Equal([]string{"/usr/bin/dumb-init"}))
g.Expect(container.Args).To(Equal(service.args))
}, timeout, interval).Should(Succeed(), service.name)
}
})

It("should add the consumer finalizer to the transport secret", func() {
Eventually(func(g Gomega) {
secret := th.GetSecret(types.NamespacedName{
Expand Down
14 changes: 12 additions & 2 deletions test/kuttl/tests/heat_tls/01-assert.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,11 @@ spec:
spec:
containers:
- command:
- /usr/sbin/httpd
- /usr/bin/dumb-init
args:
- --single-child
- --
- /usr/sbin/httpd
- -DFOREGROUND
volumeMounts:
- mountPath: /etc/heat/heat.conf.d
Expand Down Expand Up @@ -166,8 +169,11 @@ spec:
spec:
containers:
- command:
- /usr/sbin/httpd
- /usr/bin/dumb-init
args:
- --single-child
- --
- /usr/sbin/httpd
- -DFOREGROUND
volumeMounts:
- mountPath: /etc/heat/heat.conf.d
Expand Down Expand Up @@ -245,6 +251,10 @@ spec:
spec:
containers:
- command:
- /usr/bin/dumb-init
args:
- --single-child
- --
- /usr/bin/heat-engine
- --config-dir
- /etc/heat/heat.conf.d
Expand Down
Loading