Skip to content

Commit

Permalink
docs: update docs for upcoming Sidero 0.4.1 release
Browse files Browse the repository at this point in the history
See #669

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
  • Loading branch information
smira committed Dec 21, 2021
1 parent d5f8f4e commit 41b7451
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 7 deletions.
12 changes: 9 additions & 3 deletions website/content/docs/v0.4/Guides/first-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There will be two main steps in this guide: reconfiguring the Sidero components

### Patch Services

In this guide, we will convert the metadata service to a NodePort service and the other services to use host networking.
In this guide, we will convert the services to use host networking.
This is also necessary because some protocols like TFTP don't allow for port configuration.
Along with some nodeSelectors and a scale up of the metal controller manager deployment, creating the services this way allows for the creation of DNS names that point to all management plane nodes and provide an HA experience if desired.
It should also be noted, however, that there are many options for achieving this functionality.
Expand All @@ -28,8 +28,14 @@ kubectl patch deploy -n sidero-system sidero-controller-manager --type='json' -p

#### Update Environment

The metadata server's information needs to be updated in the default environment.
Edit the environment with `kubectl edit environment default` and update the `talos.config` kernel arg with the IP of one of the management plane nodes (or the DNS entry you created).
<!-- textlint-disable -->

Sidero by default appends `talos.config` kernel argument with based on the flags `--api-endpoint` and `--api-port` to the `sidero-controller-manager`:
`talos.config=http://$API_ENDPOINT:$API_PORT/configdata?uuid=`.

<!-- textlint-enable -->

If this default value doesn't apply, edit the environment with `kubectl edit environment default` and add the `talos.config` kernel arg with the IP of one of the management plane nodes (or the DNS entry you created).

### Update DHCP

Expand Down
1 change: 1 addition & 0 deletions website/content/docs/v0.4/Overview/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ variables or as variables in the `clusterctl` configuration:
- `SIDERO_CONTROLLER_MANAGER_AUTO_BMC_SETUP` (`true`): automatically attempt to configure the BMC with a `sidero` user that will be used for all IPMI tasks.
- `SIDERO_CONTROLLER_MANAGER_INSECURE_WIPE` (`true`): wipe only the first megabyte of each disk on the server, otherwise wipe the full disk
- `SIDERO_CONTROLLER_MANAGER_SERVER_REBOOT_TIMEOUT` (`20m`): timeout for the server reboot (how long it might take for the server to be rebooted before Sidero retries an IPMI reboot operation)
- `SIDERO_CONTROLLER_MANAGER_IPMI_PXE_METHOD` (`uefi`): IPMI boot from PXE method: `uefi` for UEFI boot or `bios` for BIOS boot
- `SIDERO_CONTROLLER_MANAGER_BOOT_FROM_DISK_METHOD` (`ipxe-exit`): configures the way Sidero forces server to boot from disk when server hits iPXE server after initial install: `ipxe-exit` returns iPXE script with `exit` command, `http-404` returns HTTP 404 Not Found error, `ipxe-sanboot` uses iPXE `sanboot` command to boot from the first hard disk

Sidero provides two endpoints which should be made available to the infrastructure:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ spec:
- pti=on
- random.trust_cpu=on
- slab_nomerge=
- talos.config=http://$PUBLIC_IP:8081/configdata?uuid=
- talos.platform=metal
initrd:
url: "https://github.com/talos-systems/talos/releases/download/v0.13.3/initramfs-amd64.xz"
Expand Down
4 changes: 1 addition & 3 deletions website/content/docs/v0.5/Guides/first-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There will be two main steps in this guide: reconfiguring the Sidero components

### Patch Services

In this guide, we will convert the metadata service to a NodePort service and the other services to use host networking.
In this guide, we will convert the services to use host networking.
This is also necessary because some protocols like TFTP don't allow for port configuration.
Along with some nodeSelectors and a scale up of the metal controller manager deployment, creating the services this way allows for the creation of DNS names that point to all management plane nodes and provide an HA experience if desired.
It should also be noted, however, that there are many options for achieving this functionality.
Expand All @@ -28,8 +28,6 @@ kubectl patch deploy -n sidero-system sidero-controller-manager --type='json' -p

#### Update Environment

The metadata server's information might need to be updated in the default environment.

<!-- textlint-disable -->

Sidero by default appends `talos.config` kernel argument with based on the flags `--api-endpoint` and `--api-port` to the `sidero-controller-manager`:
Expand Down

0 comments on commit 41b7451

Please sign in to comment.