Skip to content

Commit 003e33b

Browse files
zhouhaoMa Shimiao
authored andcommitted
Fix information
Signed-off-by: zhouhao <[email protected]>
1 parent bb7b937 commit 003e33b

File tree

3 files changed

+141
-0
lines changed

3 files changed

+141
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
% OCI(1) OCI-CREATE-RUNTIME-BUNDLE User Manuals
2+
% OCI Community
3+
% JULY 2016
4+
# NAME
5+
oci-create-runtime-bundle \- Create an OCI runtime bundle
6+
7+
# SYNOPSIS
8+
**oci-create-runtime-bundle** [src] [dest] [flags]
9+
**oci-create-runtime-bundle** [--help|-v|--version]
10+
11+
# DESCRIPTION
12+
`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.
13+
14+
Also translates the referenced config from application/vnd.oci.image.config.v1+json to a
15+
runtime-spec-compatible `dest/config.json`.
16+
17+
# FLAGS
18+
**--help**
19+
Print usage statement
20+
21+
**--ref**=""
22+
The ref pointing to the manifest of the OCI image. This must be present in the "refs" subdirectory of the image. (default "v1.0")
23+
24+
**--rootfs**=""
25+
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")
26+
27+
**--type**=""
28+
Type of the file to unpack. If unset, oci-create-runtime-bundle will try to auto-detect the type. One of "imageLayout,image"
29+
30+
**-v**, **--version**
31+
Print version information and exit.
32+
33+
# EXAMPLES
34+
```
35+
$ skopeo copy docker://busybox oci:busybox-oci
36+
$ mkdir busybox-bundle
37+
$ oci-create-runtime-bundle --ref latest busybox-oci busybox-bundle
38+
$ cd busybox-bundle && sudo runc run busybox
39+
[...]
40+
```
41+
42+
# SEE ALSO
43+
**runc**(1), **skopeo**(1)
44+
45+
# HISTORY
46+
Sept 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
% OCI(1) OCI-IMAGE-VALIDATE User Manuals
2+
% OCI Community
3+
% JULY 2016
4+
# NAME
5+
oci-image-validate \- Validate one or more image files
6+
7+
# SYNOPSIS
8+
**oci-image-validate** FILE... [flags]
9+
**oci-image-validate** [--help|-v|--version]
10+
11+
# DESCRIPTION
12+
`oci-image-validate` validates the given file(s) against the OCI image specification.
13+
14+
15+
# FLAGS
16+
**--help**
17+
Print usage statement
18+
19+
**--ref**=[]
20+
The reference to validate (should point to a manifest).
21+
Can be specified multiple times to validate multiple references.
22+
`NAME` must be present in the `refs` subdirectory of the image.
23+
Only applicable if type is image or imageLayout.
24+
25+
**--type**=""
26+
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"
27+
28+
**-v**, **--version**
29+
Print version information and exit.
30+
31+
# EXAMPLES
32+
```
33+
$ skopeo copy docker://busybox oci:busybox-oci
34+
$ oci-image-validate --type imageLayout --ref latest busybox-oci
35+
busybox-oci: OK
36+
```
37+
38+
# SEE ALSO
39+
**skopeo**(1)
40+
41+
# HISTORY
42+
Sept 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

cmd/oci-unpack/oci-unpack.1.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
% OCI(1) OCI-UNPACK User Manuals
2+
% OCI Community
3+
% JULY 2016
4+
# NAME
5+
oci-unpack \- Unpack an image or image source layout
6+
7+
# SYNOPSIS
8+
**oci-unpack** [src] [dest] [flags]
9+
**oci-unpack** [--help|-v|--version]
10+
11+
# DESCRIPTION
12+
`oci-unpack` validates an application/vnd.oci.image.manifest.v1+json and unpacks its layered filesystem to `dest`.
13+
14+
# FLAGS
15+
**--help**
16+
Print usage statement
17+
18+
**--ref**=""
19+
The ref pointing to the manifest to be unpacked. This must be present in the "refs" subdirectory of the image. (default "v1.0")
20+
21+
**--type**=""
22+
Type of the file to unpack. If unset, oci-unpack will try to auto-detect the type. One of "imageLayout,image"
23+
24+
**-v**, **--version**
25+
Print version information and exit.
26+
27+
# EXAMPLES
28+
```
29+
$ skopeo copy docker://busybox oci:busybox-oci
30+
$ mkdir busybox-bundle
31+
$ oci-unpack --ref latest busybox-oci busybox-bundle
32+
$ tree busybox-bundle
33+
busybox-bundle
34+
├── bin
35+
│   ├── [
36+
│   ├── [[
37+
│   ├── acpid
38+
│   ├── addgroup
39+
│   ├── add-shell
40+
│   ├── adduser
41+
│   ├── adjtimex
42+
│   ├── ar
43+
│   ├── arp
44+
│   ├── arping
45+
│   ├── ash
46+
[...]
47+
```
48+
49+
# SEE ALSO
50+
**skopeo**(1)
51+
52+
# HISTORY
53+
Sept 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

0 commit comments

Comments
 (0)