From 0e7f8a6820dc77a28d0d264b7e2dd216dab54eb0 Mon Sep 17 00:00:00 2001 From: Noel Georgi Date: Tue, 16 Nov 2021 18:06:22 +0530 Subject: [PATCH] docs: metadata server -> sidero - Updates metadata server to reflect Sidero Controller Manager - Few typos and broken links Signed-off-by: Noel Georgi --- website/content/docs/v0.3/Getting Started/prereq-dhcp.md | 2 +- .../content/docs/v0.4/Getting Started/expose-services.md | 2 +- website/content/docs/v0.4/Getting Started/index.md | 2 +- website/content/docs/v0.4/Guides/decommissioning.md | 2 +- website/content/docs/v0.4/Guides/iso.md | 2 +- website/content/docs/v0.4/Overview/resources.md | 8 ++++---- .../content/docs/v0.4/Resource Configuration/metadata.md | 2 +- .../content/docs/v0.5/Getting Started/expose-services.md | 2 +- website/content/docs/v0.5/Getting Started/index.md | 2 +- website/content/docs/v0.5/Guides/decommissioning.md | 2 +- website/content/docs/v0.5/Guides/iso.md | 2 +- website/content/docs/v0.5/Overview/resources.md | 8 ++++---- .../content/docs/v0.5/Resource Configuration/metadata.md | 2 +- 13 files changed, 19 insertions(+), 19 deletions(-) diff --git a/website/content/docs/v0.3/Getting Started/prereq-dhcp.md b/website/content/docs/v0.3/Getting Started/prereq-dhcp.md index 878a430c9..562e3bba2 100644 --- a/website/content/docs/v0.3/Getting Started/prereq-dhcp.md +++ b/website/content/docs/v0.3/Getting Started/prereq-dhcp.md @@ -139,4 +139,4 @@ We are working toward integrating as much as possible into Sidero, to provide as much intelligence and automation as can be had, but until then, you will likely need to figure out how to begin hunting down problems. -See the Sidero [Troubleshooting](troubleshooting) guide for more assistance. +See the Sidero [Troubleshooting](../troubleshooting) guide for more assistance. diff --git a/website/content/docs/v0.4/Getting Started/expose-services.md b/website/content/docs/v0.4/Getting Started/expose-services.md index 32a047afb..ee876d60a 100644 --- a/website/content/docs/v0.4/Getting Started/expose-services.md +++ b/website/content/docs/v0.4/Getting Started/expose-services.md @@ -11,7 +11,7 @@ reachable by the servers which it will be driving. For most servers, TFTP (port 69/udp) will be needed. This is used for PXE booting, both BIOS and UEFI. -Being a primitive UDP protocl, many load balancers do not support TFTP. +Being a primitive UDP protocol, many load balancers do not support TFTP. Instead, solutions such as [MetalLB](https://metallb.universe.tf) may be used to expose TFTP over a known IP address. For servers which support UEFI HTTP Network Boot, TFTP need not be used. diff --git a/website/content/docs/v0.4/Getting Started/index.md b/website/content/docs/v0.4/Getting Started/index.md index 41643ba9e..3ba49fb11 100644 --- a/website/content/docs/v0.4/Getting Started/index.md +++ b/website/content/docs/v0.4/Getting Started/index.md @@ -56,6 +56,6 @@ More information about Talos can be found at **Workload Cluster** is a cluster, managed by Sidero, on which your Kubernetes workloads may be run. -The workload clusters are where you run your own applications and infrastruture. +The workload clusters are where you run your own applications and infrastructure. Sidero creates them from your available resources, maintains them over time as your needs and resources change, and removes them whenever it is told to do so. diff --git a/website/content/docs/v0.4/Guides/decommissioning.md b/website/content/docs/v0.4/Guides/decommissioning.md index 46e82f300..3b41880aa 100644 --- a/website/content/docs/v0.4/Guides/decommissioning.md +++ b/website/content/docs/v0.4/Guides/decommissioning.md @@ -16,7 +16,7 @@ The process is fairly simple with a few pieces of information. - If the server is already part of a cluster (`kubectl get serverbindings` should provide this info), you can now delete the machine that corresponds with this server via `kubectl delete machine `. -- With the machine deleted, Sideo will reboot the machine and wipe its disks. +- With the machine deleted, Sidero will reboot the machine and wipe its disks. - Once the disk wiping is complete and the server is turned off, you can finally delete the server from Sidero with `kubectl delete server ` and repurpose the server for something else. diff --git a/website/content/docs/v0.4/Guides/iso.md b/website/content/docs/v0.4/Guides/iso.md index cb9e8958e..1d666a70e 100644 --- a/website/content/docs/v0.4/Guides/iso.md +++ b/website/content/docs/v0.4/Guides/iso.md @@ -18,6 +18,6 @@ The rough outline of this process is very short and sweet, as it relies on other - With a Kubernetes cluster now in hand (and with access to it via `talosctl` and `kubectl`), you can simply pickup the Getting Started tutorial at the "Install Sidero" section [here](../../getting-started/install-clusterapi). Keep in mind, however, that you will be unable to do the "pivoting" section of the tutorial, so just skip that step when you reach the end of the tutorial. -> Note: It may also be of interest to view the prereq guides on [CLI](../../getting-started/prereq-cli-tools) and [DHCP](../../getting-started/prereq-dhcp) setup, as they will still apply to this method. +> Note: It may also be of interest to view the prerequisite guides on [CLI](../../getting-started/prereq-cli-tools) and [DHCP](../../getting-started/prereq-dhcp) setup, as they will still apply to this method. - For long-term maintenance of a management plane created in this way, refer to the Talos documentation for upgrading [Kubernetes](https://www.talos.dev/docs/v0.13/guides/upgrading-kubernetes/) and [Talos](https://www.talos.dev/docs/v0.13/guides/upgrading-talos/) itself. diff --git a/website/content/docs/v0.4/Overview/resources.md b/website/content/docs/v0.4/Overview/resources.md index abc1996b5..8c82f9622 100644 --- a/website/content/docs/v0.4/Overview/resources.md +++ b/website/content/docs/v0.4/Overview/resources.md @@ -106,13 +106,13 @@ These can be used to compose a bank of `Servers` that are eligible for provision See the [ServerClasses](../../resource-configuration/serverclasses/) section of our Configuration docs for examples and more detail. -### Metal Metadata Server +### Sidero Controller Manager -While the metadata server does not present unique CRDs within Kubernetes, it's important to understand the metadata resources that are returned to physical servers during the boot process. +While the controller does not present unique CRDs within Kubernetes, it's important to understand the metadata resources that are returned to physical servers during the boot process. #### Metadata -The metadata server may be familiar to you if you have used cloud environments previously. -Using Talos machine configurations created by the Talos Cluster API bootstrap provider, along with patches specified by editing `Server`/`ServerClass` resources or `TalosConfig`/`TalosControlPlane` resources, metadata is returned to servers who query the metadata server at boot time. +The Sidero controller manager server may be familiar to you if you have used cloud environments previously. +Using Talos machine configurations created by the Talos Cluster API bootstrap provider, along with patches specified by editing `Server`/`ServerClass` resources or `TalosConfig`/`TalosControlPlane` resources, metadata is returned to servers who query the controller manager at boot time. See the [Metadata](../../resource-configuration/metadata/) section of our Configuration docs for examples and more detail. diff --git a/website/content/docs/v0.4/Resource Configuration/metadata.md b/website/content/docs/v0.4/Resource Configuration/metadata.md index 2d0936467..892dbbe23 100644 --- a/website/content/docs/v0.4/Resource Configuration/metadata.md +++ b/website/content/docs/v0.4/Resource Configuration/metadata.md @@ -4,7 +4,7 @@ weight: 4 title: Metadata --- -The Metadata server manages the Machine metadata. +The Sidero controller manager 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.13/reference/configuration/)", which is used during the automated installation. diff --git a/website/content/docs/v0.5/Getting Started/expose-services.md b/website/content/docs/v0.5/Getting Started/expose-services.md index 32a047afb..ee876d60a 100644 --- a/website/content/docs/v0.5/Getting Started/expose-services.md +++ b/website/content/docs/v0.5/Getting Started/expose-services.md @@ -11,7 +11,7 @@ reachable by the servers which it will be driving. For most servers, TFTP (port 69/udp) will be needed. This is used for PXE booting, both BIOS and UEFI. -Being a primitive UDP protocl, many load balancers do not support TFTP. +Being a primitive UDP protocol, many load balancers do not support TFTP. Instead, solutions such as [MetalLB](https://metallb.universe.tf) may be used to expose TFTP over a known IP address. For servers which support UEFI HTTP Network Boot, TFTP need not be used. diff --git a/website/content/docs/v0.5/Getting Started/index.md b/website/content/docs/v0.5/Getting Started/index.md index 41643ba9e..3ba49fb11 100644 --- a/website/content/docs/v0.5/Getting Started/index.md +++ b/website/content/docs/v0.5/Getting Started/index.md @@ -56,6 +56,6 @@ More information about Talos can be found at **Workload Cluster** is a cluster, managed by Sidero, on which your Kubernetes workloads may be run. -The workload clusters are where you run your own applications and infrastruture. +The workload clusters are where you run your own applications and infrastructure. Sidero creates them from your available resources, maintains them over time as your needs and resources change, and removes them whenever it is told to do so. diff --git a/website/content/docs/v0.5/Guides/decommissioning.md b/website/content/docs/v0.5/Guides/decommissioning.md index 46e82f300..3b41880aa 100644 --- a/website/content/docs/v0.5/Guides/decommissioning.md +++ b/website/content/docs/v0.5/Guides/decommissioning.md @@ -16,7 +16,7 @@ The process is fairly simple with a few pieces of information. - If the server is already part of a cluster (`kubectl get serverbindings` should provide this info), you can now delete the machine that corresponds with this server via `kubectl delete machine `. -- With the machine deleted, Sideo will reboot the machine and wipe its disks. +- With the machine deleted, Sidero will reboot the machine and wipe its disks. - Once the disk wiping is complete and the server is turned off, you can finally delete the server from Sidero with `kubectl delete server ` and repurpose the server for something else. diff --git a/website/content/docs/v0.5/Guides/iso.md b/website/content/docs/v0.5/Guides/iso.md index cb9e8958e..1d666a70e 100644 --- a/website/content/docs/v0.5/Guides/iso.md +++ b/website/content/docs/v0.5/Guides/iso.md @@ -18,6 +18,6 @@ The rough outline of this process is very short and sweet, as it relies on other - With a Kubernetes cluster now in hand (and with access to it via `talosctl` and `kubectl`), you can simply pickup the Getting Started tutorial at the "Install Sidero" section [here](../../getting-started/install-clusterapi). Keep in mind, however, that you will be unable to do the "pivoting" section of the tutorial, so just skip that step when you reach the end of the tutorial. -> Note: It may also be of interest to view the prereq guides on [CLI](../../getting-started/prereq-cli-tools) and [DHCP](../../getting-started/prereq-dhcp) setup, as they will still apply to this method. +> Note: It may also be of interest to view the prerequisite guides on [CLI](../../getting-started/prereq-cli-tools) and [DHCP](../../getting-started/prereq-dhcp) setup, as they will still apply to this method. - For long-term maintenance of a management plane created in this way, refer to the Talos documentation for upgrading [Kubernetes](https://www.talos.dev/docs/v0.13/guides/upgrading-kubernetes/) and [Talos](https://www.talos.dev/docs/v0.13/guides/upgrading-talos/) itself. diff --git a/website/content/docs/v0.5/Overview/resources.md b/website/content/docs/v0.5/Overview/resources.md index abc1996b5..8c82f9622 100644 --- a/website/content/docs/v0.5/Overview/resources.md +++ b/website/content/docs/v0.5/Overview/resources.md @@ -106,13 +106,13 @@ These can be used to compose a bank of `Servers` that are eligible for provision See the [ServerClasses](../../resource-configuration/serverclasses/) section of our Configuration docs for examples and more detail. -### Metal Metadata Server +### Sidero Controller Manager -While the metadata server does not present unique CRDs within Kubernetes, it's important to understand the metadata resources that are returned to physical servers during the boot process. +While the controller does not present unique CRDs within Kubernetes, it's important to understand the metadata resources that are returned to physical servers during the boot process. #### Metadata -The metadata server may be familiar to you if you have used cloud environments previously. -Using Talos machine configurations created by the Talos Cluster API bootstrap provider, along with patches specified by editing `Server`/`ServerClass` resources or `TalosConfig`/`TalosControlPlane` resources, metadata is returned to servers who query the metadata server at boot time. +The Sidero controller manager server may be familiar to you if you have used cloud environments previously. +Using Talos machine configurations created by the Talos Cluster API bootstrap provider, along with patches specified by editing `Server`/`ServerClass` resources or `TalosConfig`/`TalosControlPlane` resources, metadata is returned to servers who query the controller manager at boot time. See the [Metadata](../../resource-configuration/metadata/) section of our Configuration docs for examples and more detail. diff --git a/website/content/docs/v0.5/Resource Configuration/metadata.md b/website/content/docs/v0.5/Resource Configuration/metadata.md index 2d0936467..892dbbe23 100644 --- a/website/content/docs/v0.5/Resource Configuration/metadata.md +++ b/website/content/docs/v0.5/Resource Configuration/metadata.md @@ -4,7 +4,7 @@ weight: 4 title: Metadata --- -The Metadata server manages the Machine metadata. +The Sidero controller manager 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.13/reference/configuration/)", which is used during the automated installation.