docs: Add documentation about REGISTRY variable

Adds documentation describing how to use a custom docker registry with EVE's build system. Signed-off-by: Renê de Souza Pinto <[email protected]>
lf-edge · Feb 13, 2025 · 3d873e3 · 3d873e3
1 parent 5ba7074
commit 3d873e3
Showing 1 changed file with 65 additions and 0 deletions.
diff --git a/docs/BUILD.md b/docs/BUILD.md
@@ -955,3 +955,68 @@ The whole flow looks like this:
     * installs the target arch libraries from `cross-compile-libs`, which is based on `eve-alpine` for the `TARGETARCH`
     * sets `CROSS_COMPILE_ENV="${EVE_TARGET_ARCH}"-alpine-linux-musl-` environment variable to use later as cross-compile prefix
     * inherits from `build-cross-target-${TARGETARCH}`, which adjust the `EVE_TARGET_ARCH` environment variable and inherits from `build-cross` stage based on `eve-alpine`
+
+## Using a local container registry
+
+All containers built by the EVE project are available in the official [LF-Edge's Docker HUB](https://hub.docker.com/u/lfedge).
+However, developers might want to pull and/or push all containers to a local container registry for debugging and development purposes.
+EVE's build system allows to override the default docker registry through the `REGISTRY` variable. For example:
+
+1. Start docker registry at local port 5001 (to not clash with a running docker registry)
+
+```sh
+docker run -d -p 5001:5000 --name lcreg registry:2
+```
+
+1. Build EVE with the local registry URL
+
+```sh
+make REGISTRY="localhost:5001" pkgs eve
+```
+
+1. Push packages to the local registry
+
+```sh
+make REGISTRY="localhost:5001" LINUXKIT_PKG_TARGET=push pkgs eve
+```
+
+1. A list of packages pushed to the local registry can be retrieved with the following command:
+
+```sh
+curl -s http://localhost:5001/v2/_catalog? | jq
+```
+
+Output will be in JSON format, for instance:
+
+```json
+{
+  "repositories": [
+    "lfedge/eve",
+    "lfedge/eve-acrn",
+    "lfedge/eve-acrn-kernel",
+    "lfedge/eve-alpine",
+    "lfedge/eve-apparmor",
+    "lfedge/eve-bpftrace",
+    "lfedge/eve-bsp-imx",
+    "lfedge/eve-cross-compilers",
+    "lfedge/eve-gpt-tools",
+    "lfedge/eve-grub",
+    "lfedge/eve-ipxe",
+    "lfedge/eve-kvm-tools",
+    "lfedge/eve-measure-config",
+    "lfedge/eve-memory-monitor",
+    "lfedge/eve-mkconf",
+    "lfedge/eve-mkimage-raw-efi",
+    "lfedge/eve-newlog",
+    "lfedge/eve-optee-os",
+    "lfedge/eve-recovertpm",
+    "lfedge/eve-rngd",
+    "lfedge/eve-storage-init",
+    "lfedge/eve-u-boot",
+    "lfedge/eve-udev",
+    "lfedge/eve-uefi",
+    "lfedge/eve-watchdog",
+    "lfedge/eve-xen"
+  ]
+}
+```