diff options
author | Ed Santiago <santiago@redhat.com> | 2022-05-11 11:11:36 -0600 |
---|---|---|
committer | Ed Santiago <santiago@redhat.com> | 2022-05-11 13:14:08 -0600 |
commit | e76a07087ef3ed19b659a716f51f5d83f4af773e (patch) | |
tree | 92b040a47f72246eb6bbf80e4db8afc51987611f /docs/source/markdown/podman-auto-update.1.md | |
parent | c379014ee4e57dc19669ae92f45f8e4c0814295b (diff) | |
download | podman-e76a07087ef3ed19b659a716f51f5d83f4af773e.tar.gz podman-e76a07087ef3ed19b659a716f51f5d83f4af773e.tar.bz2 podman-e76a07087ef3ed19b659a716f51f5d83f4af773e.zip |
[CI:DOCS] man pages: fix inconsistencies
As part of work done in #14046, fix bugs found in man pages,
basically just moving a few descriptions to the right place
and removing some undesired asterisks.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-auto-update.1.md')
-rw-r--r-- | docs/source/markdown/podman-auto-update.1.md | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/docs/source/markdown/podman-auto-update.1.md b/docs/source/markdown/podman-auto-update.1.md index 755f46d70..992c87432 100644 --- a/docs/source/markdown/podman-auto-update.1.md +++ b/docs/source/markdown/podman-auto-update.1.md @@ -51,15 +51,6 @@ The `UPDATED` field indicates the availability of a new image with "pending". Change the default output format. This can be of a supported type like 'json' or a Go template. Valid placeholders for the Go template are listed below: -#### **--rollback** - -If restarting a systemd unit after updating the image has failed, rollback to using the previous image and restart the unit another time. Default is true. - -Please note that detecting if a systemd unit has failed is best done by the container sending the READY message via SDNOTIFY. This way, restarting the unit will wait until having received the message or a timeout kicked in. Without that, restarting the systemd unit may succeed even if the container has failed shortly after. - -For a container to send the READY message via SDNOTIFY it must be created with the `--sdnotify=container` option (see podman-run(1)). The application running inside the container can then execute `systemd-notify --ready` when ready or use the sdnotify bindings of the specific programming language (e.g., sd_notify(3)). - - | **Placeholder** | **Description** | | --------------- | -------------------------------------- | | .Unit | Name of the systemd unit | @@ -70,6 +61,14 @@ For a container to send the READY message via SDNOTIFY it must be created with t | .Policy | Auto-update policy of the container | | .Updated | Update status: true,false,failed | +#### **--rollback** + +If restarting a systemd unit after updating the image has failed, rollback to using the previous image and restart the unit another time. Default is true. + +Please note that detecting if a systemd unit has failed is best done by the container sending the READY message via SDNOTIFY. This way, restarting the unit will wait until having received the message or a timeout kicked in. Without that, restarting the systemd unit may succeed even if the container has failed shortly after. + +For a container to send the READY message via SDNOTIFY it must be created with the `--sdnotify=container` option (see podman-run(1)). The application running inside the container can then execute `systemd-notify --ready` when ready or use the sdnotify bindings of the specific programming language (e.g., sd_notify(3)). + ## EXAMPLES Autoupdate with registry policy |