Merge pull request #18670 from ygalblum/quadlet-kube-podman-args

Quadlet - add support for PodmanArgs to all groups

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

@@ -370,8 +370,9 @@ of what unexpected interactions can be caused by these arguments, is not recomme
 this option.
 
 The format of this is a space separated list of arguments, which can optionally be individually
-escaped to allow inclusion of whitespace and other control characters. This key can be listed
-multiple times.
+escaped to allow inclusion of whitespace and other control characters.
+
+This key can be listed multiple times.
 
 ### `PublishPort=`
 
@@ -480,14 +481,15 @@ There is only one required key, `Yaml`, which defines the path to the Kubernetes
 
 Valid options for `[Kube]` are listed below:
 
-| **[Kube] options**               | **podman kube play equivalent**        |
-| -----------------                | ------------------                     |
-| ConfigMap=/tmp/config.map        | --config-map /tmp/config.map           |
-| LogDriver=journald               | --log-driver journald                  |
-| Network=host                     | --net host                             |
-| PublishPort=59-60                | --publish=59-60                        |
-| UserNS=keep-id:uid=200,gid=210   | --userns keep-id:uid=200,gid=210       |
-| Yaml=/tmp/kube.yaml              | podman kube play /tmp/kube.yaml        |
+| **[Kube] options**                | **podman kube play equivalent**        |
+| -----------------                 | ------------------                     |
+| ConfigMap=/tmp/config.map         | --config-map /tmp/config.map           |
+| LogDriver=journald                | --log-driver journald                  |
+| Network=host                      | --net host                             |
+| PodmanArgs=--annotation=key=value | --annotation=key=value                 |
+| PublishPort=59-60                 | --publish=59-60                        |
+| UserNS=keep-id:uid=200,gid=210    | --userns keep-id:uid=200,gid=210       |
+| Yaml=/tmp/kube.yaml               | podman kube play /tmp/kube.yaml        |
 
 Supported keys in the `[Kube]` section are:
 
@@ -517,6 +519,19 @@ created by using a `$name.network` Quadlet file.
 
 This key can be listed multiple times.
 
+### `PodmanArgs=`
+
+This key contains a list of arguments passed directly to the end of the `podman kube play` command
+in the generated file (right before the path to the yaml file in the command line). It can be used to
+access Podman features otherwise unsupported by the generator. Since the generator is unaware
+of what unexpected interactions can be caused by these arguments, is not recommended to use
+this option.
+
+The format of this is a space separated list of arguments, which can optionally be individually
+escaped to allow inclusion of whitespace and other control characters.
+
+This key can be listed multiple times.
+
 ### `PublishPort=`
 
 Exposes a port, or a range of ports (e.g. `50-59`), from the container to the host. Equivalent
@@ -568,6 +583,7 @@ Valid options for `[Network]` are listed below:
 | IPv6=true                        | --ipv6                                 |
 | Label="YXZ"                      | --label "XYZ"                          |
 | Options=isolate                  | --opt isolate                          |
+| PodmanArgs=--dns=192.168.55.1    | --dns=192.168.55.1                     |
 | Subnet=192.5.0.0/16              | --subnet 192.5.0.0/16                  |
 
 Supported keys in `[Network]` section are:
@@ -631,6 +647,19 @@ Set driver specific options.
 
 This is equivalent to the Podman `--opt` option
 
+### `PodmanArgs=`
+
+This key contains a list of arguments passed directly to the end of the `podman network create` command
+in the generated file (right before the name of the network in the command line). It can be used to
+access Podman features otherwise unsupported by the generator. Since the generator is unaware
+of what unexpected interactions can be caused by these arguments, is not recommended to use
+this option.
+
+The format of this is a space separated list of arguments, which can optionally be individually
+escaped to allow inclusion of whitespace and other control characters.
+
+This key can be listed multiple times.
+
 ### `Subnet=`
 
 The subnet in CIDR notation.
