Skip to content

Commit

Permalink
docs: make 0.5 docs the default, add what's new
Browse files Browse the repository at this point in the history
I renumbered weights a bit to make it easier to insert items.

Signed-off-by: Andrey Smirnov <[email protected]>
  • Loading branch information
smira committed Feb 14, 2022
1 parent 36ebc2a commit d3e75dc
Show file tree
Hide file tree
Showing 8 changed files with 75 additions and 10 deletions.
2 changes: 1 addition & 1 deletion website/content/docs/v0.5/Overview/architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: ""
weight: 3
weight: 30
title: "Architecture"
---

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.5/Overview/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: ""
weight: 2
weight: 20
title: Installation
---

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.5/Overview/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: ""
weight: 1
weight: 10
title: Introduction
---

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.5/Overview/resources.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: ""
weight: 5
weight: 50
title: Resources
---

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.5/Overview/siderolink.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: ""
weight: 4
weight: 40
title: SideroLink
---

Expand Down
65 changes: 65 additions & 0 deletions website/content/docs/v0.5/Overview/whatsnew.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
description: ""
weight: 15
title: What's New
---

### Cluster API v1.x (v1beta1)

This release of Sidero brings compatibility with CAPI v1.x (v1beta1).

### Cluster Template

Sidero ships with new cluster template without `init` nodes.
This template is only compatible with Talos >= 0.14 (it requires SideroLink feature which was introduced in Talos 0.14).

On upgrade, Sidero supports clusters running Talos < 0.14 if they were created before the upgrade.
Use [legacy template](https://github.com/talos-systems/sidero/blob/release-0.4/templates/cluster-template.yaml) to deploy clusters with Talos < 0.14.

### New `MetalMachines` Conditions

New set of conditions is now available which can simplify cluster troubleshooting:

- `TalosConfigLoaded` is set to false when the config load has failed.
- `TalosConfigValidated` is set to false when the config validation
fails on the node.
- `TalosInstalled` is set to true/false when talos installer finishes.

Requires Talos >= v0.14.

### Machine Addresses

Sidero now populates `MetalMachine` addresses with the ones discovered from Siderolink server events.
Which is then propagated to CAPI `Machine` resources.

Requires Talos >= v0.14.

### SideroLink

Sidero now connects to all servers using SideroLink (available only with Talos >= 0.14).
This enables streaming of kernel logs and events back to Sidero.

All server logs can now be viewed by getting logs of one of the container of the `sidero-controller-manager`:

```bash
kubectl logs -f -n sidero-system deployment/sidero-controller-manager -c serverlogs
```

Events:

```bash
kubectl logs -f -n sidero-system deployment/sidero-controller-manager -c serverevents
```

### iPXE Boot From Disk Method

iPXE boot from disk method can now be set not only on the global level, but also in the Server and ServerClass specs.

### IPMI PXE Method

IPMI PXE method (UEFI, BIOS) can now be configured with `SIDERO_CONTROLLER_MANAGER_IPMI_PXE_METHOD` while installing Sidero.

### Retry PXE Boot

Sidero server controller now keeps track of Talos installation progress.
Now the node will be PXE booted until Talos installation succeeds.
6 changes: 3 additions & 3 deletions website/gridsome.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ module.exports = {
{
version: "v0.5",
url: "/docs/v0.5/",
latest: false,
prerelease: true,
latest: true,
prerelease: false,
},
{
version: "v0.4",
url: "/docs/v0.4/",
latest: true,
latest: false,
prerelease: false,
},
{
Expand Down
4 changes: 2 additions & 2 deletions website/static/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
#
# The Netlify documentation says that the following redirect rules are
# equivalent, but that is not what is observed in practice.
/docs/latest /docs/v0.4
/docs/latest/ /docs/v0.4
/docs/latest /docs/v0.5
/docs/latest/ /docs/v0.5

0 comments on commit d3e75dc

Please sign in to comment.