From e60ff1d6c39c27f6d1332faeb79b4c4bcdc7a79c Mon Sep 17 00:00:00 2001 From: Antonio Murdaca Date: Fri, 22 Jul 2016 16:40:53 +0200 Subject: [PATCH] cmd/oci-image-tool: add manuals Signed-off-by: Antonio Murdaca --- .../oci-image-tool-create-runtime-bundle.1.md | 40 +++++++++++++++ .../man/oci-image-tool-unpack.1.md | 50 +++++++++++++++++++ .../man/oci-image-tool-validate.1.md | 35 +++++++++++++ cmd/oci-image-tool/man/oci-image-tool.1.md | 37 ++++++++++++++ 4 files changed, 162 insertions(+) create mode 100644 cmd/oci-image-tool/man/oci-image-tool-create-runtime-bundle.1.md create mode 100644 cmd/oci-image-tool/man/oci-image-tool-unpack.1.md create mode 100644 cmd/oci-image-tool/man/oci-image-tool-validate.1.md create mode 100644 cmd/oci-image-tool/man/oci-image-tool.1.md diff --git a/cmd/oci-image-tool/man/oci-image-tool-create-runtime-bundle.1.md b/cmd/oci-image-tool/man/oci-image-tool-create-runtime-bundle.1.md new file mode 100644 index 000000000..7cdeaa127 --- /dev/null +++ b/cmd/oci-image-tool/man/oci-image-tool-create-runtime-bundle.1.md @@ -0,0 +1,40 @@ +% OCI(1) OCI-IMAGE-TOOL User Manuals +% OCI Community +% JULY 2016 +# NAME +oci-image-tool-create-runtime-bundle \- Create an OCI image runtime bundle + +# SYNOPSIS +**oci-image-tool create-runtime-bundle** [src] [dest] [flags] + +# DESCRIPTION +`oci-image-tool create-runtime-bundle` generates an [OCI bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md) from an [OCI image layout](https://github.com/opencontainers/image-spec/blob/master/image-layout.md). + + +# OPTIONS +**--help** + Print usage statement + +**--ref** + The ref pointing to the manifest of the OCI image. This must be present in the "refs" subdirectory of the image. (default "v1.0") + +**--rootfs** + A directory representing the root filesystem of the container in the OCI runtime bundle. It is strongly recommended to keep the default value. (default "rootfs") + +**--type** + Type of the file to unpack. If unset, oci-image-tool will try to auto-detect the type. One of "imageLayout,image" + +# EXAMPLES +``` +$ skopeo copy docker://busybox oci:busybox-oci +$ mkdir busybox-bundle +$ ci-image-tool create-runtime-bundle --ref latest busybox-oci busybox-bundle +$ cd busybox-bundle && sudo runc start busybox +[...] +``` + +# SEE ALSO +**oci-image-tool(1)**, **runc**(1), **skopeo**(1) + +# HISTORY +July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com) diff --git a/cmd/oci-image-tool/man/oci-image-tool-unpack.1.md b/cmd/oci-image-tool/man/oci-image-tool-unpack.1.md new file mode 100644 index 000000000..b73e21829 --- /dev/null +++ b/cmd/oci-image-tool/man/oci-image-tool-unpack.1.md @@ -0,0 +1,50 @@ +% OCI(1) OCI-IMAGE-TOOL User Manuals +% OCI Community +% JULY 2016 +# NAME +oci-image-tool-unpack \- Unpack an image or image source layout + +# SYNOPSIS +**oci-image-tool unpack** [src] [dest] [flags] + +# DESCRIPTION +`oci-image-tool unpack` unpacks a given OCI image into a directory suitable to be used with `runc`. + + +# OPTIONS +**--help** + Print usage statement + +**--ref** + The ref pointing to the manifest to be unpacked. This must be present in the "refs" subdirectory of the image. (default "v1.0") + +**--type** + Type of the file to unpack. If unset, oci-image-tool will try to auto-detect the type. One of "imageLayout,image" + +# EXAMPLES +``` +$ skopeo copy docker://busybox oci:busybox-oci +$ mkdir busybox-bundle +$ oci-image-tool unpack --ref latest busybox-oci busybox-bundle +tree busybox-bundle +busybox-bundle +├── bin +│   ├── [ +│   ├── [[ +│   ├── acpid +│   ├── addgroup +│   ├── add-shell +│   ├── adduser +│   ├── adjtimex +│   ├── ar +│   ├── arp +│   ├── arping +│   ├── ash +[...] +``` + +# SEE ALSO +**oci-image-tool(1)**, **skopeo**(1) + +# HISTORY +July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com) diff --git a/cmd/oci-image-tool/man/oci-image-tool-validate.1.md b/cmd/oci-image-tool/man/oci-image-tool-validate.1.md new file mode 100644 index 000000000..117ef9b2d --- /dev/null +++ b/cmd/oci-image-tool/man/oci-image-tool-validate.1.md @@ -0,0 +1,35 @@ +% OCI(1) OCI-IMAGE-TOOL User Manuals +% OCI Community +% JULY 2016 +# NAME +oci-image-tool-validate \- Validate one or more image files + +# SYNOPSIS +**oci-image-tool validate** FILE... [flags] + +# DESCRIPTION +`oci-image-tool validate` validates the given file(s) against the OCI image specification. + + +# OPTIONS +**--help** + Print usage statement + +**--ref** + The ref pointing to the manifest to be validated. This must be present in the "refs" subdirectory of the image. Only applicable if type is image or imageLayout. (default "v1.0") + +**--type** + Type of the file to validate. If unset, oci-image-tool will try to auto-detect the type. One of "imageLayout,image,manifest,manifestList,config" + +# EXAMPLES +``` +$ skopeo copy docker://busybox oci:busybox-oci +$ oci-image-tool validate --type imageLayout --ref latest busybox-oci +busybox-oci: OK +``` + +# SEE ALSO +**oci-image-tool(1)**, **skopeo**(1) + +# HISTORY +July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com) diff --git a/cmd/oci-image-tool/man/oci-image-tool.1.md b/cmd/oci-image-tool/man/oci-image-tool.1.md new file mode 100644 index 000000000..89e88ac76 --- /dev/null +++ b/cmd/oci-image-tool/man/oci-image-tool.1.md @@ -0,0 +1,37 @@ +% OCI(1) OCI-IMAGE-TOOL User Manuals +% OCI Community +% JULY 2016 +# NAME +oci-image-tool \- OCI (Open Container Initiative) image tool + +# SYNOPSIS +**oci-image-tool** [OPTIONS] COMMAND [arg...] + +**oci-image-tool** [--help] + +# DESCRIPTION +`oci-image-tool` is a collection of tools for working with the [OCI image specification](https://github.com/opencontainers/image-spec). + + +# OPTIONS +**--help** + Print usage statement + +# COMMANDS +**create-runtime-bundle** + Create an OCI image runtime bundle + See **oci-image-tools-create-runtime-bundle(1)** for full documentation on the **create-runtime-bundle** command. + +**unpack** + Unpack an image or image source layout + See **oci-image-tools-unpack(1)** for full documentation on the **unpack** command. + +**validate** + Validate one or more image files + See **oci-image-tool-validate(1)** for full documentation on the **validate** command. + +# SEE ALSO +**oci-image-tool-create-runtime-bundle**, **ocitools-unpack**(1), **ocitools-validate**(1) + +# HISTORY +July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)