Document .build for Image .container option #24926
Conversation
openshift-ci
bot
added
release-note
approved
|
@ygalblum PTAL Do you know if you can use .build from .Mount options or anywhere else where .image files can be used? |
Currently, no. The |
| Note that the corresponding `.image` file must exist. | ||
| Special Cases: | ||
|
|
||
| * If the `name` of the image ends with `.image`, Quadlet will use the image pulled by the corresponding `.image` file, and the generated systemd service contains a dependency on the `$name-image.service`. Note that the corresponding `.image` file must exist. |
There was a problem hiding this comment.
Since Quadlet now allows setting the name of the generated service, it should be something like:
"a dependency on the $name-image.service (or the service name set in the .image file)"
The same applies for the .build file and other places in this change
| created by using a `$name.volume` Quadlet file. | ||
| Special case: | ||
|
|
||
| * If `SOURCE-VOLUME` ends with `.volume`, a Podman named volume called `systemd-$name` is used as the source, and the generated systemd service contains a dependency on the `$name-volume.service`. Such a volume can be automatically be lazily created by using a `$name.volume` Quadlet file. |
There was a problem hiding this comment.
Such a volume can be automatically be lazily created
I know this exists in the original doc, but it's incorrect. The .volume file must exist
| * If the `name` of the network ends with `.network`, Quadlet will look for the corresponding `.network` Quadlet unit. If found, Quadlet will use the name of the Network set in the Unit, otherwise, `systemd-$name` is used. | ||
|
|
||
| The generated systemd service contains a dependency on the service unit generated for that `.network` unit, or on `$name-network.service` if the `.network` unit is not found. |
There was a problem hiding this comment.
With the current implementation the .network file must exist
| * 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 | ||
| or on `$name-volume.service` if the `.volume` unit is not found. |
There was a problem hiding this comment.
Again, the .volume file must exist. Quadlet will use the name of the volume generated for the .volume unit
| created by using a `$name.network` Quadlet file. | ||
| Special case: | ||
|
|
||
| * If the `name` of the network ends with `.network`, a Podman network called `systemd-$name` is used, and the generated systemd service contains a dependency on the `$name-network.service`. Such a network can be automatically created by using a `$name.network` Quadlet file.n |
There was a problem hiding this comment.
Such a network can be automatically created
The .network file must exist
| unit is not found. | ||
| Special case: | ||
|
|
||
| * If the `name` of the network ends with `.network`, Quadlet will look for the corresponding `.network` Quadlet unit. If found, Quadlet will use the name of the Network set in the Unit, otherwise, `systemd-$name` is used. The generated systemd service contains a dependency on the service unit generated for that `.network` unit, or on `$name-network.service` if the `.network` unit is not found. |
There was a problem hiding this comment.
The .network file must exist
| is not found | ||
| Special case: | ||
|
|
||
| * 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 |
There was a problem hiding this comment.
The .volume file must exist
$NAME.build is supported in .container to automatically build the local image. This needs to be documented. Also fix up other special cases to look the same in the man page. Fixes: https://www.reddit.com/r/podman/comments/1hmhhhi/quadlet_build_units/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button Signed-off-by: Daniel J Walsh <[email protected]>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Luap99, rhatdan, ygalblum The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
$NAME.build is supported in .container to automatically build the local image. This needs to be documented.
Also fix up other special cases to look the same in the man page.
Fixes: https://www.reddit.com/r/podman/comments/1hmhhhi/quadlet_build_units/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button
Does this PR introduce a user-facing change?