Skip to content

Commit

Permalink
README: document cqfd flavors and distros
Browse files Browse the repository at this point in the history
Detail the cqfd flavors and the distros that could be used.

Issue: #6860
Change-Id: I67336c364614d084c2a98d617347bf31e29f5b0b
Signed-off-by: Eloi Bail <[email protected]>
  • Loading branch information
ebail authored and insatomcat committed Jan 20, 2022
1 parent c2b766a commit c5a04cb
Showing 1 changed file with 47 additions and 6 deletions.
53 changes: 47 additions & 6 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,41 @@ created on your machine, it will become persistent. Further calls to `cqfd init`
will do nothing, unless the container definition (`.cqfd/docker/Dockerfile`) has
changed in the source tree.

You can then start the build using:

$ cqfd run
cqfd provides different flavors that allow to call build.sh with certain image, distro and machine parameters.
To list the available flavors, run:

$ cqfd flavors

Here is a description of flavors:

* all: all flavors
* flash_bios: bios image to flash a server disk
* flash_efi: efi image to flash a server disk
* flash_pxe: pxe image to flash a server disk
* guest_efi: efi guest image (VM)
* guest_efi_test: similar to guest_efi with additionnal test packages
* guest_efi_dbg: similar to guest_efi with debug tools
* host_bios: bios host image (including security, clustering and readonly features)
* host_bios_dbg: similar to host_bios with debug tools
* host_bios_minimal: similar to host_bios without security, clustering and readonly features
* host_bios_no_iommu: similar to host_bios without IOMMU enabled (IOMMU leads)
* host_bios_test: similar to host_bios with additionnal test packages
* host_bios_test_no_iommu: similar to host_bios_no_iommu with additionnal test packages
* host_efi: efi host image (including security, clustering and readonly features)
* host_efi_dbg: similar to host_efi with debug tools
* host_efi_test: similar to host_efi with additionnal test packages
* host_efi_swu: efi host update image (SwUpdate)
* monitor_bios: bios monitor image (used to monitor the cluster)
* monitor_efi: efi monitor image (used to monitor the cluster)
* monitor_efi_swu: efi monitor update image (SwUpdate)

To build on of this flavor, run:

$ cqfd -b <flavor>

Note:
* bash completion works with `-b` parameter
* detail command used per flavor is described in `.cqfdrc` file

== Building the firmware manually

Expand All @@ -239,15 +271,15 @@ The following packages need to be installed:

The build is started by running the following command:

$ ./build.sh -i seapath-host-efi-image -m boardname
$ ./build.sh -i seapath-host-efi-image -m boardname --distro distroname

You can also pass custom BitBake commands using the `--` separator:

$ ./build.sh -i seapath-host-efi-image -m boardname -- bitbake -c clean package_name
$ ./build.sh -i seapath-host-efi-image -m boardname --distro distroname -- bitbake -c clean package_name

Images can be produced for either UEFI or BIOS compatible firmwares.

Yoou can find below the Yocto images list (with [FW]=bios or [FW]=efi):
You can find below the Yocto images list (with [FW]=bios or [FW]=efi):

* Host images
** seapath-host-[FW]-image: production image
Expand All @@ -269,6 +301,15 @@ during a PXE boot.
* Observer images
** seapath-monitor-[FW]: production image for an observer (needed for clustering quorum establishment)

Different distros can be used:

* seapath-flash: distro used for flash images
* seapath-guest: distro used for guest images
* seapath-host: distro used for host images with security, readonly and clustering features
* seapath-host-cluster-minimal: distro used for host images with clustering features
* seapath-host-minimal: distro used for host images without security, readonly and clustering features
* seapath-host-sb: distro used for host images without security, readonly, clustering and secureboot features

== Building an SDK Installer

You can create an SDK matching your system's configuration using with the
Expand Down

0 comments on commit c5a04cb

Please sign in to comment.