Skip to content

Commit 48d7952

Browse files
authored
Update EIB quickstart (#444)
* Update EIB quickstart Signed-off-by: Atanas Dinov <[email protected]> * Update EIB docs references Signed-off-by: Atanas Dinov <[email protected]> --------- Signed-off-by: Atanas Dinov <[email protected]>
1 parent 5b6e937 commit 48d7952

File tree

3 files changed

+33
-29
lines changed

3 files changed

+33
-29
lines changed

asciidoc/components/longhorn.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ EOF
296296
[NOTE]
297297
====
298298
Customizing any of the Helm chart values is possible via a separate file provided under `helm.charts[].valuesFile`.
299-
Refer to the https://github.com/suse-edge/edge-image-builder/blob/release-1.0/docs/building-images.md#kubernetes[upstream documentation] for details.
299+
Refer to the https://github.com/suse-edge/edge-image-builder/blob/release-1.1/docs/building-images.md#kubernetes[upstream documentation] for details.
300300
====
301301

302302
Let's build the image:

asciidoc/guides/air-gapped-eib-deployments.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Many of these options will be repeated across the different component sections,
156156

157157
[TIP]
158158
====
159-
Full list of customization options in the definition file can be found in the https://github.com/suse-edge/edge-image-builder/blob/release-1.0/docs/building-images.md#image-definition-file[upstream documentation]
159+
Full list of customization options in the definition file can be found in the https://github.com/suse-edge/edge-image-builder/blob/release-1.1/docs/building-images.md#image-definition-file[upstream documentation]
160160
====
161161

162162
We will take a look at the following fields which will be present in all definition files:
@@ -869,4 +869,4 @@ replicaset.apps/cdi-uploadproxy-646f4cd7f7 1 1 1 3m44s
869869

870870
== Troubleshooting
871871

872-
If you run into any issues while building the images or are looking to further test and debug the process, please refer to the https://github.com/suse-edge/edge-image-builder/tree/release-1.0/docs[upstream documentation].
872+
If you run into any issues while building the images or are looking to further test and debug the process, please refer to the https://github.com/suse-edge/edge-image-builder/tree/release-1.1/docs[upstream documentation].

asciidoc/quickstart/eib.adoc

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ For more information, read the <<components-eib,Edge Image Builder Introduction>
1717

1818
== Prerequisites
1919

20-
* An x86_64 physical host (or virtual machine) running SLES 15 SP5, openSUSE Leap 15.5, or openSUSE Tumbleweed.
20+
* An x86_64 physical host (or virtual machine) running SLES 15 SP6, openSUSE Leap 15.6, or openSUSE Tumbleweed.
2121
* An available container runtime (e.g. Podman)
22-
* A downloaded copy of the latest SLE Micro 5.5 SelfInstall "GM2" ISO image found https://www.suse.com/download/sle-micro/[here].
22+
* A downloaded copy of the latest SLE Micro 6.0 SelfInstall ISO image found https://www.suse.com/download/sle-micro/[here].
2323

2424
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.
2525

@@ -42,7 +42,7 @@ export CONFIG_DIR=$HOME/eib
4242
mkdir -p $CONFIG_DIR/base-images
4343
----
4444

45-
In the previous step we created a "base-images" directory that will host the SLE Micro 5.5 input image, let's ensure that the downloaded image is copied over to the configuration directory:
45+
In the previous step we created a "base-images" directory that will host the SLE Micro 6.0 input image, let's ensure that the downloaded image is copied over to the configuration directory:
4646

4747
[,shell]
4848
----
@@ -66,7 +66,7 @@ The configuration directory at this point should look like the following:
6666
[#quickstart-eib-definition-file]
6767
== Creating the image definition file
6868

69-
The definition file describes the majority of configurable options that the Edge Image Builder supports, a full example of options can be found https://github.com/suse-edge/edge-image-builder/blob/release-1.0/pkg/image/testdata/full-valid-example.yaml[here], and we would recommend that you take a look at the https://github.com/suse-edge/edge-image-builder/blob/release-1.0/docs/building-images.md[upstream building images guide] for more comprehensive examples than the one we're going to run through below. Let's start with a very basic definition file for our OS image:
69+
The definition file describes the majority of configurable options that the Edge Image Builder supports, a full example of options can be found https://github.com/suse-edge/edge-image-builder/blob/release-1.1/pkg/image/testdata/full-valid-example.yaml[here], and we would recommend that you take a look at the https://github.com/suse-edge/edge-image-builder/blob/release-1.1/docs/building-images.md[upstream building images guide] for more comprehensive examples than the one we're going to run through below. Let's start with a very basic definition file for our OS image:
7070

7171
[,console]
7272
----
@@ -127,7 +127,7 @@ operatingSystem:
127127

128128
[NOTE]
129129
====
130-
It's also possible to add additional users, create the home directories, set user-id's, add ssh-key authentication, and modify group information. Please refer to the https://github.com/suse-edge/edge-image-builder/blob/release-1.0/docs/building-images.md[upstream building images guide] for further examples.
130+
It's also possible to add additional users, create the home directories, set user-id's, add ssh-key authentication, and modify group information. Please refer to the https://github.com/suse-edge/edge-image-builder/blob/release-1.1/docs/building-images.md[upstream building images guide] for further examples.
131131
====
132132

133133
=== Configuring RPM packages
@@ -179,7 +179,7 @@ The above is a simple example, but for completeness, download the NVIDIA package
179179
[,bash]
180180
----
181181
$ mkdir -p $CONFIG_DIR/rpms/gpg-keys
182-
$ curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey > rpms/gpg-keys/nvidia.gpg
182+
$ curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey > $CONFIG_DIR/rpms/gpg-keys/nvidia.gpg
183183
----
184184

185185
[WARNING]
@@ -189,7 +189,7 @@ Adding in additional RPM's via this method is meant for the addition of supporte
189189

190190
[NOTE]
191191
====
192-
A more comprehensive guide with additional examples can be found in the https://github.com/suse-edge/edge-image-builder/blob/release-1.0/docs/installing-packages.md[upstream installing packages guide].
192+
A more comprehensive guide with additional examples can be found in the https://github.com/suse-edge/edge-image-builder/blob/release-1.1/docs/installing-packages.md[upstream installing packages guide].
193193
====
194194

195195
=== Configuring Kubernetes cluster and user workloads
@@ -252,7 +252,7 @@ kubernetes:
252252

253253
[NOTE]
254254
====
255-
Further examples of options such as multi-node deployments, custom networking, and Helm chart options/values can be found in the https://github.com/suse-edge/edge-image-builder/blob/release-1.0/docs/building-images.md#kubernetes[upstream documentation].
255+
Further examples of options such as multi-node deployments, custom networking, and Helm chart options/values can be found in the https://github.com/suse-edge/edge-image-builder/blob/release-1.1/docs/building-images.md#kubernetes[upstream documentation].
256256
====
257257

258258
[#quickstart-eib-network]
@@ -341,6 +341,8 @@ The output of the command should be similar to:
341341
[,console]
342342
----
343343
Setting up Podman API listener...
344+
Downloading file: dl-manifest-1.yaml 100% (498/498 B, 9.5 MB/s)
345+
Pulling selected Helm charts... 100% (1/1, 43 it/min)
344346
Generating image customization components...
345347
Identifier ................... [SUCCESS]
346348
Custom Files ................. [SKIPPED]
@@ -351,26 +353,27 @@ Users ........................ [SUCCESS]
351353
Proxy ........................ [SKIPPED]
352354
Resolving package dependencies...
353355
Rpm .......................... [SUCCESS]
356+
Os Files ..................... [SKIPPED]
354357
Systemd ...................... [SKIPPED]
358+
Fips ......................... [SKIPPED]
355359
Elemental .................... [SKIPPED]
356360
Suma ......................... [SKIPPED]
357-
Downloading file: dl-manifest-1.yaml 100% (498/498 B, 5.9 MB/s)
358-
Populating Embedded Artifact Registry... 100% (3/3, 11 it/min)
361+
Populating Embedded Artifact Registry... 100% (3/3, 10 it/min)
359362
Embedded Artifact Registry ... [SUCCESS]
360363
Keymap ....................... [SUCCESS]
361364
Configuring Kubernetes component...
362365
The Kubernetes CNI is not explicitly set, defaulting to 'cilium'.
363366
Downloading file: rke2_installer.sh
364-
Downloading file: rke2-images-core.linux-amd64.tar.zst 100% (782/782 MB, 98 MB/s)
365-
Downloading file: rke2-images-cilium.linux-amd64.tar.zst 100% (367/367 MB, 100 MB/s)
366-
Downloading file: rke2.linux-amd64.tar.gz 100% (34/34 MB, 101 MB/s)
367-
Downloading file: sha256sum-amd64.txt 100% (3.9/3.9 kB, 1.5 MB/s)
368-
Downloading file: dl-manifest-1.yaml 100% (498/498 B, 7.2 MB/s)
367+
Downloading file: rke2-images-core.linux-amd64.tar.zst 100% (657/657 MB, 48 MB/s)
368+
Downloading file: rke2-images-cilium.linux-amd64.tar.zst 100% (368/368 MB, 48 MB/s)
369+
Downloading file: rke2.linux-amd64.tar.gz 100% (35/35 MB, 50 MB/s)
370+
Downloading file: sha256sum-amd64.txt 100% (4.3/4.3 kB, 6.2 MB/s)
369371
Kubernetes ................... [SUCCESS]
370372
Certificates ................. [SKIPPED]
373+
Cleanup ...................... [SKIPPED]
371374
Building ISO image...
372375
Kernel Params ................ [SKIPPED]
373-
Image build complete!
376+
Build complete, the image can be found at: eib-image.iso
374377
----
375378

376379
The built ISO image is stored at `$CONFIG_DIR/eib-image.iso`:
@@ -414,15 +417,16 @@ The contents of this directory should look like:
414417
│ │── artefacts/
415418
│ │ │── registry/
416419
│ │ │ ├── hauler
417-
│ │ │ ├── nginx:1.14.2-registry.tar.zst
418-
│ │ │ ├── rancher_kubectl:v1.28.7-registry.tar.zst
419-
│ │ │ └── registry.suse.com_suse_sles_15.5_virt-operator:1.1.1-150500.8.12.1-registry.tar.zst
420+
│ │ │ ├── nginx:<version>-registry.tar.zst
421+
│ │ │ ├── rancher_kubectl:<version>-registry.tar.zst
422+
│ │ │ └── registry.suse.com_suse_sles_15.6_virt-operator:<version>-registry.tar.zst
420423
│ │ │── rpms/
421424
│ │ │ └── rpm-repo
422425
│ │ │ ├── addrepo0
423-
│ │ │ │ └── x86_64
424-
│ │ │ │ ├── nvidia-container-toolkit-1.15.0-1.x86_64.rpm
425-
│ │ │ │ ├── ...
426+
│ │ │ │ ├── nvidia-container-toolkit-<version>.rpm
427+
│ │ │ │ ├── nvidia-container-toolkit-base-<version>.rpm
428+
│ │ │ │ ├── libnvidia-container1-<version>.rpm
429+
│ │ │ │ └── libnvidia-container-tools-<version>.rpm
426430
│ │ │ ├── repodata
427431
│ │ │ │ ├── ...
428432
│ │ │ └── zypper-success
@@ -438,7 +442,7 @@ The contents of this directory should look like:
438442
│ │ │ └── sha256sum-amd64.txt
439443
│ │ └── manifests/
440444
│ │ ├── dl-manifest-1.yaml
441-
│ │ └── kubevirt-chart.yaml
445+
│ │ └── kubevirt.yaml
442446
│ ├── createrepo.log
443447
│ ├── eib-build.log
444448
│ ├── embedded-registry.log
@@ -472,7 +476,7 @@ If the build fails, `eib-build.log` is the first log that contains information.
472476

473477
At this point, you should have a ready-to-use image that will:
474478

475-
1. Deploy SLE Micro 5.5
479+
1. Deploy SLE Micro 6.0
476480
2. Configure the root password
477481
3. Install the `nvidia-container-toolkit` package
478482
4. Configure an embedded container registry to serve content locally
@@ -484,9 +488,9 @@ At this point, you should have a ready-to-use image that will:
484488
[#quickstart-eib-image-debug]
485489
== Debugging the image build process
486490

487-
If the image build process fails, refer to the https://github.com/suse-edge/edge-image-builder/blob/release-1.0/docs/debugging.md[upstream debugging guide].
491+
If the image build process fails, refer to the https://github.com/suse-edge/edge-image-builder/blob/release-1.1/docs/debugging.md[upstream debugging guide].
488492

489493
[#quickstart-eib-image-test]
490494
== Testing your newly built image
491495

492-
For instructions on how to test the newly built CRB image, refer to the https://github.com/suse-edge/edge-image-builder/blob/release-1.0/docs/testing-guide.md[upstream image testing guide].
496+
For instructions on how to test the newly built CRB image, refer to the https://github.com/suse-edge/edge-image-builder/blob/release-1.1/docs/testing-guide.md[upstream image testing guide].

0 commit comments

Comments
 (0)