79 Commits

Author SHA1 Message Date
Utku Ozdemir
a46f2576f9
docs: add Omni bare metal infra provider link to maintenance warning
Refer to the bare metal infra provider, as it is the spiritual successor of Sidero Metal.

Signed-off-by: Utku Ozdemir <utku.ozdemir@siderolabs.com>
2025-03-03 16:22:20 +01:00
Steve Francis
9a35d37cf6
docs: add deprecation notice
Deprecation notice.

Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
2024-06-30 15:43:04 +04:00
Andrey Smirnov
a30f4d9bba
feat: provide negative address filter support
This allows to filter out addresses reported by Talos machines to
SideroMetal and which appear under `Machine.status.addresses`.

Fixes #1368

Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
2024-05-23 20:26:49 +04:00
Spencer Smith
cb907cf6e0
chore: update office hours
This PR updates office hours info for sidero metal.

Signed-off-by: Spencer Smith <spencer.smith@talos-systems.com>
2024-05-14 10:08:15 -04:00
Luke Carrier
376fd6e6bf
docs: correct "which { much => must }" typo
Correct minor typo found in the "Expose Sidero Services" documentation.

Signed-off-by: Luke Carrier <luke@carrier.im>
Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
2024-02-20 17:23:44 +04:00
rmvangun
90d7a7d5b3
docs: update to reflect master => controlplane
Update docs to reflect master => controlplane.
Also updates base versions.

Signed-off-by: Noel Georgi <git@frezbo.dev>
2024-01-09 22:11:47 +05:30
Alexandra
dc8b95edf7
docs: fix wrong raspberry installation url
Installation guide was link to an old url for raspberry pi.

Signed-off-by: Alexandra <bug.graph@gmail.com>
Signed-off-by: Noel Georgi <git@frezbo.dev>
2024-01-09 21:02:58 +05:30
Oscar Utbult
0f7973c86c
docs: fix website redirect to latest version
The website currently redirects to 0.5 instead of 0.6

Signed-off-by: Oscar Utbult <oscar.utbult@gmail.com>
Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
2023-11-20 14:26:08 +04:00
Andrey Smirnov
56744cfb03
feat: provide a way to disable DHCP proxy
Also bump some minor dependencies.

Fixes #1212
Fixes #1201

Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
2023-10-12 17:07:50 +04:00
Daniel Höxtermann
42685a8c1c
docs: fix port count for DHCP proxy
Missed in 8820a2b.

