summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-system-renumber.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-system-renumber.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-system-renumber.1.md')
-rw-r--r--docs/source/man/podman-system-renumber.1.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/source/man/podman-system-renumber.1.md b/docs/source/man/podman-system-renumber.1.md
new file mode 100644
index 000000000..071eefe29
--- /dev/null
+++ b/docs/source/man/podman-system-renumber.1.md
@@ -0,0 +1,26 @@
+% podman-system-renumber(1)
+
+## NAME
+podman\-system\-renumber - Migrate lock numbers to handle a change in maximum number of locks
+
+## SYNOPSIS
+**podman system renumber**
+
+## DESCRIPTION
+**podman system renumber** renumbers locks used by containers and pods.
+
+Each Podman container and pod is allocated a lock at creation time, up to a maximum number controlled by the **num_locks** parameter in **libpod.conf**.
+
+When all available locks are exhausted, no further containers and pods can be created until some existing containers and pods are removed. This can be avoided by increasing the number of locks available via modifying **libpod.conf** and subsequently running **podman system renumber** to prepare the new locks (and reallocate lock numbers to fit the new struct).
+
+**podman system renumber** must be called after any changes to **num_locks** - failure to do so will result in errors starting Podman as the number of locks available conflicts with the configured number of locks.
+
+**podman system renumber** can also be used to migrate 1.0 and earlier versions of Podman, which used a different locking scheme, to the new locking model. It is not strictly required to do this, but it is highly recommended to do so as deadlocks can occur otherwise.
+
+If possible, avoid calling **podman system renumber** while there are other Podman processes running.
+
+## SEE ALSO
+`podman(1)`, `libpod.conf(5)`
+
+## HISTORY
+February 2019, Originally compiled by Matt Heon (mheon at redhat dot com)