summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/source/Commands.rst4
-rw-r--r--docs/source/machine.rst5
-rw-r--r--docs/source/markdown/podman-container-checkpoint.1.md52
-rw-r--r--docs/source/markdown/podman-container-restore.1.md15
-rw-r--r--docs/source/markdown/podman-system-service.1.md4
-rw-r--r--docs/tutorials/podman-go-bindings.md12
-rw-r--r--docs/tutorials/remote_client.md4
7 files changed, 69 insertions, 27 deletions
diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst
index 766b6a02e..767b09c08 100644
--- a/docs/source/Commands.rst
+++ b/docs/source/Commands.rst
@@ -55,7 +55,7 @@ Commands
:doc:`logs <markdown/podman-logs.1>` Fetch the logs of a container
-:doc:`machine <markdown/podman-machine.1>` Manage podman's virtual machine
+:doc:`machine <machine>` Manage podman's virtual machine
:doc:`manifest <manifest>` Create and manipulate manifest lists and image indexes
@@ -91,7 +91,7 @@ Commands
:doc:`search <markdown/podman-search.1>` Search registry for image
-:doc:`secret <markdown/podman-secret.1>` Manage podman secrets
+:doc:`secret <secret>` Manage podman secrets
:doc:`start <markdown/podman-start.1>` Start one or more containers
diff --git a/docs/source/machine.rst b/docs/source/machine.rst
index 16c042173..3962fca99 100644
--- a/docs/source/machine.rst
+++ b/docs/source/machine.rst
@@ -3,8 +3,13 @@ Machine
:doc:`init <markdown/podman-machine-init.1>` Initialize a new virtual machine
+
:doc:`list <markdown/podman-machine-list.1>` List virtual machines
+
:doc:`rm <markdown/podman-machine-rm.1>` Remove a virtual machine
+
:doc:`ssh <markdown/podman-machine-ssh.1>` SSH into a virtual machine
+
:doc:`start <markdown/podman-machine-start.1>` Start a virtual machine
+
:doc:`stop <markdown/podman-machine-stop.1>` Stop a virtual machine
diff --git a/docs/source/markdown/podman-container-checkpoint.1.md b/docs/source/markdown/podman-container-checkpoint.1.md
index 46b6cb646..271a44c9d 100644
--- a/docs/source/markdown/podman-container-checkpoint.1.md
+++ b/docs/source/markdown/podman-container-checkpoint.1.md
@@ -10,31 +10,25 @@ podman\-container\-checkpoint - Checkpoints one or more running containers
Checkpoints all the processes in one or more containers. You may use container IDs or names as input.
## OPTIONS
-#### **--keep**, **-k**
-
-Keep all temporary log and statistics files created by CRIU during checkpointing. These files
-are not deleted if checkpointing fails for further debugging. If checkpointing succeeds these
-files are theoretically not needed, but if these files are needed Podman can keep the files
-for further analysis.
-
#### **--all**, **-a**
Checkpoint all running containers.
-#### **--latest**, **-l**
-
-Instead of providing the container name or ID, checkpoint the last created container. (This option is not available with the remote Podman client)
-
-#### **--leave-running**, **-R**
+#### **--compress**, **-c**
-Leave the container running after checkpointing instead of stopping it.
+Specify the compression algorithm used for the checkpoint archive created
+with the **--export, -e** option. Possible algorithms are *gzip*, *none*
+and *zstd*. If no compression algorithm is specified Podman will use
+*zstd*.
-#### **--tcp-established**
+One possible reason to use *none* is to enable faster creation of checkpoint
+archives. Not compressing the checkpoint archive can result in faster checkpoint
+archive creation.
-Checkpoint a container with established TCP connections. If the checkpoint
-image contains established TCP connections, this options is required during
-restore. Defaults to not checkpointing containers with established TCP
-connections.
+```
+# podman container checkpoint -l --compress=none --export=dump.tar
+# podman container checkpoint -l --compress=gzip --export=dump.tar.gz
+```
#### **--export**, **-e**
@@ -56,11 +50,33 @@ This option must be used in combination with the **--export, -e** option.
When this option is specified, the content of volumes associated with
the container will not be included into the checkpoint tar.gz file.
+#### **--keep**, **-k**
+
+Keep all temporary log and statistics files created by CRIU during checkpointing. These files
+are not deleted if checkpointing fails for further debugging. If checkpointing succeeds these
+files are theoretically not needed, but if these files are needed Podman can keep the files
+for further analysis.
+
+#### **--latest**, **-l**
+
+Instead of providing the container name or ID, checkpoint the last created container. (This option is not available with the remote Podman client)
+
+#### **--leave-running**, **-R**
+
+Leave the container running after checkpointing instead of stopping it.
+
#### **--pre-checkpoint**, **-P**
Dump the container's memory information only, leaving the container running. Later
operations will supersede prior dumps. It only works on runc 1.0-rc3 or higher.
+#### **--tcp-established**
+
+Checkpoint a container with established TCP connections. If the checkpoint
+image contains established TCP connections, this options is required during
+restore. Defaults to not checkpointing containers with established TCP
+connections.
+
#### **--with-previous**
Check out the container with previous criu image files in pre-dump. It only works
diff --git a/docs/source/markdown/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md
index ef8722279..82bf76d1e 100644
--- a/docs/source/markdown/podman-container-restore.1.md
+++ b/docs/source/markdown/podman-container-restore.1.md
@@ -95,6 +95,19 @@ This option must be used in combination with the **--import, -i** option.
When restoring containers from a checkpoint tar.gz file with this option,
the content of associated volumes will not be restored.
+#### **--publish**, **-p**
+
+Replaces the ports that the container publishes, as configured during the
+initial container start, with a new set of port forwarding rules.
+
+```
+# podman run --rm -p 2345:80 -d webserver
+# podman container checkpoint -l --export=dump.tar
+# podman container restore -p 5432:8080 --import=dump.tar
+```
+
+For more details please see **podman run --publish**.
+
## EXAMPLE
podman container restore mywebserver
@@ -104,7 +117,7 @@ podman container restore 860a4b23
podman container restore --import-previous pre-checkpoint.tar.gz --import checkpoint.tar.gz
## SEE ALSO
-podman(1), podman-container-checkpoint(1)
+podman(1), podman-container-checkpoint(1), podman-run(1)
## HISTORY
September 2018, Originally compiled by Adrian Reber <areber@redhat.com>
diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md
index 2c8be73c2..dfb026de1 100644
--- a/docs/source/markdown/podman-system-service.1.md
+++ b/docs/source/markdown/podman-system-service.1.md
@@ -30,6 +30,10 @@ Note: The default systemd unit files (system and user) change the log-level opti
The time until the session expires in _seconds_. The default is 5
seconds. A value of `0` means no timeout, therefore the session will not expire.
+#### **--cors**
+
+CORS headers to inject to the HTTP response. The default value is empty string which disables CORS headers.
+
#### **--help**, **-h**
Print usage statement.
diff --git a/docs/tutorials/podman-go-bindings.md b/docs/tutorials/podman-go-bindings.md
index a952f2dc0..2bbf4e5de 100644
--- a/docs/tutorials/podman-go-bindings.md
+++ b/docs/tutorials/podman-go-bindings.md
@@ -174,7 +174,7 @@ This binding takes three arguments:
```Go
// Pull Busybox image (Sample 1)
fmt.Println("Pulling Busybox image...")
- _, err = images.Pull(connText, "docker.io/busybox", entities.ImagePullOptions{})
+ _, err = images.Pull(connText, "docker.io/busybox", &images.PullOptions{})
if err != nil {
fmt.Println(err)
os.Exit(1)
@@ -183,7 +183,7 @@ This binding takes three arguments:
// Pull Fedora image (Sample 2)
rawImage := "registry.fedoraproject.org/fedora:latest"
fmt.Println("Pulling Fedora image...")
- _, err = images.Pull(connText, rawImage, entities.ImagePullOptions{})
+ _, err = images.Pull(connText, rawImage, &images.PullOptions{})
if err != nil {
fmt.Println(err)
os.Exit(1)
@@ -229,7 +229,7 @@ This binding takes three arguments:
```Go
// List images
- imageSummary, err := images.List(connText, nil, nil)
+ imageSummary, err := images.List(connText, &images.ListOptions{})
if err != nil {
fmt.Println(err)
os.Exit(1)
@@ -287,7 +287,7 @@ containers.Wait() takes three arguments:
// Container create
s := specgen.NewSpecGenerator(rawImage, false)
s.Terminal = true
- r, err := containers.CreateWithSpec(connText, s)
+ r, err := containers.CreateWithSpec(connText, s, nil)
if err != nil {
fmt.Println(err)
os.Exit(1)
@@ -302,7 +302,7 @@ containers.Wait() takes three arguments:
}
running := define.ContainerStateRunning
- _, err = containers.Wait(connText, r.ID, &running)
+ _, err = containers.Wait(connText, r.ID, &containers.WaitOptions{Condition: []define.ContainerStatus{running}})
if err != nil {
fmt.Println(err)
os.Exit(1)
@@ -346,7 +346,7 @@ containers.List() takes seven arguments:
```Go
// Container list
var latestContainers = 1
- containerLatestList, err := containers.List(connText, nil, nil, &latestContainers, nil, nil, nil)
+ containerLatestList, err := containers.List(connText, &containers.ListOptions{Last: &latestContainers})
if err != nil {
fmt.Println(err)
os.Exit(1)
diff --git a/docs/tutorials/remote_client.md b/docs/tutorials/remote_client.md
index e39d804a6..889947397 100644
--- a/docs/tutorials/remote_client.md
+++ b/docs/tutorials/remote_client.md
@@ -108,5 +108,9 @@ podman-remote system connection --help
You can use the Podman remote clients to manage your containers running on a Linux server. The communication between client and server relies heavily on SSH connections and the use of SSH keys are encouraged. Once you have Podman installed on your remote client, you should set up a connection using `podman-remote system connection add` which will then be used by subsequent Podman commands.
+# Troubleshooting
+
+See the [Troubleshooting](../../troubleshooting.md) document if you run into issues.
+
## History
Adapted from the [Mac and Windows tutorial](https://github.com/containers/podman/blob/master/docs/tutorials/mac_win_client.md)
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-08 07:00:48 +0000