summaryrefslogtreecommitdiff
path: root/docs/podman-init.1.md
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@pm.me>2019-04-29 10:37:50 -0400
committerMatthew Heon <matthew.heon@pm.me>2019-05-01 11:12:24 -0400
commit0b2c9c2acc38f51f871fd5a06aca205127a06d1d (patch)
tree62a3f1a5e8ad83d9ec7bfe1a066b3d898f69c8c9 /docs/podman-init.1.md
parentad68036a88e35dc3c7a19962b8e21867b459f8f1 (diff)
downloadpodman-0b2c9c2acc38f51f871fd5a06aca205127a06d1d.tar.gz
podman-0b2c9c2acc38f51f871fd5a06aca205127a06d1d.tar.bz2
podman-0b2c9c2acc38f51f871fd5a06aca205127a06d1d.zip
Add basic structure of podman init command
As part of this, rework the number of workers used by various Podman tasks to match original behavior - need an explicit fallthrough in the switch statement for that block to work as expected. Also, trivial change to Podman cleanup to work on initialized containers - we need to reset to a different state after cleaning up the OCI runtime. Signed-off-by: Matthew Heon <matthew.heon@pm.me>
Diffstat (limited to 'docs/podman-init.1.md')
-rw-r--r--docs/podman-init.1.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/podman-init.1.md b/docs/podman-init.1.md
new file mode 100644
index 000000000..aff7a833d
--- /dev/null
+++ b/docs/podman-init.1.md
@@ -0,0 +1,41 @@
+% podman-init(1)
+
+## NAME
+podman\-init - Initialize one or more containers
+
+## SYNOPSIS
+**podman init** [*options*] *container* ...
+
+## DESCRIPTION
+Initialize one or more containers.
+You may use container IDs or names as input.
+Initializing a container performs all tasks necessary for starting the container (mounting filesystems, creating an OCI spec, initializing the container network) but does not start the container.
+If a container is not initialized, the `podman start` and `podman run` commands will do so automatically prior to starting it.
+This command is intended to be used for inspecting or modifying the container's filesystem or OCI spec prior to starting it.
+This can be used to inspect the container before it runs, or debug why a container is failing to run.
+
+## OPTIONS
+
+**--all, a**
+
+Initialize all containers. Containers that have already initialized (including containers that have been started and are running) are ignored.
+
+**--latest, -l**
+Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
+to run containers such as CRI-O, the last started container could be from either of those methods.
+
+The latest option is not supported on the remote client.
+
+## EXAMPLE
+
+podman init 35480fc9d568
+
+podman init test1
+
+podman init --latest
+
+## SEE ALSO
+podman(1), podman-start(1)
+
+## HISTORY
+April 2019, Originally compiled by Matthew Heon <mheon@redhat.com>