rancher
/
elemental-docs
mirror of https://github.com/rancher/elemental-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove deprecated -teal image references (#327) 

* Remove Teal references

Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>

---------

Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>
This commit is contained in:
Andrea Mazzotti 2024-05-01 10:21:13 +02:00 committed by GitHub
parent 537fa1d7eb
commit 5f40ce198c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
28 changed files with 73 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/airgap.md
View File

@ -98,7 +98,7 @@ helm upgrade --create-namespace -n cattle-elemental-system \
helm upgrade --create-namespace -n cattle-elemental-system \
--install elemental-operator elemental-operator-chart-<VERSION>.tgz \
--set registryUrl=<REGISTRY.YOURDOMAIN.COM:PORT> \
--set channel.repository=rancher/elemental-teal-channel-<REGISTRY.YOURDOMAIN.COM>
--set channel.repository=rancher/elemental-channel-<REGISTRY.YOURDOMAIN.COM>
```
</TabItem>
<TabItem value="haulerArchive" label="Install from a Hauler archive" default>
@ -240,4 +240,4 @@ When requested, put the full path of the OS channel image just uploaded in your
### Elemental UI Extension
Rancher 2.7.x doesn't support UI extensions plugin in air-gapped environments, and so the Elemental UI is not available in Rancher 2.7.x.
The Elemental UI plugin will be present in the available UI extensions in Rancher 2.8.0.
The Elemental UI plugin will be present in the available UI extensions in Rancher 2.8.0.

4
docs/custom-install.md
View File

@ -12,8 +12,8 @@ title: ''
Elemental installed OS images can be customized in different ways.
One option is to remaster container OS images by simply using a docker build.
SLE Micro for Rancher images are regular container images, so it is absolutely possible to create
a new image using a Dockerfile based on SLE Micro for Rancher. See [Build Custom OS Images](/custom-images.md)
SLE Micro images are regular container images, so it is absolutely possible to create
a new image using a Dockerfile based on SLE Micro. See [Build Custom OS Images](/custom-images.md)
section for further details on that possibility.
Alternatively, it is also possible to provide additional resources within the installation

2
docs/index.md
View File

@ -12,7 +12,7 @@ title: ''
Elemental is a software stack enabling centralized, full cloud-native OS management with Kubernetes.
The Elemental Stack consists of a handful of packages on top of SLE Micro for Rancher:
The Elemental Stack consists of a handful of packages on top of SLE Micro:
- **elemental-toolkit** - Includes a set of OS utilities to enable OS management via containers. Includes dracut modules, bootloader configuration, cloud-init style configuration services, etc.
- **elemental-operator** - Connects to Rancher Manager and handles MachineRegistration and MachineInventory CRDs.

2
docs/quickstart-ui.md
View File

@ -138,7 +138,7 @@ Once the build is done, media can be downloaded using the `Download Media` butto
You can now boot your nodes with this image and they will:
- Register with the registrationURL given and create a per-machine `MachineInventory`
- Install SLE Micro for Rancher to the given device
- Install SLE Micro to the given device
- Reboot
## Machine Inventory

4
docs/rancher-vmware.md
View File

@ -172,9 +172,9 @@ This command will download the vanilla iso and inject it with the parameters of
If you would like to download the vanilla ISO and reuse it later to create additional ISO's, then you can download the iso separately using the below command and then pass the local file path as an argument to the script
```shell showLineNumbers
wget https://download.opensuse.org/repositories/isv:/Rancher:/Elemental:/Stable:/Teal53/media/iso/elemental-teal.x86_64.iso
wget https://download.opensuse.org/repositories/isv:/Rancher:/Elemental:/Staging/containers/iso/sl-micro-6.0-baremetal.x86_64.iso
./elemental-iso-add-registration initial-registration.yaml /home/elemental-iso/elemental-teal.x86_64.iso
./elemental-iso-add-registration initial-registration.yaml /home/elemental-iso/sl-micro-6.0-baremetal.x86_64.iso
```
:::

2
docs/troubleshooting-upgrade.md
View File

@ -67,7 +67,7 @@ spec:
name: ServiceAccount-cattle-system-os-upgrader-my-upgrade-ce93d-01096.yaml
- content: '{"kind":"Secret","apiVersion":"v1","metadata":{"name":"os-upgrader-my-upgrade","namespace":"cattle-system","creationTimestamp":null},"data":{"cloud-config":""}}'
name: Secret-cattle-system-os-upgrader-my-upgrade-a997ee6a67ef.yaml
- content: '{"kind":"Plan","apiVersion":"upgrade.cattle.io/v1","metadata":{"name":"os-upgrader-my-upgrade","namespace":"cattle-system","creationTimestamp":null},"spec":{"concurrency":1,"nodeSelector":{},"serviceAccountName":"os-upgrader-my-upgrade","version":"latest","secrets":[{"name":"os-upgrader-my-upgrade","path":"/run/data"}],"tolerations":[{"operator":"Exists"}],"cordon":true,"upgrade":{"image":"registry.suse.com/rancher/elemental-teal/5.4","command":["/usr/sbin/suc-upgrade"]}},"status":{}}'
- content: '{"kind":"Plan","apiVersion":"upgrade.cattle.io/v1","metadata":{"name":"os-upgrader-my-upgrade","namespace":"cattle-system","creationTimestamp":null},"spec":{"concurrency":1,"nodeSelector":{},"serviceAccountName":"os-upgrader-my-upgrade","version":"latest","secrets":[{"name":"os-upgrader-my-upgrade","path":"/run/data"}],"tolerations":[{"operator":"Exists"}],"cordon":true,"upgrade":{"image":"registry.suse.com/suse/sle-micro/5.5","command":["/usr/sbin/suc-upgrade"]}},"status":{}}'
name: Plan-cattle-system-os-upgrader-my-upgrade-273c2c09afca.yaml
targets:
- clusterName: my-cluster

2
docs/wifi.md
View File

@ -22,7 +22,7 @@ You can refer to the same instructions as below on how to create it.
The information on this page is just a specific use case of using cloud-config. For more generic info on how to create arbitrary files check our [cloud-config](cloud-config-reference.md) page
:::
SLE Micro for Rancher currently uses [NetworkManager](https://networkmanager.dev/) to manage network connections.
SLE Micro currently uses [NetworkManager](https://networkmanager.dev/) to manage network connections.
In order to add Wi-Fi to your node, your registration should include a configuration in the [cloud-config](cloud-config-reference.md) section to write a
`.connection` file so NetworkManager can connect to the Wi-Fi.

2
examples/proxy/seedimage-proxy.yaml
View File

@ -4,7 +4,7 @@ metadata:
name: ...
namespace: ...
spec:
baseImage: https://download.opensuse.org/repositories/isv:/Rancher:/Elemental:/Stable:/Teal53/media/iso/elemental-teal.x86_64.iso
baseImage: registry.suse.com/suse/sle-micro/5.5:2.0.2
cloud-config:
write_files:
- path: /etc/sysconfig/proxy

2
examples/quickstart/seedimage.yaml
View File

@ -4,7 +4,7 @@ metadata:
name: fire-img
namespace: fleet-default
spec:
baseImage: registry.suse.com/rancher/elemental-teal-iso/5.4:1.2.2
baseImage: registry.suse.com/suse/sle-micro/5.5:2.0.2
registrationRef:
apiVersion: elemental.cattle.io/v1beta1
kind: MachineRegistration

2
examples/upgrade/managed-os-version-channel-custom.yaml
View File

@ -1,7 +1,7 @@
apiVersion: elemental.cattle.io/v1beta1
kind: ManagedOSVersionChannel
metadata:
name: elemental-teal-channel
name: elemental-channel
namespace: fleet-default
spec:
options:

6
versioned_docs/version-1.4/airgap.md
View File

@ -20,7 +20,7 @@ In order to run Elemental in an air-gapped environment the following artifacts a
- the containerized OS images
Moreover, it could be handy to create a *channel image* referencing the containerized OS images available.
The official channel image (the *elemental-teal-channel* one) references absolute URLs of the OS images on the official suse registry, so it cannot be used in an air-gapped scenario.
The official channel image (the *elemental-channel* one) references absolute URLs of the OS images on the official suse registry, so it cannot be used in an air-gapped scenario.
All these steps can be performed by executing the [`elemental-airgap.sh` script](https://raw.githubusercontent.com/rancher/elemental-operator/main/scripts/elemental-airgap.sh) from a host with Internet access.
You can provide manually downloaded Elemental charts to the script or let it download the helm charts for you.
@ -67,7 +67,7 @@ helm upgrade --create-namespace -n cattle-elemental-system \
helm upgrade --create-namespace -n cattle-elemental-system \
--install elemental-operator elemental-operator-chart-<VERSION>.tgz \
--set registryUrl=<REGISTRY.YOURDOMAIN.COM:PORT> \
--set channel.repository=rancher/elemental-teal-channel-<REGISTRY.YOURDOMAIN.COM>
--set channel.repository=rancher/elemental-channel-<REGISTRY.YOURDOMAIN.COM>
```
:::info The elemental airgap script outputs the required commands
@ -77,4 +77,4 @@ The `elemental-airgap.sh` scripts prints out the required commands shown above b
### Elemental UI Extension
Rancher 2.7.x doesn't support UI extensions plugin in air-gapped environments, and so the Elemental UI is not available in Rancher 2.7.x.
The Elemental UI plugin will be present in the available UI extensions in Rancher 2.8.0.
The Elemental UI plugin will be present in the available UI extensions in Rancher 2.8.0.

