summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorcdoern <cdoern@redhat.com>2021-06-25 14:26:33 -0400
committercdoern <cdoern@redhat.com>2021-07-30 17:19:24 -0400
commit1d10ca739f3599b9bd746783ad15c8f51ce9f75c (patch)
tree28565571d2e564fc367ca6ad97eccc9ffc3c9d19 /docs
parentec5ab591ddbb905b69b3daa6012e9c0dfde9fcec (diff)
downloadpodman-1d10ca739f3599b9bd746783ad15c8f51ce9f75c.tar.gz
podman-1d10ca739f3599b9bd746783ad15c8f51ce9f75c.tar.bz2
podman-1d10ca739f3599b9bd746783ad15c8f51ce9f75c.zip
Created scp.go image_scp_test.go and podman-image-scp.1.md
added functionality for image secure copying from local to remote. Also moved system connection add code around a bit so functions within that file can be used by scp. Signed-off-by: cdoern <cdoern@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/image.rst2
-rw-r--r--docs/source/markdown/podman-image-scp.1.md69
-rw-r--r--docs/source/markdown/podman-image.1.md1
3 files changed, 72 insertions, 0 deletions
diff --git a/docs/source/image.rst b/docs/source/image.rst
index 0552df929..0987a0149 100644
--- a/docs/source/image.rst
+++ b/docs/source/image.rst
@@ -30,6 +30,8 @@ Image
:doc:`save <markdown/podman-save.1>` Save image to an archive
+:doc:`scp <markdown/podman-image-scp.1>` Securely copy an image from one host to another
+
:doc:`search <markdown/podman-search.1>` Search a registry for an image
:doc:`sign <markdown/podman-image-sign.1>` Sign an image
diff --git a/docs/source/markdown/podman-image-scp.1.md b/docs/source/markdown/podman-image-scp.1.md
new file mode 100644
index 000000000..7d143c851
--- /dev/null
+++ b/docs/source/markdown/podman-image-scp.1.md
@@ -0,0 +1,69 @@
+% podman-image-scp(1)
+
+## NAME
+podman-image-scp - Securely copy an image from one host to another
+
+## SYNOPSIS
+**podman image scp** [*options*] *name*[:*tag*]
+
+## DESCRIPTION
+**podman image scp** copies container images between hosts on a network. You can load to the remote host or from the remote host as well as in between two remote hosts.
+Note: `::` is used to specify the image name depending on if you are saving or loading.
+
+**podman image scp [GLOBAL OPTIONS]**
+
+**podman image** *scp [OPTIONS] NAME[:TAG] [HOSTNAME::]*
+
+**podman image** *scp [OPTIONS] [HOSTNAME::]IMAGENAME*
+
+**podman image** *scp [OPTIONS] [HOSTNAME::]IMAGENAME [HOSTNAME::]*
+
+## OPTIONS
+
+#### **--quiet**, **-q**
+
+Suppress the output
+
+#### **--help**, **-h**
+
+Print usage statement
+
+## EXAMPLES
+
+
+```
+$ podman image scp alpine
+Loaded image(s): docker.io/library/alpine:latest
+```
+
+```
+$ podman image scp alpine Fedora::/home/charliedoern/Documents/alpine
+Getting image source signatures
+Copying blob 72e830a4dff5 done
+Copying config 85f9dc67c7 done
+Writing manifest to image destination
+Storing signatures
+Loaded image(s): docker.io/library/alpine:latest
+```
+
+```
+$ podman image scp Fedora::alpine RHEL::
+Loaded image(s): docker.io/library/alpine:latest
+```
+
+```
+$ podman image scp charliedoern@192.168.68.126:22/run/user/1000/podman/podman.sock::alpine
+WARN[0000] Unknown connection name given. Please use system connection add to specify the default remote socket location
+Getting image source signatures
+Copying blob 9450ef9feb15 [--------------------------------------] 0.0b / 0.0b
+Copying config 1f97f0559c done
+Writing manifest to image destination
+Storing signatures
+Loaded images(s): docker.io/library/alpine:latest
+```
+
+## SEE ALSO
+podman(1), podman-load(1), podman-save(1), podman-remote(1), podman-system-connection-add(1), containers.conf(5), containers-transports(5)
+
+## HISTORY
+July 2021, Originally written by Charlie Doern <cdoern@redhat.com>
diff --git a/docs/source/markdown/podman-image.1.md b/docs/source/markdown/podman-image.1.md
index 1b0dc395d..3e6050d99 100644
--- a/docs/source/markdown/podman-image.1.md
+++ b/docs/source/markdown/podman-image.1.md
@@ -27,6 +27,7 @@ The image command allows you to manage images
| push | [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. |
| rm | [podman-rmi(1)](podman-rmi.1.md) | Removes one or more locally stored images. |
| save | [podman-save(1)](podman-save.1.md) | Save an image to docker-archive or oci. |
+| scp | [podman-image-scp(1)](podman-image-scp.1.md) | Securely copy an image from one host to another. |
| search | [podman-search(1)](podman-search.1.md) | Search a registry for an image. |
| sign | [podman-image-sign(1)](podman-image-sign.1.md) | Create a signature for an image. |
| tag | [podman-tag(1)](podman-tag.1.md) | Add an additional name to a local image. |