Merge pull request #24437 from lambinoo/feat-split-pod-container-start-24401

Add key to control if a container can get started by its pod

cmd/quadlet/main.go

@@ -615,9 +615,9 @@ func generateUnitsInfoMap(units []*parser.UnitFile) map[string]*quadlet.UnitInfo
 		}
 
 		unitsInfoMap[unit.Filename] = &quadlet.UnitInfo{
-			ServiceName:  serviceName,
-			Containers:   containers,
-			ResourceName: resourceName,
+			ServiceName:       serviceName,
+			ContainersToStart: containers,
+			ResourceName:      resourceName,
 		}
 	}
 

docs/source/markdown/podman-systemd.unit.5.md

@@ -333,6 +333,7 @@ Valid options for `[Container]` are listed below:
 | SecurityLabelNested=true             | --security-opt label=nested                          |
 | SecurityLabelType=spc_t              | --security-opt label=type:spc_t                      |
 | ShmSize=100m                         | --shm-size=100m                                      |
+| StartWithPod=true                    | If Pod= is defined, container is started by pod      |
 | StopSignal=SIGINT                    | --stop-signal=SIGINT                                 |
 | StopTimeout=20                       | --stop-timeout=20                                    |
 | SubGIDMap=gtest                      | --subgidname=gtest                                   |
@@ -814,6 +815,16 @@ Size of /dev/shm.
 
 This is equivalent to the Podman `--shm-size` option and generally has the form `number[unit]`
 
+### `StartWithPod=`
+
+Start the container after the associated pod is created. Default to **true**.
+
+If `true`, container will be started/stopped/restarted alongside the pod.
+
+If `false`, the container will not be started when the pod starts. The container will be stopped with the pod. Restarting the pod will also restart the container as long as the container was also running before.
+
+Note, the container can still be started manually or through a target by configuring the `[Install]` section. The pod will be started as needed in any case.
+
 ### `StopSignal=`
 
 Signal to stop a container. Default is **SIGTERM**.

pkg/systemd/quadlet/quadlet.go

@@ -154,6 +154,7 @@ const (
 	KeyServiceName           = "ServiceName"
 	KeySetWorkingDirectory   = "SetWorkingDirectory"
 	KeyShmSize               = "ShmSize"
+	KeyStartWithPod          = "StartWithPod"
 	KeyStopSignal            = "StopSignal"
 	KeyStopTimeout           = "StopTimeout"
 	KeySubGIDMap             = "SubGIDMap"
@@ -185,8 +186,8 @@ type UnitInfo struct {
 	ResourceName string
 
 	// For .pod units
-	// List of containers in a pod
-	Containers []string
+	// List of containers to start with the pod
+	ContainersToStart []string
 }
 
 var (
@@ -267,6 +268,7 @@ var (
 		KeyServiceName:           true,
 		KeyShmSize:               true,
 		KeyStopSignal:            true,
+		KeyStartWithPod:          true,
 		KeyStopTimeout:           true,
 		KeySubGIDMap:             true,
 		KeySubUIDMap:             true,
@@ -1556,7 +1558,7 @@ func ConvertPod(podUnit *parser.UnitFile, name string, unitsInfoMap map[string]*
 	// Need the containers filesystem mounted to start podman
 	service.Add(UnitGroup, "RequiresMountsFor", "%t/containers")
 
-	for _, containerService := range unitInfo.Containers {
+	for _, containerService := range unitInfo.ContainersToStart {
 		service.Add(UnitGroup, "Wants", containerService)
 		service.Add(UnitGroup, "Before", containerService)
 	}
@@ -2132,7 +2134,11 @@ func handlePod(quadletUnitFile, serviceUnitFile *parser.UnitFile, groupName stri
 		serviceUnitFile.Add(UnitGroup, "BindsTo", podServiceName)
 		serviceUnitFile.Add(UnitGroup, "After", podServiceName)
 
-		podInfo.Containers = append(podInfo.Containers, serviceUnitFile.Filename)
+		// If we want to start the container with the pod, we add it to this list.
+		// This creates corresponding Wants=/Before= statements in the pod service.
+		if quadletUnitFile.LookupBooleanWithDefault(groupName, KeyStartWithPod, true) {
+			podInfo.ContainersToStart = append(podInfo.ContainersToStart, serviceUnitFile.Filename)
+		}
 	}
 	return nil
 }

test/e2e/quadlet/startwithpod.pod

@@ -0,0 +1,7 @@
+## assert-key-contains "Unit" "Wants" "startwithpod_yes.service"
+## assert-key-contains "Unit" "Before" "startwithpod_yes.service"
+
+## assert-key-not-contains "Unit" "Wants" "startwithpod_no.service"
+## assert-key-not-contains "Unit" "Before" "startwithpod_no.service"
+
+[Pod]

test/e2e/quadlet/startwithpod_no.container

@@ -0,0 +1,7 @@
+# assert-key-contains "Unit" "After" "startwithpod-pod.service"
+# assert-key-contains "Unit" "BindsTo" "startwithpod-pod.service"
+
+[Container]
+Image=localhost/image
+Pod=startwithpod.pod
+StartWithPod=no

test/e2e/quadlet/startwithpod_yes.container

@@ -0,0 +1,7 @@
+# assert-key-contains "Unit" "After" "startwithpod-pod.service"
+# assert-key-contains "Unit" "BindsTo" "startwithpod-pod.service"
+
+[Container]
+Image=localhost/image
+Pod=startwithpod.pod
+StartWithPod=yes

test/e2e/quadlet_test.go

@@ -227,6 +227,10 @@ func (t *quadletTestcase) assertKeyContains(args []string, unit *parser.UnitFile
 	return ok && strings.Contains(realValue, value)
 }
 
+func (t *quadletTestcase) assertKeyNotContains(args []string, unit *parser.UnitFile) bool {
+	return !t.assertKeyContains(args, unit)
+}
+
 func (t *quadletTestcase) assertPodmanArgs(args []string, unit *parser.UnitFile, key string, allowRegex, globalOnly bool) bool {
 	podmanArgs, _ := unit.LookupLastArgs("Service", key)
 	if globalOnly {
@@ -516,6 +520,8 @@ func (t *quadletTestcase) doAssert(check []string, unit *parser.UnitFile, sessio
 		ok = t.assertKeyIsRegex(args, unit)
 	case "assert-key-contains":
 		ok = t.assertKeyContains(args, unit)
+	case "assert-key-not-contains":
+		ok = t.assertKeyNotContains(args, unit)
 	case "assert-last-key-is-regex":
 		ok = t.assertLastKeyIsRegex(args, unit)
 	case "assert-podman-args":
@@ -1122,6 +1128,7 @@ BOGUS=foo
 		Entry("Pod - Quadlet Volume", "volume.pod", []string{"basic.volume"}),
 		Entry("Pod - Quadlet Network overriding service name", "network.servicename.quadlet.pod", []string{"service-name.network"}),
 		Entry("Pod - Quadlet Volume overriding service name", "volume.servicename.pod", []string{"service-name.volume"}),
+		Entry("Pod - Do not autostart a container with pod", "startwithpod.pod", []string{"startwithpod_no.container", "startwithpod_yes.container"}),
 	)
 
 })