Skip to content

Cherry-pick PR 716 and 718 #731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 27, 2025
Merged

Cherry-pick PR 716 and 718 #731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54b1d91
Added a note about the sha256 creation process (#718)
e-minguez Jun 27, 2025
27bd339
added a note as per GH issue 580 (#716)
ranjinimn Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions asciidoc/quickstart/eib.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ endif::[]

Edge Image Builder (EIB) is a tool that streamlines the process of generating Customized, Ready-to-Boot (CRB) disk images for bootstrapping machines, even in fully air-gapped scenarios. EIB is used to create deployment images for use in all three of the SUSE Edge deployment footprints, as it's flexible enough to offer the smallest customizations, e.g. adding a user or setting the timezone, through offering a comprehensively configured image that sets up, for example, complex networking configurations, deploys multi-node Kubernetes clusters, deploys customer workloads, and registers to the centralized management platform via Rancher/Elemental and SUSE Manager. EIB runs as in a container image, making it incredibly portable across platforms and ensuring that all of the required dependencies are self-contained, having a very minimal impact on the installed packages of the system that's being used to operate the tool.

[NOTE]
====
For multi-node scenarios, EIB automatically deploys MetalLB and Endpoint Copier Operator in order for hosts provisioned using the same built image to automatically join a Kubernetes cluster.
====

For more information, read the <<components-eib,Edge Image Builder Introduction>>.

[WARNING]
Expand Down
13 changes: 13 additions & 0 deletions asciidoc/quickstart/metal3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,19 @@ This creates the output image file named `SLE-Micro-eib-output.raw`, based on th
The output image must then be made available via a webserver, either the media-server container enabled via the <<metal3-media-server,Metal^3^ chart>>
or some other locally accessible server. In the examples below, we refer to this server as `imagecache.local:8080`

[NOTE]
====
When deploying EIB images to downstream clusters, it is required also to include the sha256 sum of the image on the `Metal3MachineTemplate` object.
It can be generated as:

[,shell,subs="attributes"]
----
sha256sum &lt;image_file&gt; &gt; &lt;image_file&gt;.sha256
# On this example:
sha256sum SLE-Micro-eib-output.raw &gt; SLE-Micro-eib-output.raw.sha256
----
====

=== Adding BareMetalHost inventory

Registering bare-metal servers for automated deployment requires creating two resources: a Secret storing
Expand Down