Files
podman/docs/source/markdown/podman-update.1.md.in
Daniel J Walsh d3a49fdedb Add information about --latest support on man pages
On Mac and Windows systems the --latest option is not supported
this PR mentions this fact in the examples section of the man page.
Also added documentation and consistency to the man pages examples
sections.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2024-01-23 07:28:40 -05:00

81 lines
2.2 KiB
Markdown

% podman-update 1
## NAME
podman\-update - Update the cgroup configuration of a given container
## SYNOPSIS
**podman update** [*options*] *container*
**podman container update** [*options*] *container*
## DESCRIPTION
Updates the cgroup configuration of an already existing container. The currently supported options are a subset of the
podman create/run resource limits options. These new options are non-persistent and only last for the current execution of the container; the configuration is honored on its next run.
This means that this command can only be executed on an already running container and the changes made is erased the next time the container is stopped and restarted, this is to ensure immutability.
This command takes one argument, a container name or ID, alongside the resource flags to modify the cgroup.
## OPTIONS
@@option blkio-weight
@@option blkio-weight-device
@@option cpu-period
@@option cpu-quota
@@option cpu-rt-period
@@option cpu-rt-runtime
@@option cpu-shares
@@option cpus.container
@@option cpuset-cpus
@@option cpuset-mems
@@option device-read-bps
@@option device-read-iops
@@option device-write-bps
@@option device-write-iops
@@option memory
@@option memory-reservation
@@option memory-swap
@@option memory-swappiness
@@option pids-limit
## EXAMPLEs
Update a container with a new cpu quota and period.
```
podman update --cpus=5 myCtr
```
Update a container with all available options for cgroups v2.
```
podman update --cpus 5 --cpuset-cpus 0 --cpu-shares 123 --cpuset-mems 0 --memory 1G --memory-swap 2G --memory-reservation 2G --blkio-weight-device /dev/zero:123 --blkio-weight 123 --device-read-bps /dev/zero:10mb --device-write-bps /dev/zero:10mb --device-read-iops /dev/zero:1000 --device-write-iops /dev/zero:1000 --pids-limit 123 ctrID
```
Update a container with all available options for cgroups v1.
```
podman update --cpus 5 --cpuset-cpus 0 --cpu-shares 123 --cpuset-mems 0 --memory 1G --memory-swap 2G --memory-reservation 2G --memory-swappiness 50 --pids-limit 123 ctrID
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-create(1)](podman-create.1.md)**, **[podman-run(1)](podman-run.1.md)**
## HISTORY
August 2022, Originally written by Charlie Doern <cdoern@redhat.com>