Fix #27015. Document ServiceName

eulores · web-flow · commit 7fcd30de6a69 · 2025-09-08T22:15:29.000+02:00
diff --git a/docs/source/markdown/podman-build.unit.5.md.in b/docs/source/markdown/podman-build.unit.5.md.in
@@ -68,6 +68,7 @@ Valid options for `[Build]` section are listed below:
 | Retry=5                             | --retry=5                                   |
 | RetryDelay=10s                      | --retry-delay=10s                           |
 | Secret=secret                       | --secret=id=mysecret,src=path               |
+| ServiceName=name                    | Name the systemd unit `name.service`        |
 | SetWorkingDirectory=unit            | Set `WorkingDirectory` of systemd unit file |
 | Target=my-app                       | --target=my-app                             |
 | TLSVerify=false                     | --tls-verify=false                          |
@@ -114,6 +115,13 @@ Valid options for `[Build]` section are listed below:
 
 @@option quadlet:secret.image
 
+### `ServiceName=name`
+
+By default, Quadlet will name the systemd service unit by appending `-build` to the name of the Quadlet.
+Setting this key overrides this behavior by instructing Quadlet to use the provided name.
+
+Note, the name should not include the `.service` file extension
+
 ### `SetWorkingDirectory=path`
 
 Provide context (a working directory) to `podman build`. Supported values are a path, a URL, or the
diff --git a/docs/source/markdown/podman-container.unit.5.md.in b/docs/source/markdown/podman-container.unit.5.md.in
@@ -110,6 +110,7 @@ Valid options for `[Container]` are listed below:
 | SecurityLabelLevel=s0:c1,c2          | --security-opt label=level:s0:c1,c2                  |
 | SecurityLabelNested=true             | --security-opt label=nested                          |
 | SecurityLabelType=spc_t              | --security-opt label=type:spc_t                      |
+| ServiceName=name                     | Name the systemd unit `name.service`                 |
 | ShmSize=100m                         | --shm-size=100m                                      |
 | StartWithPod=true                    | If Pod= is defined, container is started by pod      |
 | StopSignal=SIGINT                    | --stop-signal=SIGINT                                 |
@@ -336,6 +337,13 @@ Allow SecurityLabels to function within the container. This allows separation of
 
 Set the label process type for the container processes.
 
+### `ServiceName=name`
+
+By default, Quadlet will name the systemd service unit by appending `-container` to the name of the Quadlet.
+Setting this key overrides this behavior by instructing Quadlet to use the provided name.
+
+Note, the name should not include the `.service` file extension
+
 @@option quadlet:shm-size
 
 ### `StartWithPod=bool`
diff --git a/docs/source/markdown/podman-image.unit.5.md.in b/docs/source/markdown/podman-image.unit.5.md.in
@@ -45,6 +45,7 @@ Valid options for `[Image]` are listed below:
 | Policy=always                          | --policy=always                                  |
 | Retry=5                                | --retry=5                                        |
 | RetryDelay=10s                         | --retry-delay=10s                                |
+| ServiceName=name                       | Name the systemd unit `name.service`             |
 | TLSVerify=false                        | --tls-verify=false                               |
 | Variant=arm/v7                         | --variant=arm/v7                                 |
 
@@ -96,6 +97,13 @@ requires setting
 
 @@option quadlet:retry-delay
 
+### `ServiceName=name`
+
+By default, Quadlet will name the systemd service unit by appending `-image` to the name of the Quadlet.
+Setting this key overrides this behavior by instructing Quadlet to use the provided name.
+
+Note, the name should not include the `.service` file extension
+
 @@option quadlet:tls-verify
 
 @@option quadlet:variant.container
diff --git a/docs/source/markdown/podman-kube.unit.5.md.in b/docs/source/markdown/podman-kube.unit.5.md.in
@@ -43,6 +43,7 @@ Valid options for `[Kube]` are listed below:
 | Network=host                        | --network host                                                   |
 | PodmanArgs=\-\-annotation=key=value | --annotation=key=value                                           |
 | PublishPort=8080:80                 | --publish 8080:80                                                |
+| ServiceName=name                    | Name the systemd unit `name.service`                             |
 | SetWorkingDirectory=yaml            | Set `WorkingDirectory` of unit file to location of the YAML file |
 | UserNS=keep-id:uid=200,gid=210      | --userns keep-id:uid=200,gid=210                                 |
 | Yaml=/tmp/kube.yaml                 | podman kube play /tmp/kube.yaml                                  |
@@ -89,6 +90,13 @@ Equivalent to the Podman `--force` option.
 
 @@option quadlet:publish
 
+### `ServiceName=name`
+
+By default, Quadlet will name the systemd service unit by appending `-kube` to the name of the Quadlet.
+Setting this key overrides this behavior by instructing Quadlet to use the provided name.
+
+Note, the name should not include the `.service` file extension
+
 ### `SetWorkingDirectory=yaml`
 
 Set the `WorkingDirectory` field of the `Service` group of the Systemd service unit file.
diff --git a/docs/source/markdown/podman-network.unit.5.md.in b/docs/source/markdown/podman-network.unit.5.md.in
@@ -50,6 +50,7 @@ Valid options for `[Network]` are listed below:
 | NetworkName=foo                     | podman network create foo                                       |
 | Options=isolate=true                | --opt isolate=true                                              |
 | PodmanArgs=--dns=192.168.55.1       | --dns=192.168.55.1                                              |
+| ServiceName=name                    | Name the systemd unit `name.service`                            |
 | Subnet=192.5.0.0/16                 | --subnet 192.5.0.0/16                                           |
 
 
@@ -92,6 +93,13 @@ conflicts with user-managed network.
 
 @@option quadlet:podman-args
 
+### `ServiceName=name`
+
+By default, Quadlet will name the systemd service unit by appending `-network` to the name of the Quadlet.
+Setting this key overrides this behavior by instructing Quadlet to use the provided name.
+
+Note, the name should not include the `.service` file extension
+
 @@option quadlet:subnet
 
 # EXAMPLES
diff --git a/docs/source/markdown/podman-volume.unit.5.md.in b/docs/source/markdown/podman-volume.unit.5.md.in
@@ -56,6 +56,7 @@ Valid options for `[Volume]` are listed below:
 | Label="foo=bar"                     | --label "foo=bar"                         |
 | Options=XYZ                         | --opt "o=XYZ"                             |
 | PodmanArgs=--driver=image           | --driver=image                            |
+| ServiceName=name                    | Name the systemd unit `name.service`      |
 | Type=type                           | Filesystem type of Device                 |
 | User=123                            | --opt uid=123                             |
 | VolumeName=foo                      | podman volume create foo                  |
@@ -113,6 +114,13 @@ The mount options to use for a filesystem as used by the **mount(8)** command `-
 
 @@option quadlet:podman-args
 
+### `ServiceName=name`
+
+By default, Quadlet will name the systemd service unit by appending `-volume` to the name of the Quadlet.
+Setting this key overrides this behavior by instructing Quadlet to use the provided name.
+
+Note, the name should not include the `.service` file extension
+
 ### `Type=`
 
 The filesystem type of `Device` as used by the **mount(8)** commands `-t` option.
