Skip to content

Commit 8633a64

Browse files
hardyse-minguez
andauthored
Added explicit notes for Kiwi process first (suse-edge#677)
Co-authored-by: e-minguez <[email protected]>
1 parent 8303617 commit 8633a64

File tree

4 files changed

+15
-8
lines changed

4 files changed

+15
-8
lines changed

asciidoc/edge-book/releasenotes.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,11 @@ Summary: SUSE Edge 3.3.0 is the first release in the SUSE Edge 3.3 release strea
5959

6060
== Known Issues
6161

62+
[WARNING]
63+
====
64+
If deploying new clusters, please follow <<guides-kiwi-builder-images>> to build fresh images first as this is now the first step required to create clusters for both {x86-64} and {aarch64} architectures as well as management and downstream clusters.
65+
====
66+
6267
* When using `toolbox` in SUSE Linux Micro 6.1, the default container image does not contain some tools which were included in the previous 5.5 version. The workaround is to configure toolbox to use the previous `suse/sle-micro/5.5/toolbox` container image, see `toolbox --help` for options to configure the image.
6368
* In some cases rolling upgrades via CAPI can result in Machines stuck in Deleting state, this will be resolved via a future update https://github.com/rancher/cluster-api-provider-rke2/issues/655[Upstream RKE2 provider issue 655]
6469
* In some cases when using a management cluster that has been upgraded from Edge 3.2, downstream rolling upgrades via CAPI can result in Machines stuck in Deleting state, this will be resolved via a future update https://github.com/rancher/cluster-api-provider-rke2/issues/661[Upstream RKE2 provider issue 661]

asciidoc/quickstart/eib.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Older versions, such as SUSE Linux Enterprise Micro 5.5, or 6.0 are not supporte
2525

2626
* An {x86-64} physical host (or virtual machine) running SLES 15 SP6, openSUSE Leap 15.6, or openSUSE Tumbleweed.
2727
* An available container runtime (e.g. Podman)
28-
* A downloaded copy of the latest SUSE Linux Micro {version-sl-micro} SelfInstall ISO image found https://www.suse.com/download/sle-micro/[here].
28+
* A SUSE Linux Micro {version-sl-micro} SelfInstall ISO image created using the <<guides-kiwi-builder-images,Kiwi Builder procedure>>
2929

3030
NOTE: Other operating systems may function so long as a compatible container runtime is available, but testing on other platforms has not been extensive. The documentation focuses on Podman, but the same functionality should be able to be achieved with Docker.
3131

@@ -48,11 +48,11 @@ export CONFIG_DIR=$HOME/eib
4848
mkdir -p $CONFIG_DIR/base-images
4949
----
5050

51-
In the previous step we created a "base-images" directory that will host the SUSE Linux Micro {version-operatingsystem} input image, let's ensure that the downloaded image is copied over to the configuration directory:
51+
In the previous step we created a "base-images" directory that will host the SUSE Linux Micro {version-operatingsystem} input image, let's ensure that the image is copied over to the configuration directory:
5252

5353
[,shell,subs="attributes"]
5454
----
55-
cp /path/to/downloads/{micro-base-image-iso} $CONFIG_DIR/base-images/slemicro.iso
55+
cp /path/to/{micro-base-image-iso} $CONFIG_DIR/base-images/slemicro.iso
5656
----
5757

5858

asciidoc/quickstart/elemental.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,19 +219,19 @@ This URL is used in the next step.
219219

220220
== Build the image [[build-installation-media]]
221221

222-
While the current version of Elemental has a way to build its own installation media, in SUSE Edge {version-edge} we do this with the Edge Image Builder instead, so the resulting system is built with https://www.suse.com/products/micro/[SUSE Linux Micro] as the base Operating System.
222+
While the current version of Elemental has a way to build its own installation media, in SUSE Edge {version-edge} we do this with Kiwi and Edge Image Builder instead, so the resulting system is built with https://www.suse.com/products/micro/[SUSE Linux Micro] as the base Operating System.
223223

224224
[TIP]
225225
====
226-
For more details on the Edge Image Builder, check out the <<quickstart-eib,Getting Started Guide for it>> and also the <<components-eib,Component Documentation>>.
226+
For more details on Kiwi, please follow <<guides-kiwi-builder-images,Kiwi Image Builder process>> to build fresh images first and for Edge Image Builder, check out the <<quickstart-eib,Edge Image Builder Getting Started Guide>> and also the <<components-eib,Component Documentation>>.
227227
====
228228

229-
From a Linux system with Podman installed, create the directories and place the base image:
229+
From a Linux system with Podman installed, create the directories and place the base image being built by Kiwi:
230230

231231
[,bash]
232232
----
233233
mkdir -p $ELEM/eib_quickstart/base-images
234-
cp /path/to/downloads/{micro-base-image-iso} $ELEM/eib_quickstart/base-images/
234+
cp /path/to/{micro-base-image-iso} $ELEM/eib_quickstart/base-images/
235235
mkdir -p $ELEM/eib_quickstart/elemental
236236
----
237237

asciidoc/quickstart/metal3.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,12 +181,14 @@ After some time, the controller pods should be running in the `capi-system`, `ca
181181

182182
=== Prepare downstream cluster image
183183

184-
<<components-eib, Edge Image Builder>> is used to prepare a modified SLEMicro base image which is provisioned on downstream cluster hosts.
184+
<<guides-kiwi-builder-images, Kiwi>> and <<components-eib, Edge Image Builder>> are used to prepare a modified SLEMicro base image which is provisioned on downstream cluster hosts.
185185

186186
In this guide, we cover the minimal configuration necessary to deploy the downstream cluster.
187187

188188
==== Image configuration
189189

190+
NOTE: Please follow <<guides-kiwi-builder-images>> first to build a fresh image as the first step required to create clusters.
191+
190192
When running Edge Image Builder, a directory is mounted from the host, so it is necessary to create a directory structure to store the configuration files used to define the target image.
191193

192194
* `downstream-cluster-config.yaml` is the image definition file, see <<quickstart-eib>> for more details.

0 commit comments

Comments
 (0)