xref: /OK3568_Linux_fs/buildroot/fs/oci/Config.in (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI
2*4882a593Smuzhiyun	bool "oci image"
3*4882a593Smuzhiyun	help
4*4882a593Smuzhiyun	  Build an OCI (Open Container Initiative) image.
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun	  By default, the image is generated in a directory called
7*4882a593Smuzhiyun	  rootfs-oci:
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun	  $ cd output/images
10*4882a593Smuzhiyun	  $ ls rootfs-oci/
11*4882a593Smuzhiyun	  blobs  index.json  oci-layout
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun	  You can push the image to a registry. Example using skopeo:
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun	  $ skopeo copy --dest-creds <user>:<pass> \
16*4882a593Smuzhiyun	           oci:rootfs-oci:<tag> docker://<user>/<image>[:tag]
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun	  And pull/run it with docker:
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun	  $ docker run -it <user>/<image>[:tag]
21*4882a593Smuzhiyun
22*4882a593Smuzhiyunif BR2_TARGET_ROOTFS_OCI
23*4882a593Smuzhiyun
24*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_AUTHOR
25*4882a593Smuzhiyun	string "author name and/or email address"
26*4882a593Smuzhiyun	default "Buildroot"
27*4882a593Smuzhiyun	help
28*4882a593Smuzhiyun	  Name and/or email address of the person which created the
29*4882a593Smuzhiyun	  image.
30*4882a593Smuzhiyun
31*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_TAG
32*4882a593Smuzhiyun	string "image tag"
33*4882a593Smuzhiyun	default "latest"
34*4882a593Smuzhiyun	help
35*4882a593Smuzhiyun	  Tag to be used in the container image. If empty, 'latest' will
36*4882a593Smuzhiyun	  be used by default.
37*4882a593Smuzhiyun
38*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_ENTRYPOINT
39*4882a593Smuzhiyun	string "entrypoint"
40*4882a593Smuzhiyun	default "sh"
41*4882a593Smuzhiyun	help
42*4882a593Smuzhiyun	  Command to execute when the container starts.
43*4882a593Smuzhiyun
44*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_ENTRYPOINT_ARGS
45*4882a593Smuzhiyun	string "entrypoint arguments"
46*4882a593Smuzhiyun	help
47*4882a593Smuzhiyun	  Default arguments to the entrypoint of the container.
48*4882a593Smuzhiyun
49*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_WORKDIR
50*4882a593Smuzhiyun	string "working directory"
51*4882a593Smuzhiyun	help
52*4882a593Smuzhiyun	  Working directory of the entrypoint process in the
53*4882a593Smuzhiyun	  container.
54*4882a593Smuzhiyun
55*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_UID
56*4882a593Smuzhiyun	string "username or UID"
57*4882a593Smuzhiyun	default "0"
58*4882a593Smuzhiyun	help
59*4882a593Smuzhiyun	  The username or UID of user the process run as.
60*4882a593Smuzhiyun
61*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_ENV_VARS
62*4882a593Smuzhiyun	string "environment variables"
63*4882a593Smuzhiyun	help
64*4882a593Smuzhiyun	  Default environment variables for the container.
65*4882a593Smuzhiyun	  Space-separated list of variable=value assignments.
66*4882a593Smuzhiyun
67*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_PORTS
68*4882a593Smuzhiyun	string "ports"
69*4882a593Smuzhiyun	help
70*4882a593Smuzhiyun	  Default set of ports to expose from a container running
71*4882a593Smuzhiyun	  this image as a space-separted list of ports in the following
72*4882a593Smuzhiyun	  format:
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun	  <port>/tcp, <port>/udp, <port> (same as <port>/tcp).
75*4882a593Smuzhiyun
76*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_LABELS
77*4882a593Smuzhiyun	string "labels"
78*4882a593Smuzhiyun	help
79*4882a593Smuzhiyun	  Metadata in the format KEY=VALUE for the container compliant
80*4882a593Smuzhiyun	  with OCI annotation rules. If KEY starts with a dot, it will
81*4882a593Smuzhiyun	  be prefixed with "org.opencontainers.image"
82*4882a593Smuzhiyun	  (e.g. .url -> org.opencontainers.image.url).
83*4882a593Smuzhiyun
84*4882a593Smuzhiyunconfig BR2_TARGET_ROOTFS_OCI_ARCHIVE
85*4882a593Smuzhiyun	bool "pack oci image into a tar archive"
86*4882a593Smuzhiyun	help
87*4882a593Smuzhiyun	  Select whether the image should be packed into a TAR archive.
88*4882a593Smuzhiyun
89*4882a593Smuzhiyunendif
90