@@ -661,6 +690,7 @@ Valid options for `[Volume]` are listed below:
 | Group=192                        | --opt group=192                       |
 | Label="foo=bar"                  | --label "foo=bar"                     |
 | Options=XYZ                      | --opt XYZ                             |
+| PodmanArgs=--driver=image        | --driver=image                        |
 
 Supported keys in `[Volume]` section are:
 
@@ -688,6 +718,19 @@ This key can be listed multiple times.
 
 The mount options to use for a filesystem as used by the **mount(8)** command `-o` option.
 
+### `PodmanArgs=`
+
+This key contains a list of arguments passed directly to the end of the `podman volume create` command
+in the generated file (right before the name of the network in the command line). It can be used to
+access Podman features otherwise unsupported by the generator. Since the generator is unaware
+of what unexpected interactions can be caused by these arguments, is not recommended to use
+this option.
+
+The format of this is a space separated list of arguments, which can optionally be individually
+escaped to allow inclusion of whitespace and other control characters.
+
+This key can be listed multiple times.
+
 ### `Type=`
 
 The filesystem type of `Device` as used by the **mount(8)** commands `-t` option.

pkg/systemd/quadlet/quadlet.go

@@ -165,13 +165,14 @@ var (
 
 	// Supported keys in "Volume" group
 	supportedVolumeKeys = map[string]bool{
-		KeyCopy:    true,
-		KeyDevice:  true,
-		KeyGroup:   true,
-		KeyLabel:   true,
-		KeyOptions: true,
-		KeyType:    true,
-		KeyUser:    true,
+		KeyCopy:       true,
+		KeyDevice:     true,
+		KeyGroup:      true,
+		KeyLabel:      true,
+		KeyOptions:    true,
+		KeyPodmanArgs: true,
+		KeyType:       true,
+		KeyUser:       true,
 	}
 
 	// Supported keys in "Network" group
@@ -186,13 +187,15 @@ var (
 		KeyNetworkInternal:   true,
 		KeyNetworkOptions:    true,
 		KeyNetworkSubnet:     true,
+		KeyPodmanArgs:        true,
 	}
 
 	// Supported keys in "Kube" group
 	supportedKubeKeys = map[string]bool{
 		KeyConfigMap:    true,
 		KeyLogDriver:    true,
 		KeyNetwork:      true,
+		KeyPodmanArgs:   true,
 		KeyPublishPort:  true,
 		KeyRemapGID:     true,
 		KeyRemapUID:     true,
@@ -620,8 +623,7 @@ func ConvertContainer(container *parser.UnitFile, isUser bool) (*parser.UnitFile
 		podman.add("--hostname", hostname)
 	}
 
-	podmanArgs := container.LookupAllArgs(ContainerGroup, KeyPodmanArgs)
-	podman.add(podmanArgs...)
+	handlePodmanArgs(container, ContainerGroup, podman)
 
 	if len(image) > 0 {
 		podman.add(image)
@@ -714,6 +716,8 @@ func ConvertNetwork(network *parser.UnitFile, name string) (*parser.UnitFile, er
 		podman.addLabels(labels)
 	}
 
+	handlePodmanArgs(network, NetworkGroup, podman)
+
 	podman.add(networkName)
 
 	service.AddCmdline(ServiceGroup, "ExecStart", podman.Args)
@@ -814,6 +818,9 @@ func ConvertVolume(volume *parser.UnitFile, name string) (*parser.UnitFile, erro
 	}
 
 	podman.addLabels(labels)
+
+	handlePodmanArgs(volume, VolumeGroup, podman)
+
 	podman.add(volumeName)
 
 	service.AddCmdline(ServiceGroup, "ExecStart", podman.Args)
@@ -911,6 +918,8 @@ func ConvertKube(kube *parser.UnitFile, isUser bool) (*parser.UnitFile, error) {
 		return nil, err
 	}
 
+	handlePodmanArgs(kube, KubeGroup, execStart)
+
 	execStart.add(yamlPath)
 
 	service.AddCmdline(ServiceGroup, "ExecStart", execStart.Args)
@@ -1175,3 +1184,10 @@ func handleHealth(unitFile *parser.UnitFile, groupName string, podman *PodmanCmd
 		}
 	}
 }
+
+func handlePodmanArgs(unitFile *parser.UnitFile, groupName string, podman *PodmanCmdline) {
+	podmanArgs := unitFile.LookupAllArgs(groupName, KeyPodmanArgs)
+	if len(podmanArgs) > 0 {
+		podman.add(podmanArgs...)
+	}
+}

test/e2e/quadlet/podmanargs.container

@@ -1,9 +1,14 @@
 ## assert-podman-args "--foo"
 ## assert-podman-args "--bar"
 ## assert-podman-args "--also"
+## assert-podman-args "--with-key=value"
+## assert-podman-args "--with-space" "yes"
+
 
 [Container]
 Image=localhost/imagename
 PodmanArgs="--foo" \
   --bar
 PodmanArgs=--also
+PodmanArgs=--with-key=value
+PodmanArgs=--with-space yes

test/e2e/quadlet/podmanargs.kube

@@ -0,0 +1,14 @@
+## assert-podman-args "--foo"
+## assert-podman-args "--bar"
+## assert-podman-args "--also"
+## assert-podman-args "--with-key=value"
+## assert-podman-args "--with-space" "yes"
+
+
+[Kube]
+Yaml=kube.yaml
+PodmanArgs="--foo" \
+  --bar
+PodmanArgs=--also
+PodmanArgs=--with-key=value
+PodmanArgs=--with-space yes

test/e2e/quadlet/podmanargs.network

@@ -0,0 +1,13 @@
+## assert-podman-args "--foo"
+## assert-podman-args "--bar"
+## assert-podman-args "--also"
+## assert-podman-args "--with-key=value"
+## assert-podman-args "--with-space" "yes"
+
+
+[Network]
+PodmanArgs="--foo" \
+  --bar
+PodmanArgs=--also
+PodmanArgs=--with-key=value
+PodmanArgs=--with-space yes

test/e2e/quadlet/podmanargs.volume

@@ -0,0 +1,13 @@
+## assert-podman-args "--foo"
+## assert-podman-args "--bar"
+## assert-podman-args "--also"
+## assert-podman-args "--with-key=value"
+## assert-podman-args "--with-space" "yes"
+
+
+[Volume]
+PodmanArgs="--foo" \
+  --bar
+PodmanArgs=--also
+PodmanArgs=--with-key=value
+PodmanArgs=--with-space yes

test/e2e/quadlet_test.go

@@ -565,6 +565,7 @@ var _ = Describe("quadlet system generator", func() {
 		Entry("uid.volume", "uid.volume"),
 		Entry("device-copy.volume", "device-copy.volume"),
 		Entry("device.volume", "device.volume"),
+		Entry("podmanargs.volume", "podmanargs.volume"),
 
 		Entry("Basic kube", "basic.kube"),
 		Entry("Syslog Identifier", "syslog.identifier.kube"),
@@ -578,6 +579,7 @@ var _ = Describe("quadlet system generator", func() {
 		Entry("Kube - Publish IPv4 ports", "ports.kube"),
 		Entry("Kube - Publish IPv6 ports", "ports_ipv6.kube"),
 		Entry("Kube - Logdriver", "logdriver.kube"),
+		Entry("Kube - PodmanArgs", "podmanargs.kube"),
 
 		Entry("Network - Basic", "basic.network"),
 		Entry("Network - Label", "label.network"),
@@ -597,6 +599,7 @@ var _ = Describe("quadlet system generator", func() {
 		Entry("Network - IPv6", "ipv6.network"),
 		Entry("Network - Options", "options.network"),
 		Entry("Network - Multiple Options", "options.multiple.network"),
+		Entry("Network - PodmanArgs", "podmanargs.network"),
 	)
 
 })