From 827514ab3b5c38fb1286ea6237a36127942a35b7 Mon Sep 17 00:00:00 2001 From: Zhou Hao Date: Fri, 27 Jul 2018 11:20:22 +0800 Subject: [PATCH 1/2] cmd: Delete additional files Signed-off-by: Zhou Hao --- .../oci-create-runtime-bundle.1.md | 46 ---------------- .../oci-image-validate.1.md | 42 --------------- cmd/oci-unpack/oci-unpack.1.md | 53 ------------------- 3 files changed, 141 deletions(-) delete mode 100644 cmd/oci-create-runtime-bundle/oci-create-runtime-bundle.1.md delete mode 100644 cmd/oci-image-validate/oci-image-validate.1.md delete mode 100644 cmd/oci-unpack/oci-unpack.1.md diff --git a/cmd/oci-create-runtime-bundle/oci-create-runtime-bundle.1.md b/cmd/oci-create-runtime-bundle/oci-create-runtime-bundle.1.md deleted file mode 100644 index 0c25fd9..0000000 --- a/cmd/oci-create-runtime-bundle/oci-create-runtime-bundle.1.md +++ /dev/null @@ -1,46 +0,0 @@ -% OCI(1) OCI-CREATE-RUNTIME-BUNDLE User Manuals -% OCI Community -% JULY 2016 -# NAME -oci-create-runtime-bundle \- Create an OCI runtime bundle - -# SYNOPSIS -**oci-create-runtime-bundle** [src] [dest] [flags] -**oci-create-runtime-bundle** [--help|-v|--version] - -# DESCRIPTION -`oci-create-runtime-bundle` validates an application/vnd.oci.image.manifest.v1+json and unpacks its layered filesystem to `dest/rootfs`, although the target directory is configurable with `--rootfs`. See **oci-unpack**(1) for more details on this process. - -Also translates the referenced config from application/vnd.oci.image.config.v1+json to a -runtime-spec-compatible `dest/config.json`. - -# FLAGS -**--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-create-runtime-bundle will try to auto-detect the type. One of "imageLayout,image" - -**-v**, **--version** - Print version information and exit. - -# EXAMPLES -``` -$ skopeo copy docker://busybox oci:busybox-oci -$ mkdir busybox-bundle -$ oci-create-runtime-bundle --ref latest busybox-oci busybox-bundle -$ cd busybox-bundle && sudo runc run busybox -[...] -``` - -# SEE ALSO -**runc**(1), **skopeo**(1) - -# HISTORY -Sept 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com) diff --git a/cmd/oci-image-validate/oci-image-validate.1.md b/cmd/oci-image-validate/oci-image-validate.1.md deleted file mode 100644 index d9c93b6..0000000 --- a/cmd/oci-image-validate/oci-image-validate.1.md +++ /dev/null @@ -1,42 +0,0 @@ -% OCI(1) OCI-IMAGE-VALIDATE User Manuals -% OCI Community -% JULY 2016 -# NAME -oci-image-validate \- Validate one or more image files - -# SYNOPSIS -**oci-image-validate** FILE... [flags] -**oci-image-validate** [--help|-v|--version] - -# DESCRIPTION -`oci-image-validate` validates the given file(s) against the OCI image specification. - - -# FLAGS -**--help** - Print usage statement - -**--ref**=[] - The reference to validate (should point to a manifest). - Can be specified multiple times to validate multiple references. - `NAME` must be present in the `refs` subdirectory of the image. - Only applicable if type is image or imageLayout. - -**--type**="" - Type of the file to validate. If unset, oci-image-validate will try to auto-detect the type. One of "imageLayout,image,manifest,manifestList,config" - -**-v**, **--version** - Print version information and exit. - -# EXAMPLES -``` -$ skopeo copy docker://busybox oci:busybox-oci -$ oci-image-validate --type imageLayout --ref latest busybox-oci -busybox-oci: OK -``` - -# SEE ALSO -**skopeo**(1) - -# HISTORY -Sept 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com) diff --git a/cmd/oci-unpack/oci-unpack.1.md b/cmd/oci-unpack/oci-unpack.1.md deleted file mode 100644 index fcbbd92..0000000 --- a/cmd/oci-unpack/oci-unpack.1.md +++ /dev/null @@ -1,53 +0,0 @@ -% OCI(1) OCI-UNPACK User Manuals -% OCI Community -% JULY 2016 -# NAME -oci-unpack \- Unpack an image or image source layout - -# SYNOPSIS -**oci-unpack** [src] [dest] [flags] -**oci-unpack** [--help|-v|--version] - -# DESCRIPTION -`oci-unpack` validates an application/vnd.oci.image.manifest.v1+json and unpacks its layered filesystem to `dest`. - -# FLAGS -**--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-unpack will try to auto-detect the type. One of "imageLayout,image" - -**-v**, **--version** - Print version information and exit. - -# EXAMPLES -``` -$ skopeo copy docker://busybox oci:busybox-oci -$ mkdir busybox-bundle -$ oci-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 -**skopeo**(1) - -# HISTORY -Sept 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com) From e5adeb93e4fa9788957b9a024b3d303d705b865c Mon Sep 17 00:00:00 2001 From: Zhou Hao Date: Fri, 27 Jul 2018 11:28:50 +0800 Subject: [PATCH 2/2] README: Modify the wrong instance Signed-off-by: Zhou Hao --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3995646..508d53d 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ More information about `oci-image-tool-create` can be found in its [man page](./ ``` $ mkdir busybox-bundle -$ oci-image-tool create --ref latest busybox-oci busybox-bundle +$ oci-image-tool create --ref name=latest busybox-oci busybox-bundle $ cd busybox-bundle && sudo runc run busybox ``` @@ -46,7 +46,7 @@ $ cd busybox-bundle && sudo runc run busybox More information about `oci-image-tool-validate` can be found in its [man page](./man/oci-image-tool-validate.1.md) ``` -$ oci-image-tool validate --type imageLayout --ref latest busybox-oci +$ oci-image-tool validate --type imageLayout --ref name=latest busybox-oci busybox-oci: OK ``` @@ -56,7 +56,7 @@ More information about `oci-image-tool-unpack` can be found in its [man page](./ ``` $ mkdir busybox-bundle -$ oci-image-tool unpack --ref latest busybox-oci busybox-bundle +$ oci-image-tool unpack --ref name=latest busybox-oci busybox-bundle $ tree busybox-bundle busybox-bundle ├── bin