4
versioned_docs/version-1.4/architecture.md
View File

@ -122,7 +122,3 @@ an update of containerd, k3s, RKE2, or Rancher does not require an OS upgrade
or node reboot.
----
## Elemental Teal
Elemental Teal is Elemental OS built on top of SUSE Linux Enterprise (SLE) Micro for Rancher using the Elemental stack.

3
versioned_docs/version-1.4/custom-certificate.md
View File

@ -19,8 +19,7 @@ Kubernetes workloads should bring their certificates within the
container image instead.
:::
In order to install a custom certificate on SLE Micro for Rancher we
need to
In order to install a custom certificate we need to
* copy the `.pem` file to `/etc/pki/trust/anchors/`
* run `update-ca-certificates`

26
versioned_docs/version-1.4/customizing.md
View File

@ -9,14 +9,14 @@ title: ''
# Customize Elemental Install
Elemental Teal images can be customized in different ways.
Elemental installed OS can be customized in three different non-exclusive ways
One option is to provide
additional resources within the installation media so that during installation, or
eventually at boot time, additional binaries such as drivers can be included.
Another option would be to remaster the Elemental Teal by simply using a docker build.
Elemental Teal is a regular container image, so it is absolutely possible to create
a new image using a Dockerfile based on Elemental Teal image.
Another option would be to remaster the Elemental images by simply using a docker build.
Elemental images are regular container images, so it is absolutely possible to create
a new image using a Dockerfile.
## Customize installation ISO and installation process
@ -26,7 +26,7 @@ is added.
### Common customization pattern
Elemental Teal installation can be customized in three different non-exclusive ways. First, including
Elemental installed OS can be customized in three different non-exclusive ways. First, including
some custom Elemental client configuration file, second, by including additional cloud-init files to execute at
boot time, and finally, by including `cloud-init` files such as installation hooks or boot stages evaluated during
the live system boot itself.
@ -75,7 +75,7 @@ the `config-urls` field is used for this exact purpose. See [MachineRegistration
cloud-init file. The local path is evaluated during
the installation, hence it must exists within the installation media, commonly an ISO image.
By default, Elemental Teal live systems mount the ISO root at `/run/initramfs/live` which is also the default path set for `config-url` in `MachineRegistrations`:
By default, Elemental live systems mount the ISO root at `/run/initramfs/live` which is also the default path set for `config-url` in `MachineRegistrations`:
See the example below:
```yaml showLineNumbers
@ -95,7 +95,7 @@ spec:
config-urls:
- "/run/initramfs/live/oem/custom_config.yaml"
```
Elemental Teal live ISOs, when booted, have the ISO root mounted at `/run/initramfs/live`.
Elemental live ISOs, when booted, have the ISO root mounted at `/run/initramfs/live`.
According to that, the ISO for the example above is expected to include the `/oem/custom_config.yaml` file.
:::note
@ -169,7 +169,7 @@ as part of an LVM setup.
As an example, we have an host with three disks (`/dev/sda`, `/dev/sdb`
and `/dev/sdc`).
The first disk is used for a regular Elemental Teal installation
The first disk is used for a regular Elemental installation
and the other remaining two are used as part of a LVM group where arbitrary logical volumes
are created, formatted and mounted at boot time via an extended `fstab` file.
@ -260,14 +260,14 @@ Assuming an `overlay` folder was created in the current directory containing all
additional files to be appended, the following `xorriso` command adds the extra files:
```bash showLineNumbers
xorriso -indev elemental-teal.x86_64.iso -outdev elemental-teal.custom.x86_64.iso -map overlay / -boot_image any replay
xorriso -indev elemental.x86_64.iso -outdev elemental.custom.x86_64.iso -map overlay / -boot_image any replay
```
For that a `xorriso` equal or higher than version 1.5 is required.
## Remastering a custom docker image
Since Elemental Teal image is a Docker image it can also be used as a base image
Since Elemental images are Docker images, they can also be used as a base image
in a Dockerfile in order to create a new container image.
Imagine some additional package from an extra repository is required, the following example
@ -275,7 +275,7 @@ show case how this could be added:
```docker showLineNumbers
# The version of Elemental to modify
FROM registry.suse.com/rancher/elemental-teal/5.4:latest
FROM registry.suse.com/suse/sle-micro/5.5:latest
# Custom commands
RUN rpm --import <repo-signing-key-url> && \
@ -335,7 +335,7 @@ RUN --mount=type=bind,source=./,target=/output,rw \
dir:rootfs \
--bootloader-in-rootfs \
--squash-no-compression \
-o /output -n "elemental-teal-${TARGETARCH}"
-o /output -n "elemental-${TARGETARCH}"
```
@ -348,7 +348,7 @@ buildah build --tag myrepo/custom-build:v1.1.1 \
.
```
The new customized installation media can be found in `elemental-teal-amd64.iso`.
The new customized installation media can be found in `elemental-amd64.iso`.
:::caution important
You still need to [prepare the installation image](quickstart-cli#preparing-the-installation-seed-image) so it can be used to boot and provision the machine.

2
versioned_docs/version-1.4/elemental_behind_proxy.md
View File

@ -20,7 +20,7 @@ This guide will not cover the Rancher installation behind a proxy. It's a differ
:::
:::info info
For this documentation, we assume you are using a SUSE family system (like Elemental Teal), so proxy settings have to be written in `/etc/sysconfig/proxy`.
For this documentation, we assume you are using a SUSE family system (like SLE Micro), so proxy settings have to be written in `/etc/sysconfig/proxy`.
:::
Proxy settings must be configured in the following locations:

19
versioned_docs/version-1.4/index.md
View File

@ -24,26 +24,9 @@ Cluster Node OSes are built and maintained via container images through the <Var
The <Vars link="elemental_operator_url" name="elemental_operator_name" /> and the <Vars link="ranchersystemagent_url" name="ranchersystemagent_name" /> enable Rancher Manager to fully control Elemental clusters, from the installation and management of the OS on the Nodes to the provisioning of new K3s or RKE2 clusters in a centralized way.
## What is Elemental Teal ?
Elemental Teal is a combination of "SLE Micro for Rancher" with the Rancher Elemental stack.
SLE Micro for Rancher is a containerized and "stripped to the bones" OS layer. At its core, it only requires grub2, dracut, a kernel, and systemd.
It's sole purpose is to run Kubernetes (k3s or RKE2), with everything controlled through Rancher Manager.
Elemental Teal is built in the [openSUSE Build Service](https://build.opensuse.org/package/show/isv:Rancher:Elemental:Stable:Teal53/node-image)
and available through the [SUSE Registry](https://registry.suse.com).
You can check latest versions available with [skopeo](https://github.com/containers/skopeo):
```console showLineNumbers
skopeo list-tags docker://registry.suse.com/rancher/elemental-teal/5.3
```
### Elemental on x86-64 hardware
Elemental Teal is production ready and fully supported on x86-64 starting with Rancher v2.7.0.
Elemental is production ready and fully supported on x86-64 starting with Rancher v2.7.0.
### Elemental on ARM hardware

28
versioned_docs/version-1.4/installation.md
View File

@ -12,10 +12,8 @@ title: ''
## Overview
Elemental stack provides OS management using OCI containers and Kubernetes. The Elemental
stack installation encompasses the installation of the <Vars name="elemental_operator_name" /> into the
management cluster and the creation and use of Elemental Teal installation media to
provide the OS into the Cluster Nodes. See [Architecture](architecture.md) section to read about the
interaction of the components.
stack installation encompasses the installation of the <Vars name="elemental_operator_name" /> into the management cluster and the creation and use of installation media to
provide the OS into the Cluster Nodes. See [Architecture](architecture.md) section to read about the interaction of the components.
The installation configuration is mostly applied and set as part of the registration process.
The registration process is done by the `elemental-register` (the <Vars name="elemental_operator_name" /> client part)
@ -45,7 +43,7 @@ resources are required in order to prepare an Elemental based cluster deployment
* [MachineRegistration](machineregistration-reference.md):
This resource defines OS deployment details for any machine attempting to register. The machine
registration is the entrance for Elemental nodes as it handles the authentication (based on TPM),
the Elemental Teal deployment and the node inclusion into to the MachineInventory so it can be added
the OS deployment and the node inclusion into to the MachineInventory so it can be added
to a cluster when there is a match based on a MachineInventorySelectorTemplate. The MachineRegistration
object includes the machine registration URL that nodes use to register against it.
@ -54,7 +52,7 @@ the [Quick Start](quickstart-cli.md) guide or created from the Rancher 2.6 UI.
## Prepare Installation Media
The installation media is the media that will be used to kick start an Elemental Teal deployment. Currently
The installation media is the media that will be used to kick start an OS deployment. Currently
the supported media is a live ISO. The live ISO must include the registration configuration yaml hence it must
crafted once the MachineRegistration is created. The installation
media is created by using the [`elemental-iso-add-registration`](https://github.com/rancher/elemental/blob/main/.github/elemental-iso-add-registration)
@ -85,16 +83,16 @@ attempt to contact the management cluster and register to it by calling `element
As the registration yaml configuration is already included into the ISO `elemental-register` knows the registration URL and
any other required data for the registration.
On a succeeded registration the installation media will start the Elemental Teal installation into the host based
On a succeeded registration the installation media will start the installation into the host based
on the configuration already included in the media and the MachineRegistration parameters. As soon as the installation
is done the node is ready to reboot. The deployed Elemental Teal includes a system agent plan to
is done the node is ready to reboot. The deployed OS includes a system agent plan to
kick start a regular rancher provisioning process to install the selected kubernetes version, once booted, after
some minutes the node installation is finalized and the node is included into the cluster and visible through
the Rancher UI.
## Deployed Elemental Teal Partition Table
## Deployed Partition Table
Once Elemental Teal is installed the OS partition table, according to default values, will look like
Once the operating system is installed the OS partition table, according to default values, will look like
| Label | Default Size | Contains |
|----------------|-----------------|-------------------------------------------------------------|
@ -106,11 +104,11 @@ Once Elemental Teal is installed the OS partition table, according to default va
Note this is the basic structure of any OS built by the <Vars name="elemental_toolkit_name" link="elemental_toolkit_url" />
## Elemental Teal Immutable Root
## Elemental Immutable Root
One of the characteristics of Elemental OSes is the setup of an immutable root filesystem where some ephemeral or
persistent locations are applied on top of it. Elemental Teal default folders structure is listed in the
matrix below.
One of the characteristics of Elemental OSes is the setup of an immutable root
filesystem where some ephemeral or persistent locations are applied on top of
it. The default folders structure is listed in the matrix below.
| Path | Read-Only | Ephemeral | Persistent |
|-------------------------|:---------:|:---------:|:----------:|
@ -131,7 +129,7 @@ matrix below.
| /var/lib/kubelet | | | x |
| /var/lib/longhorn | | | x |
| /var/lib/rancher | | | x |
| /var/lib/elemetal | | | x |
| /var/lib/elemental | | | x |
| /var/lib/NetworkManager | | | x |
| /var/lib/calico | | | x |
| /var/log | | | x |

6
versioned_docs/version-1.4/inventory-management.md
View File

@ -19,7 +19,7 @@ The `MachineInventory` holds all the relevant information for a registered machi
Upon successful registration, the `MachineInventory` will inherit all `machineInventoryLabels` defined in the related `MachineRegistration`.
Additionally, the machine `annotations` will also be updated on each successful registration.
By default, Elemental Teal machines will attempt a registration update every 24 hours to update labels and annotations.
By default, Elemental machines will attempt a registration update every 24 hours to update labels and annotations.
#### Reference
@ -63,10 +63,10 @@ spec:
### MachineRegistration
`MachineRegistration` holds information on how to install, reset, and configure all connected Elemental Teal machines.
`MachineRegistration` holds information on how to install, reset, and configure all connected Elemental machines.
It's possible to update the `spec.machineInventoryLabels` and `spec.machineInventoryAnnotations` and this will be applied to all registered machines.
By default, Elemental Teal machines will attempt a registration update every 24 hours to update labels and annotations.
By default, Elemental machines will attempt a registration update every 24 hours to update labels and annotations.
While it's possible to modify the `spec.config` definition, updates to the `spec.config` will be ignored by machines that already completed installation.
Machines that couldn't complete the installation will try again every 30 minutes by reloading the remote `MachineRegistration` definition. This can be useful to correct `spec.config` mistakes that prevent successful installation (for ex. `spec.config.elemental.install.device`), without having to create a new `MachineRegistration` and a new ISO.

6
versioned_docs/version-1.4/machineregistration-reference.md
View File

@ -108,7 +108,7 @@ If both `device` and `device-selector` is specified the value of `device` is use
debug: true
reboot: true
eject-cd: true
system-uri: registry.suse.com/rancher/elemental-teal/5.4:latest
system-uri: registry.suse.com/suse/sle-micro/5.5:latest
```
</details>
@ -197,7 +197,7 @@ Supports the following values:
reset-persistent: true
reset-oem: true
reboot: true
system-uri: registry.opensuse.org/isv/rancher/elemental/stable/teal53/15.4/rancher/elemental-teal/5.3:latest
system-uri: registry.suse.com/suse/sle-micro/5.5:latest
```
</details>
@ -233,7 +233,7 @@ The UUID will be retrieved from the SMBIOS data if available, otherwise a random
Labels that will be set to the `MachineInventory` that is created from this `MachineRegistration`
`Key: value` type. These labels will be used to establish a selection criteria in [MachineInventorySelectorTemplate](machineinventoryselectortemplate-reference.md).
Elemental Teal nodes will run `elemental-register` every 24 hours.
Elemental nodes will run `elemental-register` every 24 hours.
It is possible to update the `machineInventoryLabels` so that all registered nodes will apply the new labels on the next successfull registration update.
:::info

2
versioned_docs/version-1.4/partials/_quickstart-prereqs.md
View File

@ -6,7 +6,7 @@
* Hint 1: Libvirt allows setting virtual TPMs for virtual machines [example here](tpm#add-tpm-module-to-virtual-machine)
* Hint 2: You can enable TPM emulation on bare metal machines missing the TPM 2.0 module [example here](tpm#add-tpm-emulation-to-bare-metal-machine)
* Hint 3: Make sure you're using UEFI (not BIOS) on x86-64, or the ISO won't boot
* Hint 4: A minimum volume size of 25 GB is recommended. See the [Elemental Teal partition table](installation#deployed-elemental-teal-partition-table) for more details
* Hint 4: A minimum volume size of 25 GB is recommended. See the [Elemental partition table](installation#deployed-elemental-partition-table) for more details
* Hint 5: CPU and RAM requirements depend on the Kubernetes version installed, for example [K3s](https://docs.k3s.io/installation/requirements#hardware) or [RKE2](https://docs.rke2.io/install/requirements#hardware)
* Helm Package Manager (https://helm.sh/)
* For ARM (aarch64) - One SD-card (32 GB or more, must be **fast** - 40MB/s write speed is acceptable) and a USB-stick for installation

10
versioned_docs/version-1.4/quickstart-cli.md
View File

@ -18,7 +18,7 @@ import SeedImage from "!!raw-loader!@site/examples/quickstart/seedimage.yaml"
# Elemental the command line way
Follow this guide to have an auto-deployed cluster via rke2/k3s and managed by Rancher
with the only help of an Elemental Teal ISO.
with the only help of an Elemental ISO.
<Prereqs />
@ -132,7 +132,7 @@ kubectl apply -f https://raw.githubusercontent.com/rancher/elemental-docs/main/e
## Preparing the installation (seed) image
This is the last step: you need an Elemental Teal seed image that includes the initial registration config, so it can be auto registered, installed and fully deployed as part of your cluster.
This is the last step: you need an Elemental seed image that includes the initial registration config, so it can be auto registered, installed and fully deployed as part of your cluster.
:::note note
The initial registration config file is generated when you create a `Machine Registration`.
@ -155,10 +155,10 @@ The seed image created by the `SeedImage` resource above can be downloaded as an
```shell showLineNumbers
kubectl wait --for=condition=ready pod -n fleet-default fire-img
wget --no-check-certificate `kubectl get seedimage -n fleet-default fire-img -o jsonpath="{.status.downloadURL}"` -O elemental-teal.x86_64.iso
wget --no-check-certificate `kubectl get seedimage -n fleet-default fire-img -o jsonpath="{.status.downloadURL}"` -O elemental.x86_64.iso
```
The first command waits for the ISO to be built and ready, the second one downloads it in the current directory with the name `elemental-teal-x86_64.iso`.
The first command waits for the ISO to be built and ready, the second one downloads it in the current directory with the name `elemental.x86_64.iso`.
</TabItem>
<TabItem value="manual_iso" label="Preparing the seed image (x86_64) manually">
@ -248,7 +248,7 @@ Make sure the micro SD-card is unpartitioned. Otherwise the Pi bootloader will t
You can now boot your nodes with this image and they will:
- Register with the registrationURL given and create a per-machine `MachineInventory`
- Install Elemental Teal to the given device
- Install SLE Micro to the given device
- Reboot
### Selecting the right machines to join a cluster

4
versioned_docs/version-1.4/quickstart-ui.md
View File

@ -123,7 +123,7 @@ Once you create the machine registration end point it should show up as active.
## Preparing the installation (seed) image
Now this is the last step, you need to prepare an Elemental Teal seed image that includes the initial registration config, so
Now this is the last step, you need to prepare a seed image that includes the initial registration config, so
it can be auto registered, installed and fully deployed as part of your cluster. The contents of the file are nothing
more than the registration URL that the node needs to register and the proper server certificate, so it can connect securely.
@ -140,7 +140,7 @@ Once the build is done, ISO can be downloaded using the `Download ISO` button:
You can now boot your nodes with this image and they will:
- Register with the registrationURL given and create a per-machine `MachineInventory`
- Install Elemental Teal to the given device
- Install SLE Micro to the given device
- Reboot
## Machine Inventory

4
versioned_docs/version-1.4/rancher-vmware.md
View File

@ -172,9 +172,9 @@ This command will download the vanilla iso and inject it with the parameters of
If you would like to download the vanilla ISO and reuse it later to create additional ISO's, then you can download the iso separately using the below command and then pass the local file path as an argument to the script
```shell showLineNumbers
wget https://download.opensuse.org/repositories/isv:/Rancher:/Elemental:/Stable:/Teal53/media/iso/elemental-teal.x86_64.iso
wget https://updates.suse.com/SUSE/Products/Elemental/5.5/x86_64/iso/sle-micro.x86_64-2.0.2-GM.iso
./elemental-iso-add-registration initial-registration.yaml /home/elemental-iso/elemental-teal.x86_64.iso
./elemental-iso-add-registration initial-registration.yaml /home/elemental-iso/sle-micro.x86_64-2.0.2-GM.iso
```
:::

2
versioned_docs/version-1.4/removable-device-cloudconfig.md
View File

@ -10,7 +10,7 @@ title: ''
### How to include cloud-config files from removable devices
Elemental Teal supports loading [cloud-config](cloud-config-reference.md) files from specific block devices.
Elemental nodes support loading [cloud-config](cloud-config-reference.md) files from specific block devices.
In particular supports loading cloud-config files from an ISO having `CIDATA` as the volume ID or any vFAT formatted
device labeled with `CIDATA`. If a device matching this criteria is found on early boot the Elemental client will
read it and look for a `user-data` file in its root.

2
versioned_docs/version-1.4/reset.md
View File

@ -31,7 +31,7 @@ If the machine is still running, this plan will:
This will fetch the remote `MachineRegistration` and apply the `spec.config.elemental.reset` options to reset the machine.
A new `MachineInventory` will be created and the `spec.config.cloud-config` defined in the `MachineRegistration` will be applied again.
Note that the `MachineRegistration` reference will **not** change, the machine will **not** be reinstalled, the `COS_PERSISTENT` and `COS_OEM` partition will be cleared by default if reset is `enabled`. For more information, you can consult the [Partition Table](installation#deployed-elemental-teal-partition-table).
Note that the `MachineRegistration` reference will **not** change, the machine will **not** be reinstalled, the `COS_PERSISTENT` and `COS_OEM` partition will be cleared by default if reset is `enabled`. For more information, you can consult the [Partition Table](installation#deployed-elemental-partition-table).
Since the `cloud-config` is re-applied during the reset workflow, you can reset a machine to apply updates from the `MachineRegistration` definition, for example to rotate `users` credentials and authorized keys. It is strongly recommended to enable the `reset-oem` option, to avoid conflicts with previously configured cloud-configs.

10
versioned_docs/version-1.4/troubleshooting-upgrade.md
View File

@ -23,7 +23,7 @@ metadata:
namespace: fleet-default
spec:
# Set to the new Elemental version you would like to upgrade to or track the latest tag
osImage: "registry.suse.com/rancher/elemental-teal/5.4:latest"
osImage: "registry.suse.com/suse/sle-micro/5.5:latest"
clusterTargets:
- clusterName: my-cluster
```
@ -67,7 +67,7 @@ spec:
name: ServiceAccount-cattle-system-os-upgrader-my-upgrade-ce93d-01096.yaml
- content: '{"kind":"Secret","apiVersion":"v1","metadata":{"name":"os-upgrader-my-upgrade","namespace":"cattle-system","creationTimestamp":null},"data":{"cloud-config":""}}'
name: Secret-cattle-system-os-upgrader-my-upgrade-a997ee6a67ef.yaml
- content: '{"kind":"Plan","apiVersion":"upgrade.cattle.io/v1","metadata":{"name":"os-upgrader-my-upgrade","namespace":"cattle-system","creationTimestamp":null},"spec":{"concurrency":1,"nodeSelector":{},"serviceAccountName":"os-upgrader-my-upgrade","version":"latest","secrets":[{"name":"os-upgrader-my-upgrade","path":"/run/data"}],"tolerations":[{"operator":"Exists"}],"cordon":true,"upgrade":{"image":"registry.suse.com/rancher/elemental-teal/5.4","command":["/usr/sbin/suc-upgrade"]}},"status":{}}'
- content: '{"kind":"Plan","apiVersion":"upgrade.cattle.io/v1","metadata":{"name":"os-upgrader-my-upgrade","namespace":"cattle-system","creationTimestamp":null},"spec":{"concurrency":1,"nodeSelector":{},"serviceAccountName":"os-upgrader-my-upgrade","version":"latest","secrets":[{"name":"os-upgrader-my-upgrade","path":"/run/data"}],"tolerations":[{"operator":"Exists"}],"cordon":true,"upgrade":{"image":"registry.suse.com/suse/sle-micro/5.5","command":["/usr/sbin/suc-upgrade"]}},"status":{}}'
name: Plan-cattle-system-os-upgrader-my-upgrade-273c2c09afca.yaml
targets:
- clusterName: my-cluster
@ -80,7 +80,7 @@ spec:
## Elemental Cluster side
Any Elemental Teal node correctly registered and part of the target cluster will fetch the bundle and start applying it.
Any Elemental node correctly registered and part of the target cluster will fetch the bundle and start applying it.
This operation is performed by the Rancher's `system-upgrade-controller` running on the Elemental Cluster.
To monitor the correct operation of this controller, you can read its logs:
@ -103,7 +103,7 @@ You can monitor these jobs with:
kubectl -n cattle-system get jobs
```
Each job will use a `privileged: true` container with the Elemental Teal image specified in the `ManagedOSImage` definition. This container will try to upgrade the system and perform a reboot.
Each job will use a `privileged: true` container with the SLE Micro image specified in the `ManagedOSImage` definition. This container will try to upgrade the system and perform a reboot.
If the job fails, you can check its status by examining the logs:
@ -115,7 +115,7 @@ kubectl -n cattle-system logs job.batch/apply-os-upgrader-my-upgrade-on-my-host-
Note that the upgrade process is performed in two stages.
You will notice that the same job is ran twice and the first one ends with the `Uknown` Status and will not complete.
**This is to be expected**, as Elemental Teal relies on the job to be ran again after the machine restarts, so that it can verify the new version was installed correctly.
**This is to be expected**, as Elemental relies on the job to be ran again after the machine restarts, so that it can verify the new version was installed correctly.
You will notice a second run of the job, this time completing correctly.
```shell showLineNumbers

8
versioned_docs/version-1.4/upgrade.md
View File

@ -20,9 +20,9 @@ import Versions from "../examples/upgrade/versions.raw!=!raw-loader!@site/exampl
All components in Elemental are managed using Kubernetes. Below is how
to use Kubernetes approaches to upgrade the components.
## Elemental Teal node upgrade
## Elemental node upgrade
Elemental Teal is upgraded with the <Vars name="elemental_operator_name" />. Refer to the
Elemental nodes are upgraded with the <Vars name="elemental_operator_name" />. Refer to the
[<Vars name="elemental_operator_name" />](elementaloperatorchart-reference.md) documentation for complete information.
Upgrade can be achieve either with CLI or UI:
@ -117,8 +117,8 @@ The generated data is then automounted by the syncer and then parsed so it can g
The only requirement to make your own custom syncer is to make it output a json file to `/data/output` and keep the correct json structure.
:::
Elemental project provides an Elemental Teal channel to list all `ManagedOSVersions` released as a custom syncer.
See the Elemental Teal channel resource definition below:
Elemental project provides a channel to list all `ManagedOSVersions` released as a custom syncer.
See the channel resource definition below:
<CodeBlock language="yaml" title="managed-os-version-channel-json.yaml" showLineNumbers>{ManagedOSVersionChannelCustom}</CodeBlock>

2
versioned_docs/version-1.4/wifi.md
View File

@ -22,7 +22,7 @@ You can refer to the same instructions as below on how to create it.
The information on this page is just a specific use case of using cloud-config. For more generic info on how to create arbitrary files check our [cloud-config](cloud-config-reference.md) page
:::
Elemental Teal currently uses [NetworkManager](https://networkmanager.dev/) to manage network connections.
SLE Micro currently uses [NetworkManager](https://networkmanager.dev/) to manage network connections.
In order to add Wi-Fi to your node, your registration should include a configuration in the [cloud-config](cloud-config-reference.md) section to write a
`.connection` file so NetworkManager can connect to the Wi-Fi.