From e12df5ddf8e2998f7de16fb0b5e468b7f1494112 Mon Sep 17 00:00:00 2001 From: MoeMahhouk Date: Tue, 10 Dec 2024 11:30:29 +0000 Subject: [PATCH] Add reference of the new READMEs in the root one --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5c9a192..b9f9197 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,21 @@ setup a Yocto Project build environment for you! * **default.xml** - External releasable components. Used for release builds. +## Build Profiles + +This repository supports multiple build profiles, each tailored for specific use cases: + +* **tdx-base**: Minimal confidential computing image with TPM2 and UEFI Secure Boot support. + See [tdx-base/README.md](config_files/tdx-base/README.md) for details. + +* **tdx-bob**: Specialized image for running searcher nodes with podman support and searcher-specific configurations. + See [tdx-bob/README.md](config_files/tdx-bob/README.md) for details. + +* **tdx-rbuilder**: Comprehensive environment for running Ethereum validators and builders, including reth and lighthouse clients. + See [tdx-rbuilder/README.md](config_files/tdx-rbuilder/README.md) for details. + +Each profile's configuration and setup scripts are maintained in the `config_files/` directory. See the profile-specific READMEs for detailed information about features, requirements, and build configurations. + ## Reproducing image measurements **Make sure you are checked out on the correct commit (in this repo).** @@ -165,9 +180,9 @@ $ git clone https://github.com/flashbots/yocto-manifests.git ``` 2. adjust the yocto build configuration in [env_files](https://github.com/flashbots/yocto-manifests/tree/main/env_files) for the target image you want to build 3. make the desired image using, these are the current options: - - image-base: builds a basic tdx-image and outputs the image artifacts in */reproducile-build/artifacts-base* - - image-bob: builds the image for the BOB project with the searcher embedded ss-key and podman support and outputs the image artifacts in */reproducile-build/artifacts-bob* - - image-rbuilder: builds the image for with rbuilder/reth/lighthouse and outputs the image artifacts in */reproducile-build/artifacts-rbuilder* + - image-base: builds a basic tdx-image and outputs the image artifacts in */reproducible-build/artifacts-base* (see [tdx-base profile](config_files/tdx-base/README.md)) + - image-bob: builds the image for the BOB project with the searcher embedded ss-key and podman support and outputs the image artifacts in */reproducible-build/artifacts-bob* (see [tdx-bob profile](config_files/tdx-bob/README.md)) + - image-rbuilder: builds the image for with rbuilder/reth/lighthouse and outputs the image artifacts in */reproducible-build/artifacts-rbuilder* (see [tdx-rbuilder profile](config_files/tdx-rbuilder/README.md)) ``` $ make image- ```