docs: fix [Build] Volume= to not reference named volumes#28389
docs: fix [Build] Volume= to not reference named volumes#28389kovan wants to merge 2 commits intocontainers:mainfrom
Conversation
danishprakash
left a comment
danishprakash
left a comment
There was a problem hiding this comment.
It seems that changes from #28388 were mistakenly added to this PR too. Can you clean this up?
The [Build] Volume= documentation incorrectly described support for named volumes and .volume Quadlet unit references, which are only available in [Container] Volume=. Fixes containers#25514 Signed-off-by: Kit Dallege <xaum.io@gmail.com>
kovan
force-pushed
the
docs/fix-build-volume-docs
branch
from
105a1bf to
ecc6d62
Compare
|
Cleaned up - force-pushed with only the systemd.unit.5.md change. The reload-systemd changes from #28388 are no longer included. Sorry about the mess. |
|
[NON-BLOCKING] Packit jobs failed. @containers/packit-build please check. Everyone else, feel free to ignore. |
|
LGTM, but I'd like someone with deeper Quadlet knowledge to take a look. |
| If `HOST-DIR` starts with `.`, Quadlet resolves the path relative to the location of the unit file. | ||
|
|
||
| * If `SOURCE-VOLUME` ends with `.volume`, Quadlet will look for the corresponding `.volume` Quadlet unit. If found, Quadlet will use the name of the Volume set in the Unit, otherwise, `systemd-$name` is used. The generated systemd service contains a dependency on the service unit generated for that `.volume` unit, or on `$name-volume.service` if the `.volume` unit is not found. Note: the corresponding `.volume` file must exist. | ||
| Note: unlike the `[Container]` section's `Volume=`, this option does not support named volumes or `.volume` Quadlet unit references, because `podman build --volume` only supports host directory bind mounts. |
There was a problem hiding this comment.
I would update the note for [Build] Volume= to clarify that podman build --volume only supports host directory bind mounts. Because of this, .volume references and named volumes may not work, even though Quadlet resolves them.
Update the note to reflect that Quadlet does resolve .volume references and named volumes for [Build] Volume=, but they may not work as expected because podman build --volume only supports host directory bind mounts.
|
PTAL @ygalblum @containers/podman-maintainers |
5 participants
The
[Build] Volume=documentation incorrectly described support for named volumes (SOURCE-VOLUME) and.volumeQuadlet unit references. These features are only available in[Container] Volume=, not in[Build] Volume=, becausepodman build --volumeonly supports host directory bind mounts.[HOST-DIR:]CONTAINER-DIR[:OPTIONS].volumespecial case section[Container] Volume=Fixes #25514