Skip to content

Commit

Permalink
Fix "tips" pages formatting
Browse files Browse the repository at this point in the history
Signed-off-by: Atanas Dinov <[email protected]>
  • Loading branch information
atanasdinov committed Jan 20, 2025
1 parent a880a9f commit a54690a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
7 changes: 4 additions & 3 deletions asciidoc/tips/eib.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
= *Edge Image Builder*
= Edge Image Builder

== Common

.Common
- If you are in a non-Linux environment and following these instructions to build an image, then you are likely running `Podman` via a virtual machine. By default, this virtual machine will be configured to have a small amount of system resources allocated to it and can cause instability for `Edge Image Builder` during resource intensive operations, such as the RPM resolution process. You will need to adjust the resources of the podman machine, either by using Podman Desktop (settings cogwheel -> podman machine edit icon) or directly via the `podman-machine-set` https://docs.podman.io/en/stable/markdown/podman-machine-set.1.html[command]
- At this point in time, the `Edge Image Builder` is not able to build images in a cross architecture setup, i.e. you have to run it on:
* `aarch64` systems (such as Apple Silicon) to build SL Micro `aarch64` images
* `x86_64` systems (such as Intel) to build SL Micro `x86_64` images.


.Kubernetes
== Kubernetes

- Creating multi node Kubernetes clusters requires adjusting the `kubernetes` section in the definition file to:
* list all server and agent nodes under `kubernetes.nodes`
* set a virtual IP address that would be used for all non-initializer nodes to join the cluster under `kubernetes.network.apiVIP`
Expand Down
19 changes: 15 additions & 4 deletions asciidoc/tips/elemental.adoc
Original file line number Diff line number Diff line change
@@ -1,27 +1,31 @@
= *SUSE Edge Elemental Workflow Tips and Tricks*
= Elemental

:imagesdir: ../images/

.Common
* Expose Rancher service
== Common

=== Expose Rancher service

When using RKE2 or K3s we need to expose services (Rancher in this context) from the management cluster as they are not exposed by default.
In RKE2 there is an NGINX Ingress controller, whilst k3s is using Traefik.
The current workflow suggests using MetalLB for announcing a service (via L2 or BGP Advertisement) and the respective Ingress Controller
to create an Ingress via `HelmChartConfig` since creating a new Ingress object would override the existing setup.

. Install Rancher Prime (via Helm) and configure the necessary values
+
[,yaml]
----
hostname: rancher-192.168.64.101.sslip.io
replicas: 1
bootstrapPassword: Admin
global.cattle.psp.enabled: "false"
----
+

TIP: Follow the https://ranchermanager.docs.rancher.com/{rancher-docs-version}/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster[Rancher installation] documentation for more details.

. Create a LoadBalancer service to expose Rancher
+
[,bash]
----
kubectl apply -f - <<EOF
Expand All @@ -44,8 +48,10 @@ spec:
externalTrafficPolicy: Local
EOF
----
+

. Create an IP Address Pool for the service using the IP address we set up earlier in the Helm values
+
[,bash]
----
kubectl apply -f - <<EOF
Expand All @@ -64,8 +70,10 @@ spec:
- {key: app.kubernetes.io/name, operator: In, values: [rke2-ingress-nginx]}
EOF
----
+

. Create an L2 Advertisement for the IP address pool
+
[,bash]
----
kubectl apply -f - <<EOF
Expand All @@ -79,6 +87,7 @@ spec:
- ingress-ippool
EOF
----
+

. Ensure Elemental is properly installed

Expand All @@ -88,7 +97,9 @@ EOF

TIP: Check <<install-elemental>> and <<configure-elemental>> for additional information and examples.

.Hardware Specific
== Hardware Specific

=== Trusted Platform Module

It is necessary to properly handle the https://elemental.docs.rancher.com/tpm/[Trusted Platform Module] (TPM) configuration.
Failing to do so will result in errors similar to the following:
Expand Down

0 comments on commit a54690a

Please sign in to comment.