Signed-off-by: Daniel Höxtermann <daniel@hxtm.dev>
Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
2023-09-07 16:34:43 +04:00
Daniel Höxtermann
891edce4f1
docs: remove excess bash continuation backslashes
`sudo` begins a new command, so the preceding line must not end in `\`.

Signed-off-by: Daniel Höxtermann <daniel@hxtm.dev>
Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
2023-09-07 12:55:05 +04:00
Andrey Smirnov
8820a2bd5a
docs: update documentation for Sidero v0.6
Drop the pivoting step.

Drop the upgrades step (as it promotes in-place upgrades which don't
quite match the CAPI flow, and require additional handling).

Update for DHCP proxy.

Makes v0.6 the default documentation.

Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
2023-08-29 23:16:47 +04:00
Gerard de Leeuw
f88ee6d2e6
feat: add proxy DHCP server
Implement proxy DHCP server which ehnahnces IPAM DHCP response with boot
information.

Signed-off-by: Gerard de Leeuw <gdeleeuw@leeuwit.nl>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2023-08-24 21:56:15 +04:00
Sander Flobbe
f711a64b60
docs: code snippet lacks "sudo"
Users who are getting started will expect the code snippets to work as
is. Adding "sudo" in the documentation to improve user experience.

Signed-off-by: Sander Flobbe <s@nder.flob.be>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2023-05-30 15:55:46 +04:00
Andrey Smirnov
e433504087
feat: provide 'snp.efi' and recommend it over 'ipxe.efi'
Fixes #1042

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2023-04-06 23:10:15 +04:00
Andrey Smirnov
71390a33db
docs: remove docs v0.1-v0.3
These Sidero versions are outdated, using extremely old CAPI contract,
and they don't support recent versions of Talos.

Fixes #1075

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2023-04-06 22:00:45 +04:00
Michael Vorburger ⛑️
c95184a318
docs: detail how to disable IPMI magic (re. #988)
Explain how to set --auto-bmc-setup=false
using SIDERO_CONTROLLER_MANAGER_AUTO_BMC_SETUP.

Signed-off-by: Michael Vorburger <mike@vorburger.ch>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-11-24 16:35:10 +04:00
Russell Troxel
51ac816e6f
fix: docs: /etc/dhcp -> config to preserve across firmware update
The docs currently suggest placing the ipxe configuration file in /etc/dhcp/ - while this seems sane, when you update the firmware of an EdgeOS Device, which this is geared towards (or any other vyatta-based device), the entire filesystem is wiped, other than the /config directory.

This becomes especially problematic, because the config itself will still reference this file, and the dhcp server will refuse to start. From /var/log/messsages:

```
Oct 29 00:17:03 ubnt systemd[1]: vyatta-dhcpd.service: Control process exited, code=exited status=1
Oct 29 00:17:03 ubnt systemd[1]: Failed to start EdgeOS DHCP Server.
Oct 29 00:17:03 ubnt systemd[1]: vyatta-dhcpd.service: Unit entered failed state.
Oct 29 00:17:03 ubnt systemd[1]: vyatta-dhcpd.service: Failed with result 'exit-code'.
Oct 29 00:17:05 ubnt dhcpd3: Can't open /etc/dhcp/ipxe-metal.conf: No such file or directory
Oct 29 00:17:05 ubnt dhcpd3:
Oct 29 00:17:05 ubnt dhcpd3: If you did not get this software from ftp.isc.org, please
Oct 29 00:17:05 ubnt dhcpd3: get the latest from ftp.isc.org and install that before
Oct 29 00:17:05 ubnt dhcpd3: requesting help.
Oct 29 00:17:05 ubnt dhcpd3:
Oct 29 00:17:05 ubnt dhcpd3: If you did get this software from ftp.isc.org and have not
Oct 29 00:17:05 ubnt dhcpd3: yet read the README, please read it before requesting help.
Oct 29 00:17:05 ubnt dhcpd3: If you intend to request help from the dhcp-bugs at isc.org
Oct 29 00:17:05 ubnt dhcpd3: mailing list, please read the section on the README about
Oct 29 00:17:05 ubnt dhcpd3: submitting bug reports and requests for help.
Oct 29 00:17:05 ubnt dhcpd3:
Oct 29 00:17:05 ubnt dhcpd3: Please do not under any circumstances send requests for
Oct 29 00:17:05 ubnt dhcpd3: help directly to the authors of this software - please
Oct 29 00:17:05 ubnt dhcpd3: send them to the appropriate mailing list as described in
Oct 29 00:17:05 ubnt dhcpd3: the README file.
Oct 29 00:17:05 ubnt dhcpd3:
Oct 29 00:17:05 ubnt dhcpd3: exiting.
```

To fix this, any files which are referenced in the EdgeOS config need to be stored in the /config directory. Updating the docs to fix this reference, so others don't get bitten by this.

Signed-off-by: Russell Troxel <russell@troxel.io>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-11-24 15:40:46 +04:00
Tim Jones
831761aeff
fix: docs sitemap www prefix
Fixes the missing "www." prefix to the url in the
sitemap section of the docs website.

Signed-off-by: Tim Jones <tim.jones@siderolabs.com>
2022-09-07 10:32:22 +02:00
Tim Jones
2b2ed86e1c
docs: fix dead link in serverclasses guide
Link from Server Classes guide to patching guide fixed.

Signed-off-by: Tim Jones <tim.jones@siderolabs.com>
2022-09-06 19:40:11 +02:00
Tim Jones
5527432ddf
fix: canonical links in docs site
Fixes canonical link for the documentation website.

Signed-off-by: Tim Jones <tim.jones@siderolabs.com>
2022-09-06 18:52:44 +02:00
Spencer Smith
7cb28fccfe
docs: handle latest version banner and canonical urls
This PR is a copy of two PRs from talos:

https://github.com/siderolabs/talos/pull/5389/files
https://github.com/siderolabs/talos/pull/5391/files

It ensures that the banner is shown if the user isn't viewing the latest
sidero docs. This actually already was working but the banner html was in an incorrect spot, so moved that to match what's seen in Talos repo. Also adds the canonical links for search engines to update their
indexes.

Signed-off-by: Spencer Smith <spencer.smith@talos-systems.com>
2022-08-05 17:24:49 -04:00
Zach Bernstein
a06135a96e
docs: use ipxe-sanboot for raspberry pi 4's
Use ipxe-sanboot for Rpi's

Signed-off-by: Noel Georgi <git@frezbo.dev>
2022-06-09 23:51:27 +05:30
Steve Francis
6c6b3546e4
docs: edit for clarity and conciseness
Some docs fixes.

Signed-off-by: Steve Francis <steve.francis@talos-systems.com>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-05-12 20:40:10 +03:00
Martin Sweeny
609285488e
docs: fix spelling mistake
Fix typo

Signed-off-by: Noel Georgi <git@frezbo.dev>
2022-04-20 11:26:06 +05:30
Andrey Smirnov
835d5cf227
docs: fix links and getting started overview
Fixes #825

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-04-18 20:20:56 +03:00
Andrey Smirnov
7c7a377857
feat: add extended hardware information to Server and ServerClass CRDs
This is final part of #735, previous part in #823.

This imports all remaining changes with some fixups minus the webhook
changes.

This change adds detailed hardware information to the Server CRD.
Hardware info is extracted by the agent from SMBIOS.
The ServerClass CRD is also updated so more precise qualifiers can be used.

Co-authored-by: Gerard de Leeuw <gdeleeuw@leeuwit.nl>
Signed-off-by: Gerard de Leeuw <gdeleeuw@leeuwit.nl>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-04-15 20:43:07 +03:00
Andrey Smirnov
6c81518b17
docs: fork docs for Sidero 0.6
Revert changes for deployment strategy, as they're not actually in 0.5.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-04-13 23:20:32 +03:00
Andrey Smirnov
061ee8e57d
refactor: remove pre-ServerBinding leftovers, use remote cached clients
This PR has two major changes:

* retire the code which supported seamless migration from
pre-ServerBinding era to ServerBindings: creating `ServerBinding` on the
fly from the `MetalMachine` and `Server`; as there's no migration path
from pre-ServerBinding Sidero to the new version, it's time to drop it
* instead of creating workload cluster Kubernetes client each time, use
CAPI standard class to cache the client; the problem with "leaking"
clients is that HTTP/2 clients are almost never gc'ed, so they stay in
memory keeping an open connection with keepalives going both ways, so
caching lowers the load both on the controller and the control plane
endpoint

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-04-12 22:35:46 +03:00
JJGadgets
fd34779bf7
docs: add info about GitHub Org rename to v0.5 docs
While attempting to follow the v0.5 install instructions currently put up on the Sidero website, I encountered the target namespace error, and had to search further to find the solution in https://github.com/siderolabs/cluster-api-bootstrap-provider-talos/blob/master/README.md#installing

This PR adds the info to the Sidero v0.5 install docs, which to my knowledge the files in the repo is directly rendered by the https://sidero.dev website.

Signed-off-by: Spencer Smith <spencer.smith@talos-systems.com>
2022-04-08 13:51:10 -04:00
Spencer Smith
c86953e11c
docs: update algolia info
This PR updates with the proper algolia info so we can actually have
search

Signed-off-by: Spencer Smith <spencer.smith@talos-systems.com>
2022-04-08 11:40:20 -04:00
Spencer Smith
37a1d52696
docs: add sitemap override
This PR adds the sitemap template for sidero so we can submit for better
SEO in google.

Signed-off-by: Spencer Smith <spencer.smith@talos-systems.com>
2022-04-04 10:44:16 -04:00
Gerard de Leeuw
54f896dd67
feat: allow configuring Sidero deployment strategy
Upgrading Sidero on a single-node cluster with host networking enabled fails because the used ports can only be bound once. By setting the deployment strategy to `Recreate` in these cases upgrades can succeed (but with a small amount of downtime).

Signed-off-by: Gerard de Leeuw <gdeleeuw@leeuwit.nl>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-04-01 18:16:51 +03:00
Spencer Smith
b7cc8b2e40
docs: switch code block to text for DHCP prereq
This PR fixes a turbo-nit where the configs for the DHCP settings
weren't getting processed as code blocks

Signed-off-by: Spencer Smith <spencer.smith@talos-systems.com>
2022-03-31 11:55:28 -04:00
Spencer Smith
9f9c92205c
docs: move docs to hugo
This PR moves our docs to match what's in Talos

Signed-off-by: Spencer Smith <spencer.smith@talos-systems.com>
2022-03-30 21:13:05 -04:00
Andrey Smirnov
13e11d3320
chore: bump dependencies
Some via dependabot, some via go-mod-outdated.

This also bumps CAPI to the latest.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-02-15 21:03:12 +03:00
Andrey Smirnov
d3e75dc9be
docs: make 0.5 docs the default, add what's new
I renumbered weights a bit to make it easier to insert items.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-02-14 23:42:04 +03:00
Andrey Smirnov
36ebc2a056
docs: document SideroLink and other 0.5.0 new features
Includes bumps to the pkgs/tools for Go 1.17.7 and new kernel version.

Added clusterctl move label to the `siderolink` root secret.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-02-14 19:17:12 +03:00
Andrey Smirnov
0a967a8c3f
feat: configure boot from disk method on Server/ServerClass level
Fixes #661

Also added docs for new field and other missing spec fields.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-02-04 17:34:57 +03:00
Steve Francis
c73d8e52b1
docs: update to Sidero from Talos
Improve the description of how to get started.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-01-31 22:52:03 +03:00
Steve Francis
f28d7b0b53
docs: update README and index page
PRs: #719 #720

Co-authored-by: Steve Francis <steve.francis@siderolabs.com>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
Signed-off-by: Steve Francis <steve.francis@siderolabs.com>
2022-01-18 22:29:09 +03:00
Steve Francis
34f7822c3f
docs: fixes to the homepage, footer, log
From PRs #706 #707 #708 #709

Co-authored-by: Steve Francis <steve.francis@siderolabs.com>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
Signed-off-by: Steve Francis <steve.francis@siderolabs.com>
2022-01-17 15:30:41 +03:00
Andrey Smirnov
682594c4fd
docs: update index.md and sync across versions
See #703

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-01-12 21:54:56 +03:00
Seán C McCord
1f7588f1fa
docs: update office hours
Updated the office hours to match Talos office hours.

Signed-off-by: Seán C McCord <ulexus@gmail.com>
2022-01-10 13:04:34 -05:00
Noel Georgi
d69264f7b7
docs: fix patching examples
Fix the patching example

Signed-off-by: Noel Georgi <git@frezbo.dev>
2021-12-24 13:07:44 +05:30
Noel Georgi
04d90fdc61
docs: add patching examples
Add an example to show patching

Signed-off-by: Noel Georgi <git@frezbo.dev>
2021-12-21 21:36:20 +05:30
Andrey Smirnov
41b7451b50
docs: update docs for upcoming Sidero 0.4.1 release
See https://github.com/talos-systems/sidero/pull/669

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2021-12-21 16:45:16 +03:00
Andrey Smirnov
4cfdedaf97
feat: provide a way to configure IPMI PXE method
Fixes #274

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2021-12-09 17:03:31 +03:00
Noel Georgi
2ff14c4528
docs: reflect sidero runs on ARM
Update Sidero requirements

Fixes #514

Signed-off-by: Noel Georgi <git@frezbo.dev>
2021-12-07 18:27:47 +05:30
Andrey Smirnov
ab12b81ef0
feat: implement Talos kernel log receiver
Fixes #527

Talos logs (see https://github.com/talos-systems/talos/pull/4600) are
delivered to Sidero over the SideroLink tunnel.

Logs can be seen with:

```
$ kubectl logs -n sidero-system deployment/sidero-controller-manager -c serverlogs -f
{"clock":67194673,"cluster":"management-cluster","facility":"user","machine":"default/management-cluster-cp-4j8f4","metal_machine":"default/management-cluster-cp-hbq57","msg":"[talos] phase bootloader (19/19): done, 176.795226ms\n","priority":"warning","seq":768,"server_uuid":"5b72932a-c482-4aa5-b00e-4b8773d3ac48","talos-level":"warn","talos-time":"2021-11-26T19:34:42.444342392Z"}
```

Logs are annotated on the fly with the information about `Server`,
`MetalMachine`, `Machine` and `Cluster`.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2021-11-30 23:45:34 +03:00