Skip to content

Commit

Permalink
Add reference of the new READMEs in the root one
Browse files Browse the repository at this point in the history
  • Loading branch information
MoeMahhouk committed Dec 10, 2024
1 parent 58f5736 commit e12df5d
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).**
Expand Down Expand Up @@ -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-<target-name>
```

0 comments on commit e12df5d

Please sign in to comment.