Improving release notes visibility

Signed-off-by: David Cassany <[email protected]>
rancher · Oct 25, 2024 · c5d8835 · c5d8835
1 parent f0281c3
commit c5d8835
Show file tree

Hide file tree

Showing 6 changed files with 514 additions and 14 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -4,11 +4,24 @@ sidebar_label: Overview
 title: ''
 ---
 
+import ButtonGroup from '@mui/material/ButtonGroup';
+import Button from '@mui/material/Button';
+
 <head>
   <link rel="canonical" href="https://elemental.docs.rancher.com"/>
 </head>
 
-# Overview
+# OS Management for Rancher
+
+Manage your OS appliance for Kubernetes nodes as simple OCI images and turn them into self installing
+ISO or disk images.
+
+<ButtonGroup size="small">
+  <Button variant="contained" href="release-notes">Latest Release:</Button>
+  <Button variant="outlined" href="release-notes">v1.6.5</Button>
+</ButtonGroup>
+
+## Welcone to Elemental
 
 Elemental is a software stack enabling centralized, full cloud-native OS management with Kubernetes.
 

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -17,13 +17,86 @@ Here's the different components, their latest version and a link to the respecti
 
 | Name                                                                 | Version | Release Notes                                                                |
 |----------------------------------------------------------------------|---------|------------------------------------------------------------------------------|
