buildroot/fs/oci/Config.in

107 lines
2.9 KiB
Plaintext

config BR2_TARGET_ROOTFS_OCI
bool "oci image"
depends on BR2_PACKAGE_HOST_GO_TARGET_ARCH_SUPPORTS
help
Build an OCI (Open Container Initiative) image.
By default, the image is generated in a directory called
rootfs-oci:
$ cd output/images
$ ls rootfs-oci/
blobs index.json oci-layout
You can push the image to a registry. Example using skopeo:
$ skopeo copy --dest-creds <user>:<pass> \
oci:rootfs-oci:<tag> docker://<user>/<image>[:tag]
And pull/run it with docker:
$ docker run -it <user>/<image>[:tag]
if BR2_TARGET_ROOTFS_OCI
config BR2_TARGET_ROOTFS_OCI_AUTHOR
string "author name and/or email address"
default "Buildroot"
help
Name and/or email address of the person which created the
image.
config BR2_TARGET_ROOTFS_OCI_TAG
string "image tag"
default "latest"
help
Tag to be used in the container image. If empty, 'latest' will
be used by default.
config BR2_TARGET_ROOTFS_OCI_ENTRYPOINT
string "entrypoint"
default "sh"
help
Command to execute when the container starts.
Spaces must be quoted or escaped, like for a shell string:
/usr/bin/env sh -c
/bin/my-init --some-option "1 2 3 4" some\ arg --
See the Docker documentation on how entrypoint and command
interact together:
https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact
config BR2_TARGET_ROOTFS_OCI_CMD
string "command (or entrypoint arguments)"
help
Default command, or entrypoint arguments, of the container.
Spaces must be quoted or escaped, like for a shell string:
"your shell scriptlet"
/usr/bin/env sh
See the Docker documentation on how entrypoint and command
interact together:
https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact
config BR2_TARGET_ROOTFS_OCI_WORKDIR
string "working directory"
help
Working directory of the entrypoint process in the
container.
config BR2_TARGET_ROOTFS_OCI_UID
string "username or UID"
default "0"
help
The username or UID of user the process run as.
config BR2_TARGET_ROOTFS_OCI_ENV_VARS
string "environment variables"
help
Default environment variables for the container.
Space-separated list of variable=value assignments.
config BR2_TARGET_ROOTFS_OCI_PORTS
string "ports"
help
Default set of ports to expose from a container running
this image as a space-separted list of ports in the following
format:
<port>/tcp, <port>/udp, <port> (same as <port>/tcp).
config BR2_TARGET_ROOTFS_OCI_LABELS
string "labels"
help
Metadata in the format KEY=VALUE for the container compliant
with OCI annotation rules. If KEY starts with a dot, it will
be prefixed with "org.opencontainers.image"
(e.g. .url -> org.opencontainers.image.url).
config BR2_TARGET_ROOTFS_OCI_ARCHIVE
bool "pack oci image into a tar archive"
help
Select whether the image should be packed into a TAR archive.
endif