diff options
| author | flouthoc <flouthoc.git@gmail.com> | 2021-08-20 14:22:54 +0530 |
|---|---|---|
| committer | flouthoc <flouthoc.git@gmail.com> | 2021-08-23 20:42:41 +0530 |
| commit | edddfe8c4f7761b12dc64ea4aa0a83b755aa124f (patch) | |
| tree | 4eb4323903b3aec46fd5da3dd7152c24d88045d0 /docs | |
| parent | 30b036c5d394bb523fa13074b1731ad4b6259693 (diff) | |
| download | podman-edddfe8c4f7761b12dc64ea4aa0a83b755aa124f.tar.gz podman-edddfe8c4f7761b12dc64ea4aa0a83b755aa124f.tar.bz2 podman-edddfe8c4f7761b12dc64ea4aa0a83b755aa124f.zip | |
volumes: Add support for exporting volumes to external tar
Adds support for transferring data between systems and backing up systems.
Use cases: recover from disasters or move data between machines.
Signed-off-by: flouthoc <flouthoc.git@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/podman-volume-export.1.md | 38 | ||||
| -rw-r--r-- | docs/source/markdown/podman-volume.1.md | 1 | ||||
| -rw-r--r-- | docs/source/volume.rst | 2 |
3 files changed, 41 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-volume-export.1.md b/docs/source/markdown/podman-volume-export.1.md new file mode 100644 index 000000000..caaa37652 --- /dev/null +++ b/docs/source/markdown/podman-volume-export.1.md @@ -0,0 +1,38 @@ +% podman-volume-export(1) + +## NAME +podman\-volume\-export - Exports volume to external tar + +## SYNOPSIS +**podman volume export** [*options*] *volume* + +## DESCRIPTION + +**podman volume export** exports the contents of a podman volume and saves it as a tarball +on the local machine. **podman volume export** writes to STDOUT by default and can be +redirected to a file using the `--output` flag. + +Note: Following command is not supported by podman-remote. + +**podman volume export [OPTIONS] VOLUME** + +## OPTIONS + +#### **--output**, **-o**=*file* + +Write to a file, default is STDOUT + +#### **--help** + +Print usage statement + + +## EXAMPLES + +``` +$ podman volume export myvol --output myvol.tar + +``` + +## SEE ALSO +podman-volume(1) diff --git a/docs/source/markdown/podman-volume.1.md b/docs/source/markdown/podman-volume.1.md index 5af5eb50e..20319ccf7 100644 --- a/docs/source/markdown/podman-volume.1.md +++ b/docs/source/markdown/podman-volume.1.md @@ -15,6 +15,7 @@ podman volume is a set of subcommands that manage volumes. | ------- | ------------------------------------------------------ | ------------------------------------------------------------------------------ | | create | [podman-volume-create(1)](podman-volume-create.1.md) | Create a new volume. | | exists | [podman-volume-exists(1)](podman-volume-exists.1.md) | Check if the given volume exists. | +| export | [podman-volume-export(1)](podman-volume-export.1.md) | Exports volume to external tar. | | inspect | [podman-volume-inspect(1)](podman-volume-inspect.1.md) | Get detailed information on one or more volumes. | | ls | [podman-volume-ls(1)](podman-volume-ls.1.md) | List all the available volumes. | | prune | [podman-volume-prune(1)](podman-volume-prune.1.md) | Remove all unused volumes. | diff --git a/docs/source/volume.rst b/docs/source/volume.rst index ce9ea2cbd..fb607cc2b 100644 --- a/docs/source/volume.rst +++ b/docs/source/volume.rst @@ -4,6 +4,8 @@ Volume :doc:`exists <markdown/podman-volume-exists.1>` Check if the given volume exists +:doc:`export <markdown/podman-volume-export.1>` Exports volume to external tar + :doc:`inspect <markdown/podman-volume-inspect.1>` Display detailed information on one or more volumes :doc:`ls <markdown/podman-volume-ls.1>` List volumes |