diff --git a/docs/website/content/docs/v0.3/Configuration/environments.md b/docs/website/content/docs/v0.3/Configuration/environments.md index f76f3ceff..f860e282d 100644 --- a/docs/website/content/docs/v0.3/Configuration/environments.md +++ b/docs/website/content/docs/v0.3/Configuration/environments.md @@ -27,7 +27,7 @@ metadata: name: default spec: kernel: - url: "https://github.com/talos-systems/talos/releases/download/v0.8.1/vmlinuz-amd64" + url: "https://github.com/talos-systems/talos/releases/download/v0.10.2/vmlinuz-amd64" sha512: "" args: - init_on_alloc=1 @@ -47,7 +47,7 @@ spec: - talos.platform=metal - talos.config=http://$PUBLIC_IP:8081/configdata?uuid= initrd: - url: "https://github.com/talos-systems/talos/releases/download/v0.8.1/initramfs-amd64.xz" + url: "https://github.com/talos-systems/talos/releases/download/v0.10.2/initramfs-amd64.xz" sha512: "" ``` diff --git a/docs/website/content/docs/v0.3/Configuration/metadata.md b/docs/website/content/docs/v0.3/Configuration/metadata.md index 5ea473a16..a90c7bd0f 100644 --- a/docs/website/content/docs/v0.3/Configuration/metadata.md +++ b/docs/website/content/docs/v0.3/Configuration/metadata.md @@ -7,7 +7,7 @@ weight: 4 The Metadata server manages the Machine metadata. In terms of Talos (the OS on which the Kubernetes cluster is formed), this is the -"[machine config](https://www.talos.dev/docs/v0.8/reference/configuration/)", +"[machine config](https://www.talos.dev/docs/v0.10/reference/configuration/)", which is used during the automated installation. ## Talos Machine Configuration diff --git a/docs/website/content/docs/v0.3/Getting Started/installation.md b/docs/website/content/docs/v0.3/Getting Started/installation.md index 7a5508168..04c5c8adc 100644 --- a/docs/website/content/docs/v0.3/Getting Started/installation.md +++ b/docs/website/content/docs/v0.3/Getting Started/installation.md @@ -24,3 +24,13 @@ 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 provides two endpoints which should be made available to the infrastructure: + +* TCP port 8081 which provides combined iPXE, metadata and gRPC service (external endpoint should be passed to Sidero as `SIDERO_CONTROLLER_MANAGER_API_ENDPOINT` and `SIDERO_CONTROLLER_MANAGER_API_PORT`) +* UDP port 69 for the TFTP service (DHCP server should point the nodes to PXE boot from that IP) + +These endpoints could be exposed to the infrastructure using different strategies: + +* running `sidero-controller-manager` on the host network. +* using Kubernetes load balancers (e.g. MetalLB), ingress controllers, etc. diff --git a/docs/website/content/docs/v0.3/Getting Started/introduction.md b/docs/website/content/docs/v0.3/Getting Started/introduction.md index dc90dc46d..56b7f04bc 100755 --- a/docs/website/content/docs/v0.3/Getting Started/introduction.md +++ b/docs/website/content/docs/v0.3/Getting Started/introduction.md @@ -1,32 +1,31 @@ ---- -description: "" -weight: 1 ---- - -# Introduction - -Sidero ("Iron" in Greek) is a project created by the [Talos Systems](https://www.talos-systems.com/) team. -The goal of this project is to provide lightweight, composable tools that can be used to create bare-metal Talos + Kubernetes clusters. -These tools are built around the Cluster API project. -Sidero is also a subproject of Talos Systems' [Arges](https://github.com/talos-systems/arges) project, which will publish known-good versions of these components (along with others) with each release. - -## Overview - -Sidero is made currently made up of three components: - -- Metal Metadata Server: Provides a Cluster API (CAPI)-aware metadata server -- Metal Controller Manager: Provides custom resources and controllers for managing the lifecycle of metal machines -- Cluster API Provider Sidero (CAPS): A Cluster API infrastructure provider that makes use of the pieces above to spin up Kubernetes clusters - -Sidero also needs these co-requisites in order to be useful: - -- [Cluster API](https://github.com/kubernetes-sigs/cluster-api) -- [Cluster API Control Plane Provider Talos](https://github.com/talos-systems/cluster-api-control-plane-provider-talos) -- [Cluster API Bootstrap Provider Talos](https://github.com/talos-systems/cluster-api-bootstrap-provider-talos) - -All componenets mentioned above can be installed using Cluster API's `clusterctl` tool. - -Because of the design of Cluster API, there is inherently a "chicken and egg" problem with needing an existing Kubernetes cluster in order to provision the management plane. -Talos Systems and the Cluster API community have created tools to help make this transition easier. -That being said, the management plane cluster does not have to be based on Talos. -If you would, however, like to use Talos as the OS of choice for the Sidero management plane, you can find a number of ways to deploy Talos in the [documentation](https://www.talos.dev). +--- +description: "" +weight: 1 +--- + +# Introduction + +Sidero ("Iron" in Greek) is a project created by the [Talos Systems](https://www.talos-systems.com/) team. +The goal of this project is to provide lightweight, composable tools that can be used to create bare-metal Talos + Kubernetes clusters. +These tools are built around the Cluster API project. +Sidero is also a subproject of Talos Systems' [Arges](https://github.com/talos-systems/arges) project, which will publish known-good versions of these components (along with others) with each release. + +## Overview + +Sidero is currently made up of two components: + +- Metal Controller Manager: Provides custom resources and controllers for managing the lifecycle of metal machines, iPXE server, metadata service, and gRPC API service +- Cluster API Provider Sidero (CAPS): A Cluster API infrastructure provider that makes use of the pieces above to spin up Kubernetes clusters + +Sidero also needs these co-requisites in order to be useful: + +- [Cluster API](https://github.com/kubernetes-sigs/cluster-api) +- [Cluster API Control Plane Provider Talos](https://github.com/talos-systems/cluster-api-control-plane-provider-talos) +- [Cluster API Bootstrap Provider Talos](https://github.com/talos-systems/cluster-api-bootstrap-provider-talos) + +All components mentioned above can be installed using Cluster API's `clusterctl` tool. + +Because of the design of Cluster API, there is inherently a "chicken and egg" problem with needing an existing Kubernetes cluster in order to provision the management plane. +Talos Systems and the Cluster API community have created tools to help make this transition easier. +That being said, the management plane cluster does not have to be based on Talos. +If you would, however, like to use Talos as the OS of choice for the Sidero management plane, you can find a number of ways to deploy Talos in the [documentation](https://www.talos.dev).