From 23979f8e0644cd1e05e05b0fc9bcb4a1fe42bb82 Mon Sep 17 00:00:00 2001
From: Urvashi Mohnani <umohnani@redhat.com>
Date: Thu, 2 Nov 2017 15:31:49 -0400
Subject: Add 'kpod import' command

Imports a tarball and saves it as a filesystem image

Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>

Closes: #12
Approved by: rhatdan
---
 docs/kpod-import.1.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 docs/kpod-import.1.md

(limited to 'docs')

diff --git a/docs/kpod-import.1.md b/docs/kpod-import.1.md
new file mode 100644
index 000000000..cfcfb6fb2
--- /dev/null
+++ b/docs/kpod-import.1.md
@@ -0,0 +1,88 @@
+% kpod(1) kpod-import - Simple tool to import a tarball as an image
+% Urvashi Mohnani
+# kpod-import "1" "November 2017" "kpod"
+
+## NAME
+kpod-import - import a tarball and save it as a filesystem image
+
+## SYNOPSIS
+**kpod import**
+**TARBALL**
+[**--change**|**-c**]
+[**--message**|**-m**]
+[**--help**|**-h**]
+
+## DESCRIPTION
+**kpod import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz)
+and saves it as a filesystem image. Remote tarballs can be specified using a URL.
+Various image instructions can be configured with the **--change** flag and
+a commit message can be set using the **--message** flag.
+
+**kpod [GLOBAL OPTIONS]**
+
+**kpod import [GLOBAL OPTIONS]**
+
+**kpod import [OPTIONS] CONTAINER**
+
+## OPTIONS
+
+**--change, -c**
+Apply the following possible instructions to the created image:
+**CMD** | **ENTRYPOINT** | **ENV** | **EXPOSE** | **LABEL** | **STOPSIGNAL** | **USER** | **VOLUME** | **WORKDIR**
+Can be set multiple times
+
+**--message, -m**
+Set commit message for imported image
+
+## EXAMPLES
+
+```
+# kpod import --change CMD=/bin/bash --change ENTRYPOINT=/bin/sh --change LABEL=blue=image ctr.tar image-imported
+Getting image source signatures
+Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
+ 25.80 MB / 25.80 MB [======================================================] 0s
+Copying config sha256:c16a6d30f3782288ec4e7521c754acc29d37155629cb39149756f486dae2d4cd
+ 448 B / 448 B [============================================================] 0s
+Writing manifest to image destination
+Storing signatures
+```
+
+```
+# cat ctr.tar | kpod import --message "importing the ctr.tar tarball" - image-imported
+Getting image source signatures
+Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
+ 25.80 MB / 25.80 MB [======================================================] 0s
+Copying config sha256:af376cdda5c0ac1d9592bf56567253d203f8de6a8edf356c683a645d75221540
+ 376 B / 376 B [============================================================] 0s
+Writing manifest to image destination
+Storing signatures
+```
+
+```
+# cat ctr.tar | kpod import -
+Getting image source signatures
+Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
+ 25.80 MB / 25.80 MB [======================================================] 0s
+Copying config sha256:d61387b4d5edf65edee5353e2340783703074ffeaaac529cde97a8357eea7645
+ 378 B / 378 B [============================================================] 0s
+Writing manifest to image destination
+Storing signatures
+```
+
+```
+kpod import http://example.com/ctr.tar url-image
+Downloading from "http://example.com/ctr.tar"
+Getting image source signatures
+Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
+ 25.80 MB / 25.80 MB [======================================================] 0s
+Copying config sha256:5813fe8a3b18696089fd09957a12e88bda43dc1745b5240879ffffe93240d29a
+ 419 B / 419 B [============================================================] 0s
+Writing manifest to image destination
+Storing signatures
+```
+
+## SEE ALSO
+kpod(1), kpod-export(1), crio(8), crio.conf(5)
+
+## HISTORY
+November 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
-- 
cgit v1.2.3-54-g00ecf