-| [Elemental Operator](https://github.com/rancher/elemental-operator/) | v1.6.3  | [Link](https://github.com/rancher/elemental-operator/releases/tag/v1.6.3)    |
+| [Elemental Operator](https://github.com/rancher/elemental-operator/) | v1.6.5  | [Link](https://github.com/rancher/elemental-operator/releases/tag/v1.6.5)    |
 | [Elemental Toolkit](https://github.com/rancher/elemental-toolkit/)   | v2.1.1  | [Link](https://github.com/rancher/elemental-toolkit/releases/tag/v2.1.1)     |
-| [Elemental Linux](https://github.com/rancher/elemental)              | v2.1.1  | [Link](https://github.com/rancher/elemental/releases/tag/v2.1.1)             |
-| [Elemental UI](https://github.com/rancher/elemental-ui)              | v1.3.1  | [Link](https://github.com/rancher/elemental-ui/releases/tag/elemental-1.3.1) |
+| [Elemental Linux](https://github.com/rancher/elemental)              | v2.1.3  | [Link](https://github.com/rancher/elemental/releases/tag/v2.1.3)             |
+| [Elemental UI](https://github.com/rancher/elemental-ui)              | v2.0.0  | [Link](https://github.com/rancher/elemental-ui/releases/tag/elemental-2.0.0) |
 
 :::note Information on docs versioning
 
 The docs versioning is based on the `Elemental Operator` component as it's the user "entrypoint" to the Elemental project stack.
 
 :::
+
+## Install or Upgrade to latest release
+
+In order to install this release of the Elemental Operator check the project documentation.
+
+For already existing deployments use the following Helm commands to upgrade:
+
+```
+# Install/upgrade the CRDS chart
+helm upgrade \
+    --install -n cattle-elemental-system --create-namespace elemental-operator-crds \
+    oci://registry.suse.com/rancher/elemental-operator-crds-chart
+
+# Install/upgrade the operator chart
+helm upgrade \
+    --install -n cattle-elemental-system --create-namespace elemental-operator \
+    oci://registry.suse.com/rancher/elemental-operator-chart
+```
+
+To install or upgrade from the helm chart repository use:
+
+```
+helm repo add elemental-stable https://rancher.github.io/elemental-operator/stable/
+```
+
+and installed or upgraded with
+
+```
+# Install/upgrade the CRDS chart
+helm upgrade --install -n cattle-elemental-system --create-namespace \
+    elemental-operator-crds elemental-stable/elemental-operator-crds
+
+# Install/upgrade the operator chart
+helm upgrade --install -n cattle-elemental-system --create-namespace \
+    elemental-operator elemental-stable/elemental-operator
+```
+
+## Known issues
+
+### Predictable Network Interface Names
+
+The SLE Micro OS images with versions v2.1.1 and v2.1.2 (released in the default
+[ManagedOSVersionChannel](managedosversionchannel-reference))
+adopt predictable network interface names by default.
+
+This is a change from SLE Micro OS images previously released, so you should expect your
+Elemental hosts to switch the network interface names from the `ethX` template to the `enpXsY` one.
+
+You can disable the predictable network interface names by passing the `net.ifnames=0` argument
+to the kernel command line. To make it permanent:
+
+```sh
+grub2-editenv /oem/grubenv set extra_cmdline=net.ifnames=0
+```
+
+:::warning
+The adoption of the predictable network interface names feature was not a planned one:
+it will be reverted in the next SLE Micro OS images starting from version v2.1.3.
+These OS images will include the `net.ifnames=0` kernel command line argument by default.  
+The v2.1.3 OS images will be released via the default Elemental 1.6 channel.
+:::
+
+### SSH root access
+
+The SLE Micro OS images released in the current Elemental version (throught the default
+[ManagedOSVersionChannel](managedosversionchannel-reference)) do not allow ssh root access
+via password anymore. Easyest workaround is to either configure ssh root access via an ssh
+key or add a new user to the system.
+
+### Kernel Panic on hypervisors
+
+OS Images based on SL Micro 6.0 can fail to boot with a kernel panic on virtual machines using an unsupported CPU type.  
+The `x86-64-v2` instruction set is required. For best compatibility CPU host passthrough is recommended.
diff --git a/package.json b/package.json
@@ -19,7 +19,10 @@
     "@docusaurus/plugin-client-redirects": "3.5.2",
     "@docusaurus/plugin-google-gtag": "^3.5.2",
     "@docusaurus/preset-classic": "^3.5.2",
+    "@emotion/react": "^11.13.3",
+    "@emotion/styled": "^11.13.0",
     "@mdx-js/react": "^3.0.1",
+    "@mui/material": "^6.1.5",
     "clsx": "^2.1.0",
     "prism-react-renderer": "^2.4.0",
     "raw-loader": "^4.0.2",

diff --git a/versioned_docs/version-1.6/index.md b/versioned_docs/version-1.6/index.md
@@ -4,11 +4,24 @@ sidebar_label: Overview
 title: ''
 ---
 
+import ButtonGroup from '@mui/material/ButtonGroup';
+import Button from '@mui/material/Button';
+
 <head>
   <link rel="canonical" href="https://elemental.docs.rancher.com"/>
 </head>
 
-# Overview
+# OS Management for Rancher
+
+Manage your OS appliance for Kubernetes nodes as simple OCI images and turn them into self installing
+ISO or disk images.
+
+<ButtonGroup size="small">
+  <Button variant="contained" href="release-notes">Latest Release:</Button>
+  <Button variant="outlined" href="release-notes">v1.6.5</Button>
+</ButtonGroup>
+
+## Welcone to Elemental
 
 Elemental is a software stack enabling centralized, full cloud-native OS management with Kubernetes.
 

diff --git a/versioned_docs/version-1.6/release-notes.md b/versioned_docs/version-1.6/release-notes.md
@@ -17,17 +17,53 @@ Here's the different components, their latest version and a link to the respecti
 
 | Name                                                                 | Version | Release Notes                                                                |
 |----------------------------------------------------------------------|---------|------------------------------------------------------------------------------|
-| [Elemental Operator](https://github.com/rancher/elemental-operator/) | v1.6.4  | [Link](https://github.com/rancher/elemental-operator/releases/tag/v1.6.4)    |
+| [Elemental Operator](https://github.com/rancher/elemental-operator/) | v1.6.5  | [Link](https://github.com/rancher/elemental-operator/releases/tag/v1.6.5)    |
 | [Elemental Toolkit](https://github.com/rancher/elemental-toolkit/)   | v2.1.1  | [Link](https://github.com/rancher/elemental-toolkit/releases/tag/v2.1.1)     |
-| [Elemental Linux](https://github.com/rancher/elemental)              | v2.1.2  | [Link](https://github.com/rancher/elemental/releases/tag/v2.1.2)             |
-| [Elemental UI](https://github.com/rancher/elemental-ui)              | v1.3.1  | [Link](https://github.com/rancher/elemental-ui/releases/tag/elemental-1.3.1) |
+| [Elemental Linux](https://github.com/rancher/elemental)              | v2.1.3  | [Link](https://github.com/rancher/elemental/releases/tag/v2.1.3)             |
+| [Elemental UI](https://github.com/rancher/elemental-ui)              | v2.0.0  | [Link](https://github.com/rancher/elemental-ui/releases/tag/elemental-2.0.0) |
 
 :::note Information on docs versioning
 
 The docs versioning is based on the `Elemental Operator` component as it's the user "entrypoint" to the Elemental project stack.
 
 :::
 
+## Install or Upgrade to latest release
+
+In order to install this release of the Elemental Operator check the project documentation.
+
+For already existing deployments use the following Helm commands to upgrade:
+
+```
+# Install/upgrade the CRDS chart
+helm upgrade \
+    --install -n cattle-elemental-system --create-namespace elemental-operator-crds \
+    oci://registry.suse.com/rancher/elemental-operator-crds-chart
+
+# Install/upgrade the operator chart
+helm upgrade \
+    --install -n cattle-elemental-system --create-namespace elemental-operator \
+    oci://registry.suse.com/rancher/elemental-operator-chart
+```
+
+To install or upgrade from the helm chart repository use:
+
+```
+helm repo add elemental-stable https://rancher.github.io/elemental-operator/stable/
+```
+
+and installed or upgraded with
+
+```
+# Install/upgrade the CRDS chart
+helm upgrade --install -n cattle-elemental-system --create-namespace \
+    elemental-operator-crds elemental-stable/elemental-operator-crds
+
+# Install/upgrade the operator chart
+helm upgrade --install -n cattle-elemental-system --create-namespace \
+    elemental-operator elemental-stable/elemental-operator
+```
+
 ## Known issues
 
 ### Predictable Network Interface Names