Merge pull request #23135 from breca/main

feat(quadlet): log option handling

Author: openshift-merge-bot[bot]

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

@@ -278,6 +278,7 @@ Valid options for `[Container]` are listed below:
 | IP6=2001:db8::1                      | --ip6 2001:db8::1                                    |
 | Label="XYZ"                          | --label "XYZ"                                        |
 | LogDriver=journald                   | --log-driver journald                                |
+| LogOpt=path=/var/log/mykube\.json    | --log-opt path=/var/log/mykube\.json                 |
 | Mask=/proc/sys/foo\:/proc/sys/bar    | --security-opt mask=/proc/sys/foo:/proc/sys/bar      |
 | Mount=type=...                       | --mount type=...                                     |
 | Network=host                         | --net host                                           |
@@ -557,6 +558,12 @@ This key can be listed multiple times.
 Set the log-driver used by Podman when running the container.
 Equivalent to the Podman `--log-driver` option.
 
+### `LogOpt=`
+
+Set the log-opt (logging options) used by Podman when running the container.
+Equivalent to the Podman `--log-opt` option.
+This key can be listed multiple times.
+
 ### `Mask=`
 
 Specify the paths to mask separated by a colon. `Mask=/path/1:/path/2`. A masked path cannot be accessed inside the container.

pkg/systemd/quadlet/quadlet.go

@@ -110,6 +110,7 @@ const (
 	KeyKubeDownForce         = "KubeDownForce"
 	KeyLabel                 = "Label"
 	KeyLogDriver             = "LogDriver"
+	KeyLogOpt                = "LogOpt"
 	KeyMask                  = "Mask"
 	KeyMount                 = "Mount"
 	KeyNetwork               = "Network"
@@ -212,6 +213,7 @@ var (
 		KeyImage:                 true,
 		KeyLabel:                 true,
 		KeyLogDriver:             true,
+		KeyLogOpt:                true,
 		KeyMask:                  true,
 		KeyMount:                 true,
 		KeyNetwork:               true,
@@ -299,6 +301,7 @@ var (
 		KeyGlobalArgs:           true,
 		KeyKubeDownForce:        true,
 		KeyLogDriver:            true,
+		KeyLogOpt:               true,
 		KeyNetwork:              true,
 		KeyPodmanArgs:           true,
 		KeyPublishPort:          true,
@@ -544,6 +547,7 @@ func ConvertContainer(container *parser.UnitFile, names map[string]string, isUse
 	)
 
 	handleLogDriver(container, ContainerGroup, podman)
+	handleLogOpt(container, ContainerGroup, podman)
 
 	// We delegate groups to the runtime
 	service.Add(ServiceGroup, "Delegate", "yes")
@@ -1164,6 +1168,7 @@ func ConvertKube(kube *parser.UnitFile, names map[string]string, isUser bool) (*
 	}
 
 	handleLogDriver(kube, KubeGroup, execStart)
+	handleLogOpt(kube, KubeGroup, execStart)
 
 	if err := handleUserMappings(kube, KubeGroup, execStart, isUser, false); err != nil {
 		return nil, err
@@ -1813,6 +1818,13 @@ func handleLogDriver(unitFile *parser.UnitFile, groupName string, podman *Podman
 	}
 }
 
+func handleLogOpt(unitFile *parser.UnitFile, groupName string, podman *PodmanCmdline) {
+	logOpts := unitFile.LookupAllStrv(groupName, KeyLogOpt)
+	for _, logOpt := range logOpts {
+		podman.add("--log-opt", logOpt)
+	}
+}
+
 func handleStorageSource(quadletUnitFile, serviceUnitFile *parser.UnitFile, source string, names map[string]string) (string, error) {
 	if source[0] == '.' {
 		var err error

test/e2e/quadlet/logopt.container

@@ -0,0 +1,9 @@
+## assert-podman-args "--log-opt" "path=/var/log/some-logs.json"
+## assert-podman-args "--log-opt" "size=10mb"
+## assert-podman-args "--log-opt" "tag="{{.ImageName}}""
+
+[Container]
+Image=localhost/imagename
+LogOpt=path=/var/log/some-logs.json
+LogOpt=size=10mb
+LogOpt=tag="{{.ImageName}}"

test/e2e/quadlet/logopt.kube

@@ -0,0 +1,9 @@
+## assert-podman-args "--log-opt" "path=/var/log/some-logs.json"
+## assert-podman-args "--log-opt" "size=10mb"
+## assert-podman-args "--log-opt" "tag="{{.ImageName}}""
+
+[Kube]
+Yaml=deployment.yml
+LogOpt=path=/var/log/some-logs.json
+LogOpt=size=10mb
+LogOpt=tag="{{.ImageName}}"

test/e2e/quadlet_test.go

@@ -818,6 +818,7 @@ BOGUS=foo
 		Entry("label.container", "label.container", 0, ""),
 		Entry("line-continuation-whitespace.container", "line-continuation-whitespace.container", 0, ""),
 		Entry("logdriver.container", "logdriver.container", 0, ""),
+		Entry("logopt.container", "logopt.container", 0, ""),
 		Entry("mask.container", "mask.container", 0, ""),
 		Entry("mount.container", "mount.container", 0, ""),
 		Entry("name.container", "name.container", 0, ""),
@@ -892,6 +893,7 @@ BOGUS=foo
 		Entry("Kube - ConfigMap", "configmap.kube", 0, ""),
 		Entry("Kube - Exit Code Propagation", "exit_code_propagation.kube", 0, ""),
 		Entry("Kube - Logdriver", "logdriver.kube", 0, ""),
+		Entry("Kube - Logopt", "logopt.kube", 0, ""),
 		Entry("Kube - Network", "network.kube", 0, ""),
 		Entry("Kube - PodmanArgs", "podmanargs.kube", 0, ""),
 		Entry("Kube - Publish IPv4 ports", "ports.kube", 0, ""),