diff --git a/website/content/v1.0/_index.md b/website/content/v1.0/_index.md index 5f5935473..11f52c579 100644 --- a/website/content/v1.0/_index.md +++ b/website/content/v1.0/_index.md @@ -16,9 +16,9 @@ menu: main Welcome to the Talos documentation. If you are just getting familiar with Talos, we recommend starting here: -- [What is Talos](introduction/what-is-talos/): a quick description of Talos -- [Quickstart](introduction/quickstart/): the fastest way to get a Talos cluster up and running -- [Getting Started](introduction/getting-started/): a long-form, guided tour of getting a full Talos cluster deployed +- [What is Talos]({{< relref "introduction/what-is-talos" >}}): a quick description of Talos +- [Quickstart]({{< relref "introduction/quickstart" >}}): the fastest way to get a Talos cluster up and running +- [Getting Started]({{< relref "introduction/getting-started" >}}): a long-form, guided tour of getting a full Talos cluster deployed ## Open Source diff --git a/website/content/v1.0/advanced/_index.md b/website/content/v1.0/advanced/_index.md new file mode 100644 index 000000000..3b85c2391 --- /dev/null +++ b/website/content/v1.0/advanced/_index.md @@ -0,0 +1,4 @@ +--- +title: "Advanced Guides" +weight: 60 +--- diff --git a/website/content/v1.1/guides/advanced-networking.md b/website/content/v1.0/advanced/advanced-networking.md similarity index 93% rename from website/content/v1.1/guides/advanced-networking.md rename to website/content/v1.0/advanced/advanced-networking.md index 8361db677..11090497d 100644 --- a/website/content/v1.1/guides/advanced-networking.md +++ b/website/content/v1.0/advanced/advanced-networking.md @@ -1,5 +1,8 @@ --- title: "Advanced Networking" +description: "How to configure advanced networking options on Talos Linux." +aliases: + - ../guides/advanced-networking --- ## Static Addressing diff --git a/website/content/v1.0/guides/air-gapped.md b/website/content/v1.0/advanced/air-gapped.md similarity index 91% rename from website/content/v1.0/guides/air-gapped.md rename to website/content/v1.0/advanced/air-gapped.md index d34525c53..80c5903fc 100644 --- a/website/content/v1.0/guides/air-gapped.md +++ b/website/content/v1.0/advanced/air-gapped.md @@ -1,16 +1,19 @@ --- -title: Air-gapped Environments +title: "Air-gapped Environments" +description: "Setting up Talos Linux to work in environments with no internet access." +aliases: + - ../guides/air-gapped --- In this guide we will create a Talos cluster running in an air-gapped environment with all the required images being pulled from an internal registry. -We will use the [QEMU](../../local-platforms/qemu/) provisioner available in `talosctl` to create a local cluster, but the same approach could be used to deploy Talos in bigger air-gapped networks. +We will use the [QEMU]({{< relref "../talos-guides/install/local-platforms/qemu" >}}) provisioner available in `talosctl` to create a local cluster, but the same approach could be used to deploy Talos in bigger air-gapped networks. ## Requirements The follow are requirements for this guide: - Docker 18.03 or greater -- Requirements for the Talos [QEMU](../../local-platforms/qemu/) cluster +- Requirements for the Talos [QEMU]({{< relref "../talos-guides/install/local-platforms/qemu" >}}) cluster ## Identifying Images diff --git a/website/content/v1.0/guides/customizing-the-kernel.md b/website/content/v1.0/advanced/customizing-the-kernel.md similarity index 93% rename from website/content/v1.0/guides/customizing-the-kernel.md rename to website/content/v1.0/advanced/customizing-the-kernel.md index 0da33e3ad..bdb83d4e8 100644 --- a/website/content/v1.0/guides/customizing-the-kernel.md +++ b/website/content/v1.0/advanced/customizing-the-kernel.md @@ -1,6 +1,8 @@ --- title: "Customizing the Kernel" -description: "" +description: "Guide on how to customize the kernel used by Talos Linux." +aliases: + - ../guides/customizing-the-kernel --- The installer image contains [`ONBUILD`](https://docs.docker.com/engine/reference/builder/#onbuild) instructions that handle the following: diff --git a/website/content/v1.0/guides/customizing-the-root-filesystem.md b/website/content/v1.0/advanced/customizing-the-root-filesystem.md similarity index 93% rename from website/content/v1.0/guides/customizing-the-root-filesystem.md rename to website/content/v1.0/advanced/customizing-the-root-filesystem.md index 7009aa55d..2e7eaabbe 100644 --- a/website/content/v1.0/guides/customizing-the-root-filesystem.md +++ b/website/content/v1.0/advanced/customizing-the-root-filesystem.md @@ -1,6 +1,8 @@ --- title: "Customizing the Root Filesystem" -description: "" +description: "How to add your own content to the immutable root file system of Talos Linux." +aliases: + - ../guides/customizing-the-root-filesystem --- The installer image contains [`ONBUILD`](https://docs.docker.com/engine/reference/builder/#onbuild) instructions that handle the following: diff --git a/website/content/v1.1/learn-more/developing-talos.md b/website/content/v1.0/advanced/developing-talos.md similarity index 98% rename from website/content/v1.1/learn-more/developing-talos.md rename to website/content/v1.0/advanced/developing-talos.md index 07b643b31..52c640fe1 100644 --- a/website/content/v1.1/learn-more/developing-talos.md +++ b/website/content/v1.0/advanced/developing-talos.md @@ -1,6 +1,8 @@ --- title: "Developing Talos" -weight: 130 +description: "Learn how to set up a development environment for local testing and hacking on Talos itself!" +aliases: + - ../learn-more/developing-talos --- This guide outlines steps and tricks to develop Talos operating systems and related components. diff --git a/website/content/v1.0/guides/disaster-recovery.md b/website/content/v1.0/advanced/disaster-recovery.md similarity index 99% rename from website/content/v1.0/guides/disaster-recovery.md rename to website/content/v1.0/advanced/disaster-recovery.md index 34eac184d..defe58dd4 100644 --- a/website/content/v1.0/guides/disaster-recovery.md +++ b/website/content/v1.0/advanced/disaster-recovery.md @@ -1,6 +1,8 @@ --- title: "Disaster Recovery" description: "Procedure for snapshotting etcd database and recovering from catastrophic control plane failure." +aliases: + - ../guides/disaster-recovery --- `etcd` database backs Kubernetes control plane state, so if the `etcd` service is unavailable diff --git a/website/content/v1.0/learn-more/extension-services.md b/website/content/v1.0/advanced/extension-services.md similarity index 93% rename from website/content/v1.0/learn-more/extension-services.md rename to website/content/v1.0/advanced/extension-services.md index 35b737190..290228591 100644 --- a/website/content/v1.0/learn-more/extension-services.md +++ b/website/content/v1.0/advanced/extension-services.md @@ -1,13 +1,15 @@ --- title: "Extension Services" -weight: 105 +description: "Use extension services in Talos Linux." +aliases: + - ../learn-more/extention-services --- Talos provides a way to run additional system services early in the Talos boot process. -Extension services should be included into the Talos root filesystem (e.g. using [system extensions](../../guides/system-extensions/)). +Extension services should be included into the Talos root filesystem (e.g. using [system extensions]({{< relref "../talos-guides/configuration/system-extensions" >}})). Extension services run as privileged containers with ephemeral root filesystem located in the Talos root filesystem. -Extension services can be used to use extend core features of Talos in a way that is not possible via [static pods](../../guides/static-pods) or +Extension services can be used to use extend core features of Talos in a way that is not possible via [static pods]({{< relref "../advanced/static-pods" >}}) or Kubernetes DaemonSets. Potential extension services use-cases: diff --git a/website/content/v1.0/guides/adding-a-proprietary-kernel-module.md b/website/content/v1.0/advanced/proprietary-kernel-modules.md similarity index 94% rename from website/content/v1.0/guides/adding-a-proprietary-kernel-module.md rename to website/content/v1.0/advanced/proprietary-kernel-modules.md index 7f935b4db..21e3dc308 100644 --- a/website/content/v1.0/guides/adding-a-proprietary-kernel-module.md +++ b/website/content/v1.0/advanced/proprietary-kernel-modules.md @@ -1,6 +1,8 @@ --- -title: "Adding a proprietary kernel module to Talos Linux" -description: "" +title: "Proprietary Kernel Modules" +description: "Adding a proprietary kernel module to Talos Linux" +aliases: + - ../guides/adding-a-proprietary-kernel-module --- 1. Patching and building the kernel image diff --git a/website/content/v1.1/guides/static-pods.md b/website/content/v1.0/advanced/static-pods.md similarity index 97% rename from website/content/v1.1/guides/static-pods.md rename to website/content/v1.0/advanced/static-pods.md index afbccdb80..da2eaae22 100644 --- a/website/content/v1.1/guides/static-pods.md +++ b/website/content/v1.0/advanced/static-pods.md @@ -1,5 +1,8 @@ --- title: "Static Pods" +description: "Using Talos Linux to set up static pods in Kubernetes." +aliases: + - ../guides/static-pods --- ## Static Pods diff --git a/website/content/v1.1/guides/troubleshooting-control-plane.md b/website/content/v1.0/advanced/troubleshooting-control-plane.md similarity index 98% rename from website/content/v1.1/guides/troubleshooting-control-plane.md rename to website/content/v1.0/advanced/troubleshooting-control-plane.md index b7712014c..defc2875e 100644 --- a/website/content/v1.1/guides/troubleshooting-control-plane.md +++ b/website/content/v1.0/advanced/troubleshooting-control-plane.md @@ -1,6 +1,8 @@ --- title: "Troubleshooting Control Plane" description: "Troubleshoot control plane failures for running cluster and bootstrap process." +aliases: + - ../guides/troubleshooting-control-plane --- @@ -48,7 +50,7 @@ Therefore, the number of control plane nodes should almost always be 3. In some particularly large or distributed clusters, the count may be 5, but this is very rare. -See [this document](../../learn-more/concepts/#control-planes-are-not-linear-replicas) on the topic for more information. +See [this document]({{< relref "../learn-more/concepts#control-planes-are-not-linear-replicas" >}}) on the topic for more information. ### What is the control plane endpoint? @@ -77,7 +79,7 @@ As mentioned above, this can be achieved by a number of strategies, including: - an external load balancer - DNS records -- Talos-builtin shared IP ([VIP](../vip/) +- Talos-builtin shared IP ([VIP]({{< relref "../talos-guides/network/vip" >}})) - BGP peering of a shared IP (such as with [kube-vip](https://kube-vip.io)) Using a DNS name here is usually a good idea, it being the most flexible diff --git a/website/content/v1.0/bare-metal-platforms/_index.md b/website/content/v1.0/bare-metal-platforms/_index.md deleted file mode 100644 index a4c9c94d2..000000000 --- a/website/content/v1.0/bare-metal-platforms/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Bare Metal Platforms" -weight: 20 ---- diff --git a/website/content/v1.0/cloud-platforms/_index.md b/website/content/v1.0/cloud-platforms/_index.md deleted file mode 100644 index 3307f8f0f..000000000 --- a/website/content/v1.0/cloud-platforms/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Cloud Platforms" -weight: 40 ---- diff --git a/website/content/v1.0/guides/_index.md b/website/content/v1.0/guides/_index.md deleted file mode 100644 index 4294954ba..000000000 --- a/website/content/v1.0/guides/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Guides" -weight: 60 ---- diff --git a/website/content/v1.0/introduction/_index.md b/website/content/v1.0/introduction/_index.md index 143d3ae12..a12a4a13c 100644 --- a/website/content/v1.0/introduction/_index.md +++ b/website/content/v1.0/introduction/_index.md @@ -1,4 +1,4 @@ --- title: "Introduction" -weight: 1 +weight: 10 --- diff --git a/website/content/v1.0/introduction/getting-started.md b/website/content/v1.0/introduction/getting-started.md index 2bc8c7884..decc36eff 100644 --- a/website/content/v1.0/introduction/getting-started.md +++ b/website/content/v1.0/introduction/getting-started.md @@ -1,10 +1,11 @@ --- title: Getting Started -weight: 3 +weight: 30 +description: "A guide to setting up a Talos Linux cluster on multiple machines." --- This document will walk you through installing a full Talos Cluster. -You may wish to try the [Quickstart](../quickstart/) first, to quickly create a local virtual cluster on your workstation. +You may wish to try the [Quickstart]({{< relref "quickstart" >}}) first, to quickly create a local virtual cluster on your workstation. Regardless of where you run Talos, there is a pattern to deploying it. In general you need to: @@ -63,7 +64,7 @@ For network booting and self-built media, you can use the published kernel and i - ARM64: [vmlinuz-arm64](https://github.com/siderolabs/talos/releases/download/{{< release >}}/vmlinuz-arm64) [initramfs-arm64.xz](https://github.com/siderolabs/talos/releases/download/{{< release >}}/initramfs-arm64.xz) Note that to use alternate booting, there are a number of required kernel parameters. -Please see the [kernel](../../reference/kernel/) docs for more information. +Please see the [kernel]({{< relref "../reference/kernel" >}}) docs for more information. ## Decide the Kubernetes Endpoint @@ -118,7 +119,7 @@ https://192.168.0.15:6443 You are free to set a DNS record to this IP address to identify the endpoint, but you will need to use the IP address itself, not the DNS name, to configure the shared IP (`machine.network.interfaces[].vip.ip`) in the Talos configuration. For more information about using a shared IP, see the related -[Guide](../../guides/vip/) +[Guide]({{< relref "../talos-guides/network/vip" >}}) ### DNS records @@ -176,7 +177,7 @@ In cases where a PXE server can be available, this is much more efficient than manually configuring each node. If you do use this method, just note that Talos does require a number of other kernel commandline parameters. -See the [required kernel parameters](../../reference/kernel/) for more information. +See the [required kernel parameters]({{< relref "../reference/kernel" >}}) for more information. In either case, we need to generate the configuration which is to be provided. Luckily, the `talosctl` tool comes with a configuration generator for exactly @@ -385,7 +386,7 @@ Server: ``` For a more in-depth discussion of Endpoints and Nodes, please see -[talosctl](../../learn-more/talosctl/). +[talosctl]({{< relref "../learn-more/talosctl" >}}). ### Default configuration file diff --git a/website/content/v1.0/introduction/quickstart.md b/website/content/v1.0/introduction/quickstart.md index 160244638..bd1dbefea 100644 --- a/website/content/v1.0/introduction/quickstart.md +++ b/website/content/v1.0/introduction/quickstart.md @@ -1,6 +1,7 @@ --- title: Quickstart -weight: 2 +weight: 20 +description: "A short guide on setting up a simple Talos Linux cluster locally with Docker." --- There are two easy ways to try out Talos Linux. diff --git a/website/content/v1.0/introduction/support-matrix.md b/website/content/v1.0/introduction/support-matrix.md index f68c6d591..f6d3cb028 100644 --- a/website/content/v1.0/introduction/support-matrix.md +++ b/website/content/v1.0/introduction/support-matrix.md @@ -1,21 +1,22 @@ --- title: Support Matrix -weight: 6 +weight: 60 +description: "Table of supported Talos Linux versions and respective platforms." --- | Talos Version | 1.0 | 0.14 | |----------------------------------------------------------------------------------------------------------------|------------------------------------|------------------------------------| | Release Date | 2022-03-29 | 2021-12-21 (0.14.0) | | End of Community Support | 1.1.0 release (2022-06-01, TBD) | 1.0.0 release (2022-03-27, TBD) | -| Enterprise Support | [offered by Sidero Labs Inc.](https://www.siderolabs.com/support/) | +| Enterprise Support | [offered by Sidero Labs Inc.](https://www.siderolabs.com/support/) | [offered by Sidero Labs Inc.](https://www.siderolabs.com/support/) | | Kubernetes | 1.23, 1.22, 1.21 | 1.23, 1.22, 1.21 | -| Architecture | amd64, arm64 | +| Architecture | amd64, arm64 | amd64, arm64 | | **Platforms** | | | -| - cloud | AWS, GCP, Azure, Digital Ocean, Hetzner, OpenStack, Oracle Cloud, Scaleway, Vultr, Upcloud | AWS, GCP, Azure, Digital Ocean, Hetzner, OpenStack, Scaleway, Vultr, Upcloud | -| - bare metal | x86: BIOS, UEFI; arm64: UEFI; boot: ISO, PXE, disk image | -| - virtualized | VMware, Hyper-V, KVM, Proxmox, Xen | -| - SBCs | Banana Pi M64, Jetson Nano, Libre Computer Board ALL-H3-CC, Pine64, Pine64 Rock64, Radxa ROCK Pi 4c, Raspberry Pi 4B | -| - local | Docker, QEMU | +| - cloud | AWS, GCP, Azure, Digital Ocean, Hetzner, OpenStack, Oracle Cloud, Scaleway, Vultr, Upcloud | AWS, GCP, Azure, Digital Ocean, Hetzner, OpenStack, Scaleway, Vultr, Upcloud | +| - bare metal | x86: BIOS, UEFI; arm64: UEFI; boot: ISO, PXE, disk image | x86: BIOS, UEFI; arm64: UEFI; boot: ISO, PXE, disk image | +| - virtualized | VMware, Hyper-V, KVM, Proxmox, Xen | VMware, Hyper-V, KVM, Proxmox, Xen | +| - SBCs | Banana Pi M64, Jetson Nano, Libre Computer Board ALL-H3-CC, Pine64, Pine64 Rock64, Radxa ROCK Pi 4c, Raspberry Pi 4B | Raspberry Pi4, Banana Pi M64, Pine64, and other | +| - local | Docker, QEMU | Docker, QEMU | | **Cluster API** | | | | [CAPI Bootstrap Provider Talos](https://github.com/siderolabs/cluster-api-bootstrap-provider-talos) | >= 0.5.3 | >= 0.4.3 | | [CAPI Control Plane Provider Talos](https://github.com/siderolabs/cluster-api-control-plane-provider-talos) | >= 0.4.5 | >= 0.4.1 | diff --git a/website/content/v1.0/introduction/system-requirements.md b/website/content/v1.0/introduction/system-requirements.md index ee5cbe6df..734c84da2 100644 --- a/website/content/v1.0/introduction/system-requirements.md +++ b/website/content/v1.0/introduction/system-requirements.md @@ -1,6 +1,7 @@ --- title: System Requirements -weight: 4 +weight: 40 +description: "Hardware requirements for running Talos Linux." --- ## Minimum Requirements diff --git a/website/content/v1.0/introduction/what-is-new.md b/website/content/v1.0/introduction/what-is-new.md index 589db9173..5814d0daf 100644 --- a/website/content/v1.0/introduction/what-is-new.md +++ b/website/content/v1.0/introduction/what-is-new.md @@ -1,6 +1,7 @@ --- title: What's New in Talos 1.0 -weight: 5 +weight: 50 +description: "List of new and shiny features in Talos Linux." --- ## Announcements @@ -29,16 +30,16 @@ container runtimes, additional firmware, among others. System extensions are only activated during Talos installation (or upgrade). Even with system extensions installed, the Talos root filesystem is still immutable and read-only. -Please see [extensions repository](https://github.com/talos-systems/extensions) and [documentation]({{< relref "../guides/system-extensions/" >}}) for more information. +Please see [extensions repository](https://github.com/talos-systems/extensions) and [documentation]({{< relref "../talos-guides/configuration/system-extensions/" >}}) for more information. ### Extension Services -Talos now provides a way to extend the system services that Talos runs with [extension services]({{< relref "../learn-more/extension-services" >}}). +Talos now provides a way to extend the system services that Talos runs with [extension services]({{< relref "../advanced/extension-services" >}}). Extension services should be included in the Talos root filesystem (i.e. via system extensions). ### Static Pods in the Machine Configuration -Talos now accepts [static pod definitions]({{< relref "../guides/static-pods" >}}) in the `.machine.pods` key of the machine configuration. +Talos now accepts [static pod definitions]({{< relref "../advanced/static-pods" >}}) in the `.machine.pods` key of the machine configuration. Please note that static pod definitions are not validated by Talos, and can be updated without a node reboot. ## Kubernetes @@ -117,11 +118,11 @@ Talos now supports setting a bond interface from the kernel cmdline using the [` ### Equinix Metal -`talos.platform` for [Equinix Metal]({{< relref "../bare-metal-platforms/equinix-metal" >}}) is renamed from `packet` to `equinixMetal`, the older name is still supported for backwards compatibility. +`talos.platform` for [Equinix Metal]({{< relref "../talos-guides/install/bare-metal-platforms/equinix-metal" >}}) is renamed from `packet` to `equinixMetal`, the older name is still supported for backwards compatibility. ### Oracle Cloud -Talos now supports [Oracle Cloud]({{< relref "../cloud-platforms/oracle" >}}). +Talos now supports [Oracle Cloud]({{< relref "../talos-guides/install/cloud-platforms/oracle" >}}). ### Network Configuration @@ -131,7 +132,7 @@ even if Talos is booted into maintenance mode, and without machine configuration ### SBCs -Talos has added support for the [Jetson Nano SBC]({{< relref "../single-board-computers/jetson_nano" >}}). +Talos now supports [Jetson Nano SBC]({{< relref "../talos-guides/install/single-board-computers/jetson_nano" >}}). ## Component Updates @@ -149,7 +150,7 @@ Talos is built with Go 1.17.8 ### NVIDIA GPU alpha Support Talos now has alpha support for NVIDIA GPU based workloads. -Check the [NVIDA GPU support guide]({{< relref "../guides/nvidia-gpu" >}}) for details. +Check the [NVIDA GPU support guide]({{< relref "../talos-guides/configuration/nvidia-gpu" >}}) for details. ## Miscellaneous @@ -162,4 +163,4 @@ Use machine configuration field `.machine.sysfs` to set `sysfs` kernel parameter Talos added a new kernel parameter `talos.experimental.wipe=system` which can help resetting the system disk of the machine and start over with a fresh installation. -See [Resetting a Machine]({{< relref "../guides/resetting-a-machine#kernel-parameter" >}}) on how to use it. +See [Resetting a Machine]({{< relref "../talos-guides/resetting-a-machine#kernel-parameter" >}}) on how to use it. diff --git a/website/content/v1.0/introduction/what-is-talos.md b/website/content/v1.0/introduction/what-is-talos.md index 7ba56ac43..d0b047d99 100644 --- a/website/content/v1.0/introduction/what-is-talos.md +++ b/website/content/v1.0/introduction/what-is-talos.md @@ -1,6 +1,7 @@ --- title: What is Talos? -weight: 1 +weight: 10 +description: "A quick introduction in to what Talos is and why it should be used." --- Talos is a container optimized Linux distro; a reimagining of Linux for distributed systems such as Kubernetes. diff --git a/website/content/v1.0/kubernetes-guides/_index.md b/website/content/v1.0/kubernetes-guides/_index.md new file mode 100644 index 000000000..1c9c43e36 --- /dev/null +++ b/website/content/v1.0/kubernetes-guides/_index.md @@ -0,0 +1,5 @@ +--- +title: "Kubernetes Guides" +weight: 30 +description: "Management of a Kubernetes Cluster hosted by Talos Linux" +--- diff --git a/website/content/v1.0/kubernetes-guides/configuration/_index.md b/website/content/v1.0/kubernetes-guides/configuration/_index.md new file mode 100644 index 000000000..d44941272 --- /dev/null +++ b/website/content/v1.0/kubernetes-guides/configuration/_index.md @@ -0,0 +1,5 @@ +--- +title: "Configuration" +weight: 10 +description: "How to configure components of the Kubernetes cluster itself." +--- diff --git a/website/content/v1.0/guides/configuring-ceph-with-rook.md b/website/content/v1.0/kubernetes-guides/configuration/ceph-with-rook.md similarity index 98% rename from website/content/v1.0/guides/configuring-ceph-with-rook.md rename to website/content/v1.0/kubernetes-guides/configuration/ceph-with-rook.md index 2fb159bfa..49d99f30f 100644 --- a/website/content/v1.0/guides/configuring-ceph-with-rook.md +++ b/website/content/v1.0/kubernetes-guides/configuration/ceph-with-rook.md @@ -1,6 +1,8 @@ --- -title: "Configuring Ceph with Rook" -description: "" +title: "Ceph Storage cluster with Rook" +description: "Guide on how to create a simple Ceph storage cluster with Rook for Kubernetes" +aliases: + - ../../guides/configuring-ceph-with-rook --- ## Preparation diff --git a/website/content/v1.0/guides/configuring-the-cluster-endpoint.md b/website/content/v1.0/kubernetes-guides/configuration/cluster-endpoint.md similarity index 88% rename from website/content/v1.0/guides/configuring-the-cluster-endpoint.md rename to website/content/v1.0/kubernetes-guides/configuration/cluster-endpoint.md index 9c2ef9760..55e9a631d 100644 --- a/website/content/v1.0/guides/configuring-the-cluster-endpoint.md +++ b/website/content/v1.0/kubernetes-guides/configuration/cluster-endpoint.md @@ -1,6 +1,8 @@ --- -title: "Configuring the Cluster Endpoint" -description: "" +title: "Cluster Endpoint" +description: "How to explicitly set up an endpoint for the cluster API" +alises: + - ../../guides/configuring-the-cluster-endpoint --- In this section, we will step through the configuration of a Talos based Kubernetes cluster. @@ -31,7 +33,7 @@ The configuration can either be done on a Loadbalancer, or simply trough DNS. For example: > This is in the config file for the cluster e.g. controlplane.yaml and worker.yaml. -> for more details, please see: [v1alpha1 endpoint configuration](../../reference/configuration/#controlplaneconfig) +> for more details, please see: [v1alpha1 endpoint configuration]({{< relref "../../reference/configuration#controlplaneconfig" >}}) ```yaml ..... diff --git a/website/content/v1.0/guides/deploy-metrics-server.md b/website/content/v1.0/kubernetes-guides/configuration/deploy-metrics-server.md similarity index 97% rename from website/content/v1.0/guides/deploy-metrics-server.md rename to website/content/v1.0/kubernetes-guides/configuration/deploy-metrics-server.md index 0471cdbfc..59986d423 100644 --- a/website/content/v1.0/guides/deploy-metrics-server.md +++ b/website/content/v1.0/kubernetes-guides/configuration/deploy-metrics-server.md @@ -1,6 +1,8 @@ --- title: "Deploying Metrics Server" description: "In this guide you will learn how to set up metrics-server." +aliases: + - ../../guides/deploy-metrics-server --- Metrics Server enables use of the [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) and [Vertical Pod Autoscaler](https://github.com/kubernetes/autoscaler/tree/master/vertical-pod-autoscaler). diff --git a/website/content/v1.0/guides/discovery.md b/website/content/v1.0/kubernetes-guides/configuration/discovery.md similarity index 96% rename from website/content/v1.0/guides/discovery.md rename to website/content/v1.0/kubernetes-guides/configuration/discovery.md index f31aa0d4c..af68334ea 100644 --- a/website/content/v1.0/guides/discovery.md +++ b/website/content/v1.0/kubernetes-guides/configuration/discovery.md @@ -1,5 +1,8 @@ --- title: "Discovery" +description: "How to use Talos Linux cluster discovery" +aliases: + - ../../guides/discovery --- ## Video Walkthrough @@ -39,7 +42,7 @@ Annotations: cluster.talos.dev/node-id: Utoh3O0ZneV0kT2IUBrh7TgdouRcUW2yz ... ``` -`Service` registry uses external [Discovery Service](../../learn-more/discovery/) to exchange encrypted information about cluster members. +`Service` registry uses external [Discovery Service]({{< relref "../../learn-more/discovery/" >}}) to exchange encrypted information about cluster members. ## Resource Definitions diff --git a/website/content/v1.1/guides/pod-security.md b/website/content/v1.0/kubernetes-guides/configuration/pod-security.md similarity index 99% rename from website/content/v1.1/guides/pod-security.md rename to website/content/v1.0/kubernetes-guides/configuration/pod-security.md index 98a54ed5f..f102e1460 100644 --- a/website/content/v1.1/guides/pod-security.md +++ b/website/content/v1.0/kubernetes-guides/configuration/pod-security.md @@ -1,6 +1,8 @@ --- title: "Pod Security" description: "Enabling Pod Security Admission plugin to configure Pod Security Standards." +aliases: + - ../../guides/pod-security --- Kubernetes deprecated [Pod Security Policy](https://kubernetes.io/docs/concepts/policy/pod-security-policy/) as of v1.21, and it is diff --git a/website/content/v1.0/guides/storage.md b/website/content/v1.0/kubernetes-guides/configuration/storage.md similarity index 98% rename from website/content/v1.0/guides/storage.md rename to website/content/v1.0/kubernetes-guides/configuration/storage.md index 39a90857e..30f143a1b 100644 --- a/website/content/v1.0/guides/storage.md +++ b/website/content/v1.0/kubernetes-guides/configuration/storage.md @@ -1,6 +1,8 @@ --- title: "Storage" -description: "" +description: "Setting up storage for a Kubernetes cluster" +aliases: + - ../../guides/storage --- In Kubernetes, using storage in the right way is well-facilitated by the API. diff --git a/website/content/v1.0/kubernetes-guides/network/_index.md b/website/content/v1.0/kubernetes-guides/network/_index.md new file mode 100644 index 000000000..420161673 --- /dev/null +++ b/website/content/v1.0/kubernetes-guides/network/_index.md @@ -0,0 +1,5 @@ +--- +title: "Network" +weight: 20 +description: "Managing the Kubernetes cluster networking" +--- diff --git a/website/content/v1.1/guides/deploying-cilium.md b/website/content/v1.0/kubernetes-guides/network/deploying-cilium.md similarity index 99% rename from website/content/v1.1/guides/deploying-cilium.md rename to website/content/v1.0/kubernetes-guides/network/deploying-cilium.md index ce3a36db0..a33f758c5 100644 --- a/website/content/v1.1/guides/deploying-cilium.md +++ b/website/content/v1.0/kubernetes-guides/network/deploying-cilium.md @@ -1,6 +1,8 @@ --- title: "Deploying Cilium CNI" description: "In this guide you will learn how to set up Cilium CNI on Talos." +aliases: + - ../../guides/deploying-cilium --- From v1.9 onwards Cilium does no longer provide a one-liner install manifest that can be used to install Cilium on a node via `kubectl apply -f` or passing it in as an extra url in the `urls` part in the Talos machine configuration. diff --git a/website/content/v1.0/guides/kubespan.md b/website/content/v1.0/kubernetes-guides/network/kubespan.md similarity index 98% rename from website/content/v1.0/guides/kubespan.md rename to website/content/v1.0/kubernetes-guides/network/kubespan.md index d764fd114..417a160e5 100644 --- a/website/content/v1.0/guides/kubespan.md +++ b/website/content/v1.0/kubernetes-guides/network/kubespan.md @@ -1,5 +1,8 @@ --- title: "KubeSpan" +description: "Learn to use KubeSpan to connect Talos Linux machines securely across networks." +aliases: + - ../../guides/kubespan --- KubeSpan is a feature of Talos that automates the setup and maintenance of a full mesh [WireGuard](https://www.wireguard.com) network for your cluster, giving you the ability to operate hybrid Kubernetes clusters that can span the edge, datacenter, and cloud. diff --git a/website/content/v1.1/guides/upgrading-kubernetes.md b/website/content/v1.0/kubernetes-guides/upgrading-kubernetes.md similarity index 98% rename from website/content/v1.1/guides/upgrading-kubernetes.md rename to website/content/v1.0/kubernetes-guides/upgrading-kubernetes.md index ca3015e8e..dcefadb50 100644 --- a/website/content/v1.1/guides/upgrading-kubernetes.md +++ b/website/content/v1.0/kubernetes-guides/upgrading-kubernetes.md @@ -1,9 +1,12 @@ --- -title: Upgrading Kubernetes +title: "Upgrading Kubernetes" +description: "Guide on how to upgrade the Kubernetes cluster from Talos Linux." +aliases: + - guides/upgrading-kubernetes --- This guide covers upgrading Kubernetes on Talos Linux clusters. -For upgrading the Talos Linux operating system, see [Upgrading Talos](../upgrading-talos/) +For upgrading the Talos Linux operating system, see [Upgrading Talos]({{< relref "../talos-guides/upgrading-talos" >}}) ## Video Walkthrough diff --git a/website/content/v1.0/learn-more/architecture.md b/website/content/v1.0/learn-more/architecture.md index dcd1ab795..8190149e6 100644 --- a/website/content/v1.0/learn-more/architecture.md +++ b/website/content/v1.0/learn-more/architecture.md @@ -1,6 +1,7 @@ --- title: "Architecture" -weight: 30 +weight: 20 +description: "Learn the system architecture of Talos Linux itself." --- Talos is designed to be **atomic** in _deployment_ and **modular** in _composition_. diff --git a/website/content/v1.0/learn-more/components.md b/website/content/v1.0/learn-more/components.md index e9a1cce79..9b680ccc5 100644 --- a/website/content/v1.0/learn-more/components.md +++ b/website/content/v1.0/learn-more/components.md @@ -1,6 +1,7 @@ --- title: "Components" weight: 40 +description: "Understand the system components that make up Talos Linux." --- In this section, we discuss the various components that underpin Talos. diff --git a/website/content/v1.0/learn-more/concepts.md b/website/content/v1.0/learn-more/concepts.md index 96b22b3b0..4d5a32051 100644 --- a/website/content/v1.0/learn-more/concepts.md +++ b/website/content/v1.0/learn-more/concepts.md @@ -1,6 +1,7 @@ --- title: "Concepts" -weight: 20 +weight: 30 +description: "Summary of Talos Linux." --- When people come across Talos, they frequently want a nice, bite-sized summary diff --git a/website/content/v1.0/learn-more/control-plane.md b/website/content/v1.0/learn-more/control-plane.md index 0e4c51b5b..35bb526bf 100644 --- a/website/content/v1.0/learn-more/control-plane.md +++ b/website/content/v1.0/learn-more/control-plane.md @@ -1,6 +1,7 @@ --- title: "Control Plane" -weight: 80 +weight: 50 +description: "Understand the Kubernetes Control Plane." --- This guide provides details on how Talos runs and bootstraps the Kubernetes control plane. diff --git a/website/content/v1.0/learn-more/controllers-resources.md b/website/content/v1.0/learn-more/controllers-resources.md index 111ecfad4..bf15801f0 100644 --- a/website/content/v1.0/learn-more/controllers-resources.md +++ b/website/content/v1.0/learn-more/controllers-resources.md @@ -1,6 +1,7 @@ --- title: "Controllers and Resources" -weight: 90 +weight: 60 +description: "Discover how Talos Linux uses the concepts on Controllers and Resources." --- diff --git a/website/content/v1.0/learn-more/discovery.md b/website/content/v1.0/learn-more/discovery.md index 99ebaff8d..44461f8dc 100644 --- a/website/content/v1.0/learn-more/discovery.md +++ b/website/content/v1.0/learn-more/discovery.md @@ -1,6 +1,7 @@ --- title: "Discovery" -weight: 110 +weight: 90 +description: "Discover how Sidero Labs impliments Talos node discovery." --- We maintain a public discovery service whereby members of your cluster can use a common and unique key to coordinate the most basic connection information (i.e. the set of possible "endpoints", or IP:port pairs). diff --git a/website/content/v1.0/learn-more/faqs.md b/website/content/v1.0/learn-more/faqs.md index a6fe3b1af..290766a5a 100644 --- a/website/content/v1.0/learn-more/faqs.md +++ b/website/content/v1.0/learn-more/faqs.md @@ -1,6 +1,7 @@ --- title: "FAQs" -weight: 60 +weight: 999 +description: "Frequently Asked Questions about Talos Linux." --- diff --git a/website/content/v1.0/learn-more/kubespan.md b/website/content/v1.0/learn-more/kubespan.md index e55d0e5ba..f0f53647c 100644 --- a/website/content/v1.0/learn-more/kubespan.md +++ b/website/content/v1.0/learn-more/kubespan.md @@ -1,6 +1,7 @@ --- title: "KubeSpan" -weight: 120 +weight: 100 +description: "Understand more about KubeSpan for Talos Linux." --- ## WireGuard Peer Discovery @@ -28,7 +29,7 @@ For this discussion, we will point out two of these tiers: - an external service - a Kubernetes-based system -See [discovery service](../discovery) to learn more about the external service. +See [discovery service]({{< relref "discovery" >}}) to learn more about the external service. The Kubernetes-based system utilises annotations on Kubernetes Nodes which describe each node's public key and local addresses. diff --git a/website/content/v1.0/learn-more/networking-resources.md b/website/content/v1.0/learn-more/networking-resources.md index 2739dc6f2..5f664ae4e 100644 --- a/website/content/v1.0/learn-more/networking-resources.md +++ b/website/content/v1.0/learn-more/networking-resources.md @@ -1,9 +1,10 @@ --- title: "Networking Resources" -weight: 100 +weight: 70 +description: "Delve deeper into networking of Talos Linux." --- -Starting with version 0.11, a new implementation of the network configuration subsystem is powered by [COSI](../controllers-resources/). +Starting with version 0.11, a new implementation of the network configuration subsystem is powered by [COSI]({{< relref "controllers-resources" >}}). The new implementation is still using the same machine configuration file format and external sources to configure a node's network, so there should be no difference in the way Talos works in 0.11. diff --git a/website/content/v1.0/learn-more/philosophy.md b/website/content/v1.0/learn-more/philosophy.md index 744ee9517..a81c3c9f5 100644 --- a/website/content/v1.0/learn-more/philosophy.md +++ b/website/content/v1.0/learn-more/philosophy.md @@ -1,6 +1,7 @@ --- title: Philosophy weight: 10 +description: "Learn about the philosophy behind the need for Talos Linux." --- ## Distributed diff --git a/website/content/v1.0/guides/configuring-network-connectivity.md b/website/content/v1.0/learn-more/talos-network-connectivity.md similarity index 93% rename from website/content/v1.0/guides/configuring-network-connectivity.md rename to website/content/v1.0/learn-more/talos-network-connectivity.md index 0165990fc..ad60662a7 100644 --- a/website/content/v1.0/guides/configuring-network-connectivity.md +++ b/website/content/v1.0/learn-more/talos-network-connectivity.md @@ -1,6 +1,9 @@ --- -title: "Configuring Network Connectivity" -description: "" +title: "Network Connectivity" +weight: 80 +description: "Description of the Networking Connectivity needed by Talos Linux" +aliases: + - ../guides/configuring-network-connectivity --- ## Configuring Network Connectivity diff --git a/website/content/v1.0/learn-more/talosctl.md b/website/content/v1.0/learn-more/talosctl.md index b560d08b2..2580dbeb0 100644 --- a/website/content/v1.0/learn-more/talosctl.md +++ b/website/content/v1.0/learn-more/talosctl.md @@ -1,6 +1,7 @@ --- title: "talosctl" -weight: 70 +weight: 110 +description: "The design and use of the Talos Linux control application." --- The `talosctl` tool packs a lot of power into a small package. @@ -59,4 +60,4 @@ number of kubernetes clusters from the same workstation. ## Commands -Please see the [CLI reference](../../reference/cli/) for the entire list of commands which are available from `talosctl`. +Please see the [CLI reference]({{< relref "../reference/cli" >}}) for the entire list of commands which are available from `talosctl`. diff --git a/website/content/v1.0/local-platforms/_index.md b/website/content/v1.0/local-platforms/_index.md deleted file mode 100644 index e9b720762..000000000 --- a/website/content/v1.0/local-platforms/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Local Platforms" -weight: 50 ---- diff --git a/website/content/v1.0/reference/api.md b/website/content/v1.0/reference/api.md index 3a2dff63a..880839f2a 100644 --- a/website/content/v1.0/reference/api.md +++ b/website/content/v1.0/reference/api.md @@ -1,6 +1,6 @@ --- -title: API -description: Talos gRPC API reference. +title: "API" +description: "Talos gRPC API reference." --- ## Table of Contents diff --git a/website/content/v1.0/reference/cli.md b/website/content/v1.0/reference/cli.md index 768a44a12..9695aa170 100644 --- a/website/content/v1.0/reference/cli.md +++ b/website/content/v1.0/reference/cli.md @@ -1,6 +1,6 @@ --- -title: CLI -desription: Talosctl CLI tool reference. +title: "CLI" +description: "Talosctl CLI tool reference." --- diff --git a/website/content/v1.0/reference/configuration.md b/website/content/v1.0/reference/configuration.md index dacfaf40a..2de0c3191 100644 --- a/website/content/v1.0/reference/configuration.md +++ b/website/content/v1.0/reference/configuration.md @@ -1,6 +1,6 @@ --- -title: Configuration -desription: Talos node configuration file reference. +title: "Configuration" +description: "Talos node configuration file reference." --- diff --git a/website/content/v1.0/reference/kernel.md b/website/content/v1.0/reference/kernel.md index 2a7cbedd3..7b4062691 100644 --- a/website/content/v1.0/reference/kernel.md +++ b/website/content/v1.0/reference/kernel.md @@ -1,6 +1,6 @@ --- -title: Kernel -desription: Linux kernel reference. +title: "Kernel" +description: "Linux kernel reference." --- ## Commandline Parameters diff --git a/website/content/v1.0/reference/platform.md b/website/content/v1.0/reference/platform.md index ade1369b0..5d9b53f58 100644 --- a/website/content/v1.0/reference/platform.md +++ b/website/content/v1.0/reference/platform.md @@ -1,5 +1,6 @@ --- -title: Platform +title: "Platform" +description: "Visualization of the bootstrap process on bare metal machines." --- ### Metal diff --git a/website/content/v1.0/single-board-computers/_index.md b/website/content/v1.0/single-board-computers/_index.md deleted file mode 100644 index 31b2227f4..000000000 --- a/website/content/v1.0/single-board-computers/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Single Board Computers" -weight: 55 ---- diff --git a/website/content/v1.0/talos-guides/_index.md b/website/content/v1.0/talos-guides/_index.md new file mode 100644 index 000000000..1596f8566 --- /dev/null +++ b/website/content/v1.0/talos-guides/_index.md @@ -0,0 +1,5 @@ +--- +title: Talos Linux Guides +weight: 20 +description: "Documentation on how to manage Talos Linux" +--- diff --git a/website/content/v1.0/talos-guides/configuration/_index.md b/website/content/v1.0/talos-guides/configuration/_index.md new file mode 100644 index 000000000..a3ced180e --- /dev/null +++ b/website/content/v1.0/talos-guides/configuration/_index.md @@ -0,0 +1,5 @@ +--- +title: "Configuration" +weight: 20 +description: "Guides on how to configure Talos Linux machines" +--- diff --git a/website/content/v1.1/guides/configuring-certificate-authorities.md b/website/content/v1.0/talos-guides/configuration/certificate-authorities.md similarity index 66% rename from website/content/v1.1/guides/configuring-certificate-authorities.md rename to website/content/v1.0/talos-guides/configuration/certificate-authorities.md index e759c5054..7af72aa46 100644 --- a/website/content/v1.1/guides/configuring-certificate-authorities.md +++ b/website/content/v1.0/talos-guides/configuration/certificate-authorities.md @@ -1,6 +1,8 @@ --- -title: "Configuring Certificate Authorities" -description: "" +title: "Custom Certificate Authorities" +description: "How to supply custom certificate authorities" +aliases: + - ../../guides/configuring-certificate-authorities --- ## Appending the Certificate Authority diff --git a/website/content/v1.1/guides/configuring-containerd.md b/website/content/v1.0/talos-guides/configuration/containerd.md similarity index 90% rename from website/content/v1.1/guides/configuring-containerd.md rename to website/content/v1.0/talos-guides/configuration/containerd.md index 192a2303d..bf396a041 100644 --- a/website/content/v1.1/guides/configuring-containerd.md +++ b/website/content/v1.0/talos-guides/configuration/containerd.md @@ -1,6 +1,8 @@ --- -title: "Configuring Containerd" -description: "" +title: "Containerd" +description: "Customize Containerd Settings" +aliases: + - ../../guides/configuring-containerd --- The base containerd configuration expects to merge in any additional configs present in `/var/cri/conf.d/*.toml`. diff --git a/website/content/v1.1/guides/disk-encryption.md b/website/content/v1.0/talos-guides/configuration/disk-encryption.md similarity index 99% rename from website/content/v1.1/guides/disk-encryption.md rename to website/content/v1.0/talos-guides/configuration/disk-encryption.md index 974f75de1..63cf5c699 100644 --- a/website/content/v1.1/guides/disk-encryption.md +++ b/website/content/v1.0/talos-guides/configuration/disk-encryption.md @@ -1,6 +1,8 @@ --- title: "Disk Encryption" description: "Guide on using system disk encryption" +aliases: + - ../../guides/disk-encryption --- It is possible to enable encryption for system disks at the OS level. diff --git a/website/content/v1.1/guides/editing-machine-configuration.md b/website/content/v1.0/talos-guides/configuration/editing-machine-configuration.md similarity index 97% rename from website/content/v1.1/guides/editing-machine-configuration.md rename to website/content/v1.0/talos-guides/configuration/editing-machine-configuration.md index dbe1428d5..0adf836a2 100644 --- a/website/content/v1.1/guides/editing-machine-configuration.md +++ b/website/content/v1.0/talos-guides/configuration/editing-machine-configuration.md @@ -1,9 +1,11 @@ --- title: "Editing Machine Configuration" description: "How to edit and patch Talos machine configuration, with reboot, immediately, or stage update on reboot." +aliases: + - ../../guides/editing-machine-configuration --- -Talos node state is fully defined by [machine configuration](../../reference/configuration/). +Talos node state is fully defined by [machine configuration]({{< relref "../../reference/configuration" >}}). Initial configuration is delivered to the node at bootstrap time, but configuration can be updated while the node is running. > Note: Be sure that config is persisted so that configuration updates are not overwritten on reboots. diff --git a/website/content/v1.0/guides/logging.md b/website/content/v1.0/talos-guides/configuration/logging.md similarity index 99% rename from website/content/v1.0/guides/logging.md rename to website/content/v1.0/talos-guides/configuration/logging.md index 9822fe13a..389f3084f 100644 --- a/website/content/v1.0/guides/logging.md +++ b/website/content/v1.0/talos-guides/configuration/logging.md @@ -1,5 +1,8 @@ --- -title: Logging +title: "Logging" +description: "Dealing with Talos Linux logs." +aliases: + - ../../guiides/logging --- ## Viewing logs diff --git a/website/content/v1.1/guides/managing-pki.md b/website/content/v1.0/talos-guides/configuration/managing-pki.md similarity index 93% rename from website/content/v1.1/guides/managing-pki.md rename to website/content/v1.0/talos-guides/configuration/managing-pki.md index a3f5f94d4..5d14dcf7d 100644 --- a/website/content/v1.1/guides/managing-pki.md +++ b/website/content/v1.0/talos-guides/configuration/managing-pki.md @@ -1,6 +1,8 @@ --- title: "Managing PKI" -description: "" +description: "How to manage Public Key Infrastructure" +aliases: + - ../../guides/managing-pki --- ## Generating an Administrator Key Pair diff --git a/website/content/v1.1/guides/nvidia-gpu.md b/website/content/v1.0/talos-guides/configuration/nvidia-gpu.md similarity index 98% rename from website/content/v1.1/guides/nvidia-gpu.md rename to website/content/v1.0/talos-guides/configuration/nvidia-gpu.md index 9baed4728..f734f40be 100644 --- a/website/content/v1.1/guides/nvidia-gpu.md +++ b/website/content/v1.0/talos-guides/configuration/nvidia-gpu.md @@ -1,6 +1,8 @@ --- title: "NVIDIA GPU" description: "In this guide we'll follow the procedure to support NVIDIA GPU on Talos." +aliases: + - ../../guides/nvidia-gpu --- > Enabling NVIDIA GPU support on Talos is bound by [NVIDIA EULA](https://www.nvidia.com/en-us/drivers/nvidia-license/) @@ -13,7 +15,7 @@ These are the steps to enabling NVIDIA support in Talos. - Building NVIDIA container toolkit system extension which allows to register a custom runtime with containerd - Upgrading Talos with the custom installer and enabling NVIDIA modules and the system extension -Both these components require that the user build and maintain their own Talos installer image and the NVIDIA container toolkit [Talos System Extension]({{< relref "system-extensions">}}). +Both these components require that the user build and maintain their own Talos installer image and the NVIDIA container toolkit [Talos System Extension]({{< relref "system-extensions" >}}). ## Prerequisites diff --git a/website/content/v1.0/guides/configuring-pull-through-cache.md b/website/content/v1.0/talos-guides/configuration/pull-through-cache.md similarity index 87% rename from website/content/v1.0/guides/configuring-pull-through-cache.md rename to website/content/v1.0/talos-guides/configuration/pull-through-cache.md index 3b2e05fbc..2b4066c89 100644 --- a/website/content/v1.0/guides/configuring-pull-through-cache.md +++ b/website/content/v1.0/talos-guides/configuration/pull-through-cache.md @@ -1,5 +1,8 @@ --- -title: Configuring Pull Through Cache +title: Pull Through Image Cache +description: "How to set up local transparent container images caches." +aliases: + - ../../guides/configuring-pull-through-cache --- In this guide we will create a set of local caching Docker registry proxies to minimize local cluster startup time. @@ -20,7 +23,7 @@ To see a live demo of this writeup, see the video below: The follow are requirements for creating the set of caching proxies: - Docker 18.03 or greater -- Local cluster requirements for either [docker](../../local-platforms/docker/) or [QEMU](../../local-platforms/qemu/). +- Local cluster requirements for either [docker]({{< relref "../install/local-platforms/docker" >}}) or [QEMU]({{< relref "../install/local-platforms/qemu" >}}). ## Launch the Caching Docker Registry Proxies @@ -62,7 +65,7 @@ host port (5000, 5001, 5002, 5003 and 5004). ## Using Caching Registries with `QEMU` Local Cluster -With a [QEMU](../../local-platforms/qemu/) local cluster, a bridge interface is created on the host. +With a [QEMU]({{< relref "../install/local-platforms/qemu" >}}) local cluster, a bridge interface is created on the host. As registry containers expose their ports on the host, we can use bridge IP to direct proxy requests. ```bash @@ -82,7 +85,7 @@ The first time cluster boots, images are pulled and cached, so next cluster boot ## Using Caching Registries with `docker` Local Cluster -With a [docker](../../local-platforms/docker/) local cluster we can use docker bridge IP, default value for that IP is `172.17.0.1`. +With a [docker]({{< relref "../install/local-platforms/docker" >}}) local cluster we can use docker bridge IP, default value for that IP is `172.17.0.1`. On Linux, the docker bridge address can be inspected with `ip addr show docker0`. ```bash diff --git a/website/content/v1.0/guides/rbac.md b/website/content/v1.0/talos-guides/configuration/rbac.md similarity index 82% rename from website/content/v1.0/guides/rbac.md rename to website/content/v1.0/talos-guides/configuration/rbac.md index 2376ec7d2..99c193cf3 100644 --- a/website/content/v1.0/guides/rbac.md +++ b/website/content/v1.0/talos-guides/configuration/rbac.md @@ -1,5 +1,8 @@ --- -title: Role-based access control (RBAC) +title: "Role-based access control (RBAC)" +description: "Set up RBAC on the Talos Linux API." +aliases: + - ../../guides/rbac --- Talos v0.11 introduced initial support for role-based access control (RBAC). @@ -9,11 +12,11 @@ This guide will explain what that is and how to enable it without losing access Talos uses certificates to authorize users. The certificate subject's organization field is used to encode user roles. -There is a set of predefined roles that allow access to different [API methods](../../reference/api/): +There is a set of predefined roles that allow access to different [API methods]({{< relref "../../reference/api" >}}): * `os:admin` grants access to all methods; * `os:reader` grants access to "safe" methods (for example, that includes the ability to list files, but does not include the ability to read files content); -* `os:etcd:backup` grants access to [`/machine.MachineService/EtcdSnapshot`](../../reference/api/#machine.EtcdSnapshotRequest) method. +* `os:etcd:backup` grants access to [`/machine.MachineService/EtcdSnapshot`]({{< relref "../../reference/api#machine.EtcdSnapshotRequest" >}}) method. Roles in the current `talosconfig` can be checked with the following command: @@ -29,7 +32,7 @@ RBAC is enabled by default in new clusters created with `talosctl` v0.11+ and di ## Enabling RBAC -First, both the Talos cluster and `talosctl` tool should be [upgraded](../upgrading-talos/). +First, both the Talos cluster and `talosctl` tool should be [upgraded]({{< relref "../upgrading-talos" >}}). Then the `talosctl config new` command should be used to generate a new client configuration with the `os:admin` role. Additional configurations and certificates for different roles can be generated by passing `--roles` flag: diff --git a/website/content/v1.0/guides/system-extensions.md b/website/content/v1.0/talos-guides/configuration/system-extensions.md similarity index 96% rename from website/content/v1.0/guides/system-extensions.md rename to website/content/v1.0/talos-guides/configuration/system-extensions.md index e19cdffcc..c924803bb 100644 --- a/website/content/v1.0/guides/system-extensions.md +++ b/website/content/v1.0/talos-guides/configuration/system-extensions.md @@ -1,5 +1,8 @@ --- title: "System Extensions" +description: "Customizing the Talos Linux immutable root file system." +aliases: + - ../../guides/system-extensions --- System extensions allow extending the Talos root filesystem, which enables a variety of features, such as including custom diff --git a/website/content/v1.0/talos-guides/install/_index.md b/website/content/v1.0/talos-guides/install/_index.md new file mode 100644 index 000000000..263e121d3 --- /dev/null +++ b/website/content/v1.0/talos-guides/install/_index.md @@ -0,0 +1,5 @@ +--- +title: "Installation" +weight: 10 +description: "How to install Talos Linux on various platforms" +--- diff --git a/website/content/v1.0/talos-guides/install/bare-metal-platforms/_index.md b/website/content/v1.0/talos-guides/install/bare-metal-platforms/_index.md new file mode 100644 index 000000000..1c8527cef --- /dev/null +++ b/website/content/v1.0/talos-guides/install/bare-metal-platforms/_index.md @@ -0,0 +1,5 @@ +--- +title: "Bare Metal Platforms" +weight: 20 +description: "Installation of Talos Linux on various bare-metal platforms." +--- diff --git a/website/content/v1.0/bare-metal-platforms/digital-rebar.md b/website/content/v1.0/talos-guides/install/bare-metal-platforms/digital-rebar.md similarity index 93% rename from website/content/v1.0/bare-metal-platforms/digital-rebar.md rename to website/content/v1.0/talos-guides/install/bare-metal-platforms/digital-rebar.md index e8dac16c9..7414864d9 100644 --- a/website/content/v1.0/bare-metal-platforms/digital-rebar.md +++ b/website/content/v1.0/talos-guides/install/bare-metal-platforms/digital-rebar.md @@ -1,14 +1,16 @@ --- title: "Digital Rebar" description: "In this guide we will create an Kubernetes cluster with 1 worker node, and 2 controlplane nodes using an existing digital rebar deployment." +aliases: + - ../../../bare-metal-platforms/digital-rebar --- ## Prerequisites -- 3 nodes (please see [hardware requirements]({{< relref "../introduction/system-requirements/">}})) +- 3 nodes (please see [hardware requirements]({{< relref "../../../introduction/system-requirements/" >}})) - Loadbalancer - Digital Rebar Server -- Talosctl access (see [talosctl setup]({{< relref "../introduction/getting-started/#talosctl">}})) +- Talosctl access (see [talosctl setup]({{< relref "../../../introduction/getting-started/#talosctl" >}})) ## Creating a Cluster @@ -144,7 +146,7 @@ Once selected, you need to assign to following: This will provision the Stage and Bootenv with the talos values. Once this is done, you can boot the machine. -To understand the boot process, we have a higher level overview located at [metal overview](../../reference/platform/). +To understand the boot process, we have a higher level overview located at [metal overview]({{< relref "../../../reference/platform" >}}). ### Bootstrap Etcd diff --git a/website/content/v1.1/bare-metal-platforms/equinix-metal.md b/website/content/v1.0/talos-guides/install/bare-metal-platforms/equinix-metal.md similarity index 98% rename from website/content/v1.1/bare-metal-platforms/equinix-metal.md rename to website/content/v1.0/talos-guides/install/bare-metal-platforms/equinix-metal.md index 0d6603eb9..cd6f3a33a 100644 --- a/website/content/v1.1/bare-metal-platforms/equinix-metal.md +++ b/website/content/v1.0/talos-guides/install/bare-metal-platforms/equinix-metal.md @@ -1,6 +1,8 @@ --- title: "Equinix Metal" description: "Creating Talos cluster using Equinix Metal." +aliases: + - ../../../bare-metal-platforms/equinix-metal --- ## Prerequisites diff --git a/website/content/v1.1/bare-metal-platforms/matchbox.md b/website/content/v1.0/talos-guides/install/bare-metal-platforms/matchbox.md similarity index 98% rename from website/content/v1.1/bare-metal-platforms/matchbox.md rename to website/content/v1.0/talos-guides/install/bare-metal-platforms/matchbox.md index 5cd55bd24..97bb8f3a9 100644 --- a/website/content/v1.1/bare-metal-platforms/matchbox.md +++ b/website/content/v1.0/talos-guides/install/bare-metal-platforms/matchbox.md @@ -1,6 +1,8 @@ --- title: "Matchbox" description: "In this guide we will create an HA Kubernetes cluster with 3 worker nodes using an existing load balancer and matchbox deployment." +aliases: + - ../../../bare-metal-platforms/matchbox --- ## Creating a Cluster diff --git a/website/content/v1.0/bare-metal-platforms/sidero.md b/website/content/v1.0/talos-guides/install/bare-metal-platforms/sidero.md similarity index 89% rename from website/content/v1.0/bare-metal-platforms/sidero.md rename to website/content/v1.0/talos-guides/install/bare-metal-platforms/sidero.md index 59968ea65..f3a531ed3 100644 --- a/website/content/v1.0/bare-metal-platforms/sidero.md +++ b/website/content/v1.0/talos-guides/install/bare-metal-platforms/sidero.md @@ -1,6 +1,8 @@ --- title: "Sidero" description: "Sidero is a project created by the Talos team that has native support for Talos." +aliases: + - ../../../bare-metal-platforms/sidero --- Sidero Metal is a project created by the Talos team that provides a bare metal installer for Cluster API, and that has native support for Talos Linux. diff --git a/website/content/v1.0/talos-guides/install/cloud-platforms/_index.md b/website/content/v1.0/talos-guides/install/cloud-platforms/_index.md new file mode 100644 index 000000000..e18473381 --- /dev/null +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/_index.md @@ -0,0 +1,5 @@ +--- +title: "Cloud Platforms" +weight: 40 +description: "Installation of Talos Linux on many cloud platforms." +--- diff --git a/website/content/v1.0/cloud-platforms/aws.md b/website/content/v1.0/talos-guides/install/cloud-platforms/aws.md similarity index 99% rename from website/content/v1.0/cloud-platforms/aws.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/aws.md index 75c2d0f13..ce8a2f97c 100644 --- a/website/content/v1.0/cloud-platforms/aws.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/aws.md @@ -1,6 +1,8 @@ --- title: "AWS" description: "Creating a cluster via the AWS CLI." +aliases: + - ../../../cloud-platforms/aws --- ## Official AMI Images diff --git a/website/content/v1.0/cloud-platforms/azure.md b/website/content/v1.0/talos-guides/install/cloud-platforms/azure.md similarity index 99% rename from website/content/v1.0/cloud-platforms/azure.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/azure.md index e45d59e85..d257110a6 100644 --- a/website/content/v1.0/cloud-platforms/azure.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/azure.md @@ -1,6 +1,8 @@ --- title: "Azure" description: "Creating a cluster via the CLI on Azure." +aliases: + - ../../../cloud-platforms/azure --- ## Creating a Cluster via the CLI diff --git a/website/content/v1.1/cloud-platforms/digitalocean.md b/website/content/v1.0/talos-guides/install/cloud-platforms/digitalocean.md similarity index 98% rename from website/content/v1.1/cloud-platforms/digitalocean.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/digitalocean.md index 832178e3f..4c8ab2b66 100644 --- a/website/content/v1.1/cloud-platforms/digitalocean.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/digitalocean.md @@ -1,6 +1,8 @@ --- title: "DigitalOcean" description: "Creating a cluster via the CLI on DigitalOcean." +aliases: + - ../../../cloud-platforms/digitalocean --- ## Creating a Cluster via the CLI diff --git a/website/content/v1.0/cloud-platforms/gcp.md b/website/content/v1.0/talos-guides/install/cloud-platforms/gcp.md similarity index 98% rename from website/content/v1.0/cloud-platforms/gcp.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/gcp.md index 71e6385e7..c8572b49f 100644 --- a/website/content/v1.0/cloud-platforms/gcp.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/gcp.md @@ -1,6 +1,8 @@ --- title: "GCP" description: "Creating a cluster via the CLI on Google Cloud Platform." +aliases: + - ../../../cloud-platforms/gcp --- ## Creating a Cluster via the CLI @@ -9,7 +11,7 @@ In this guide, we will create an HA Kubernetes cluster in GCP with 1 worker node We will assume an existing [Cloud Storage bucket](https://cloud.google.com/storage/docs/creating-buckets), and some familiarity with Google Cloud. If you need more information on Google Cloud specifics, please see the [official Google documentation](https://cloud.google.com/docs/). -[jq](https://stedolan.github.io/jq/) and [talosctl](../../introduction/quickstart/#talosctl) also needs to be installed +[jq](https://stedolan.github.io/jq/) and [talosctl]({{< relref "../../../introduction/quickstart#talosctl" >}}) also needs to be installed ## Manual Setup diff --git a/website/content/v1.0/cloud-platforms/gcp/config.yaml b/website/content/v1.0/talos-guides/install/cloud-platforms/gcp/config.yaml similarity index 100% rename from website/content/v1.0/cloud-platforms/gcp/config.yaml rename to website/content/v1.0/talos-guides/install/cloud-platforms/gcp/config.yaml diff --git a/website/content/v1.0/cloud-platforms/gcp/gcp-ccm.yaml b/website/content/v1.0/talos-guides/install/cloud-platforms/gcp/gcp-ccm.yaml similarity index 100% rename from website/content/v1.0/cloud-platforms/gcp/gcp-ccm.yaml rename to website/content/v1.0/talos-guides/install/cloud-platforms/gcp/gcp-ccm.yaml diff --git a/website/content/v1.0/cloud-platforms/gcp/talos-ha.jinja b/website/content/v1.0/talos-guides/install/cloud-platforms/gcp/talos-ha.jinja similarity index 100% rename from website/content/v1.0/cloud-platforms/gcp/talos-ha.jinja rename to website/content/v1.0/talos-guides/install/cloud-platforms/gcp/talos-ha.jinja diff --git a/website/content/v1.1/cloud-platforms/hetzner.md b/website/content/v1.0/talos-guides/install/cloud-platforms/hetzner.md similarity index 99% rename from website/content/v1.1/cloud-platforms/hetzner.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/hetzner.md index 25309941e..2c684348e 100644 --- a/website/content/v1.1/cloud-platforms/hetzner.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/hetzner.md @@ -1,6 +1,8 @@ --- title: "Hetzner" description: "Creating a cluster via the CLI (hcloud) on Hetzner." +aliases: + - ../../../cloud-platforms/hetzner --- ## Upload image diff --git a/website/content/v1.1/cloud-platforms/nocloud.md b/website/content/v1.0/talos-guides/install/cloud-platforms/nocloud.md similarity index 98% rename from website/content/v1.1/cloud-platforms/nocloud.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/nocloud.md index f721f852d..c78d3a9aa 100644 --- a/website/content/v1.1/cloud-platforms/nocloud.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/nocloud.md @@ -1,6 +1,8 @@ --- title: "Nocloud" description: "Creating a cluster via the CLI using qemu." +aliases: + - ../../../cloud-platforms/nocloud --- Talos supports [nocloud](https://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html) data source implementation. diff --git a/website/content/v1.1/cloud-platforms/openstack.md b/website/content/v1.0/talos-guides/install/cloud-platforms/openstack.md similarity index 99% rename from website/content/v1.1/cloud-platforms/openstack.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/openstack.md index 0faab530c..0694c15e5 100644 --- a/website/content/v1.1/cloud-platforms/openstack.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/openstack.md @@ -1,6 +1,8 @@ --- title: "Openstack" description: "Creating a cluster via the CLI on Openstack." +aliases: + - ../../../cloud-platforms/openstack --- ## Creating a Cluster via the CLI diff --git a/website/content/v1.1/cloud-platforms/oracle.md b/website/content/v1.0/talos-guides/install/cloud-platforms/oracle.md similarity index 99% rename from website/content/v1.1/cloud-platforms/oracle.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/oracle.md index e2e951fa9..f61ef2cee 100644 --- a/website/content/v1.1/cloud-platforms/oracle.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/oracle.md @@ -1,6 +1,8 @@ --- title: "Oracle" description: "Creating a cluster via the CLI (oci) on OracleCloud.com." +aliases: + - ../../../cloud-platforms/oracle --- ## Upload image diff --git a/website/content/v1.1/cloud-platforms/scaleway.md b/website/content/v1.0/talos-guides/install/cloud-platforms/scaleway.md similarity index 78% rename from website/content/v1.1/cloud-platforms/scaleway.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/scaleway.md index c80795482..4c74889a7 100644 --- a/website/content/v1.1/cloud-platforms/scaleway.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/scaleway.md @@ -1,6 +1,8 @@ --- title: "Scaleway" description: "Creating a cluster via the CLI (scw) on scaleway.com." +aliases: + - ../../../cloud-platforms/scaleway --- Talos is known to work on scaleway.com; however, it is currently undocumented. diff --git a/website/content/v1.1/cloud-platforms/upcloud.md b/website/content/v1.0/talos-guides/install/cloud-platforms/upcloud.md similarity index 78% rename from website/content/v1.1/cloud-platforms/upcloud.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/upcloud.md index 588e8c72d..6c9823262 100644 --- a/website/content/v1.1/cloud-platforms/upcloud.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/upcloud.md @@ -1,6 +1,8 @@ --- title: "UpCloud" description: "Creating a cluster via the CLI (upctl) on UpCloud.com." +aliases: + - ../../../cloud-platforms/upcloud --- Talos is known to work on UpCloud.com; however, it is currently undocumented. diff --git a/website/content/v1.1/cloud-platforms/vultr.md b/website/content/v1.0/talos-guides/install/cloud-platforms/vultr.md similarity index 79% rename from website/content/v1.1/cloud-platforms/vultr.md rename to website/content/v1.0/talos-guides/install/cloud-platforms/vultr.md index 51352d934..d404426ea 100644 --- a/website/content/v1.1/cloud-platforms/vultr.md +++ b/website/content/v1.0/talos-guides/install/cloud-platforms/vultr.md @@ -1,6 +1,8 @@ --- title: "Vultr" description: "Creating a cluster via the CLI (vultr-cli) on Vultr.com." +aliases: + - ../../../cloud-platforms/vultr --- Talos is known to work on Vultr.com; however, it is currently undocumented. diff --git a/website/content/v1.0/talos-guides/install/local-platforms/_index.md b/website/content/v1.0/talos-guides/install/local-platforms/_index.md new file mode 100644 index 000000000..f73b363d5 --- /dev/null +++ b/website/content/v1.0/talos-guides/install/local-platforms/_index.md @@ -0,0 +1,5 @@ +--- +title: "Local Platforms" +weight: 50 +description: "Installation of Talos Linux on local platforms, helpful for testing and developing." +--- diff --git a/website/content/v1.0/local-platforms/docker.md b/website/content/v1.0/talos-guides/install/local-platforms/docker.md similarity index 97% rename from website/content/v1.0/local-platforms/docker.md rename to website/content/v1.0/talos-guides/install/local-platforms/docker.md index 2116d084b..3cc3f0b91 100644 --- a/website/content/v1.0/local-platforms/docker.md +++ b/website/content/v1.0/talos-guides/install/local-platforms/docker.md @@ -1,6 +1,8 @@ --- title: Docker description: "Creating Talos Kubernetes cluster using Docker." +aliases: + - ../../../local-platforms/docker --- In this guide we will create a Kubernetes cluster in Docker, using a containerized version of Talos. diff --git a/website/content/v1.0/local-platforms/qemu.md b/website/content/v1.0/talos-guides/install/local-platforms/qemu.md similarity index 98% rename from website/content/v1.0/local-platforms/qemu.md rename to website/content/v1.0/talos-guides/install/local-platforms/qemu.md index d08a71835..0ea6a1211 100644 --- a/website/content/v1.0/local-platforms/qemu.md +++ b/website/content/v1.0/talos-guides/install/local-platforms/qemu.md @@ -1,6 +1,8 @@ --- title: QEMU description: "Creating Talos Kubernetes cluster using QEMU VMs." +aliases: + - ../../../local-platforms/qemu --- In this guide we will create a Kubernetes cluster using QEMU. @@ -91,7 +93,7 @@ Before the first cluster is created, `talosctl` will download the CNI bundle for Once the above finishes successfully, your talosconfig (`~/.talos/config`) will be configured to point to the new cluster, and `kubeconfig` will be downloaded and merged into default kubectl config location (`~/.kube/config`). -Cluster provisioning process can be optimized with [registry pull-through caches](../../guides/configuring-pull-through-cache/). +Cluster provisioning process can be optimized with [registry pull-through caches]({{< relref "../../configuration/pull-through-cache" >}}). ## Using the Cluster diff --git a/website/content/v1.1/local-platforms/virtualbox.md b/website/content/v1.0/talos-guides/install/local-platforms/virtualbox.md similarity index 99% rename from website/content/v1.1/local-platforms/virtualbox.md rename to website/content/v1.0/talos-guides/install/local-platforms/virtualbox.md index 2615055f7..15fabe4cc 100644 --- a/website/content/v1.1/local-platforms/virtualbox.md +++ b/website/content/v1.0/talos-guides/install/local-platforms/virtualbox.md @@ -1,6 +1,8 @@ --- title: VirtualBox description: "Creating Talos Kubernetes cluster using VurtualBox VMs." +aliases: + - ../../../local-platforms/virtualbox --- In this guide we will create a Kubernetes cluster using VirtualBox. diff --git a/website/content/v1.0/talos-guides/install/single-board-computers/_index.md b/website/content/v1.0/talos-guides/install/single-board-computers/_index.md new file mode 100644 index 000000000..2078f5339 --- /dev/null +++ b/website/content/v1.0/talos-guides/install/single-board-computers/_index.md @@ -0,0 +1,5 @@ +--- +title: "Single Board Computers" +weight: 55 +description: "Installation of Talos Linux on single-board computers." +--- diff --git a/website/content/v1.0/single-board-computers/bananapi_m64.md b/website/content/v1.0/talos-guides/install/single-board-computers/bananapi_m64.md similarity index 96% rename from website/content/v1.0/single-board-computers/bananapi_m64.md rename to website/content/v1.0/talos-guides/install/single-board-computers/bananapi_m64.md index 0cf01cb38..cbe64b81b 100644 --- a/website/content/v1.0/single-board-computers/bananapi_m64.md +++ b/website/content/v1.0/talos-guides/install/single-board-computers/bananapi_m64.md @@ -1,6 +1,8 @@ --- title: "Banana Pi M64" description: "Installing Talos on Banana Pi M64 SBC using raw disk image." +aliases: + - ../../../single-board-computers/bananapi_m64 --- ## Prerequisites diff --git a/website/content/v1.0/single-board-computers/jetson_nano.md b/website/content/v1.0/talos-guides/install/single-board-computers/jetson_nano.md similarity index 98% rename from website/content/v1.0/single-board-computers/jetson_nano.md rename to website/content/v1.0/talos-guides/install/single-board-computers/jetson_nano.md index 0b6bddf2c..bccf399a8 100644 --- a/website/content/v1.0/single-board-computers/jetson_nano.md +++ b/website/content/v1.0/talos-guides/install/single-board-computers/jetson_nano.md @@ -1,6 +1,8 @@ --- title: "Jetson Nano" description: "Installing Talos on Jetson Nano SBC using raw disk image." +aliases: + - ../../../single-board-computers/jetson_nano --- ## Prerequisites diff --git a/website/content/v1.1/single-board-computers/libretech_all_h3_cc_h5.md b/website/content/v1.0/talos-guides/install/single-board-computers/libretech_all_h3_cc_h5.md similarity index 95% rename from website/content/v1.1/single-board-computers/libretech_all_h3_cc_h5.md rename to website/content/v1.0/talos-guides/install/single-board-computers/libretech_all_h3_cc_h5.md index cc0fa2aa1..0d1a0afb0 100644 --- a/website/content/v1.1/single-board-computers/libretech_all_h3_cc_h5.md +++ b/website/content/v1.0/talos-guides/install/single-board-computers/libretech_all_h3_cc_h5.md @@ -1,6 +1,8 @@ --- title: "Libre Computer Board ALL-H3-CC" description: "Installing Talos on Libre Computer Board ALL-H3-CC SBC using raw disk image." +aliases: + - ../../../single-board-computers/libretech_all_h3_cc_h5 --- ## Prerequisites diff --git a/website/content/v1.0/single-board-computers/pine64.md b/website/content/v1.0/talos-guides/install/single-board-computers/pine64.md similarity index 96% rename from website/content/v1.0/single-board-computers/pine64.md rename to website/content/v1.0/talos-guides/install/single-board-computers/pine64.md index b7b836e52..8ffa51b3d 100644 --- a/website/content/v1.0/single-board-computers/pine64.md +++ b/website/content/v1.0/talos-guides/install/single-board-computers/pine64.md @@ -1,6 +1,8 @@ --- title: "Pine64" description: "Installing Talos on a Pine64 SBC using raw disk image." +aliases: + - ../../../single-board-computers/pine64 --- ## Prerequisites diff --git a/website/content/v1.1/single-board-computers/rock64.md b/website/content/v1.0/talos-guides/install/single-board-computers/rock64.md similarity index 96% rename from website/content/v1.1/single-board-computers/rock64.md rename to website/content/v1.0/talos-guides/install/single-board-computers/rock64.md index bcf697e87..6588e936a 100644 --- a/website/content/v1.1/single-board-computers/rock64.md +++ b/website/content/v1.0/talos-guides/install/single-board-computers/rock64.md @@ -1,6 +1,8 @@ --- title: "Pine64 Rock64" description: "Installing Talos on Pine64 Rock64 SBC using raw disk image." +aliases: + - ../../../single-board-computers/rock64 --- ## Prerequisites diff --git a/website/content/v1.0/single-board-computers/rockpi_4.md b/website/content/v1.0/talos-guides/install/single-board-computers/rockpi_4.md similarity index 90% rename from website/content/v1.0/single-board-computers/rockpi_4.md rename to website/content/v1.0/talos-guides/install/single-board-computers/rockpi_4.md index 251d2f696..13a4b05c6 100644 --- a/website/content/v1.0/single-board-computers/rockpi_4.md +++ b/website/content/v1.0/talos-guides/install/single-board-computers/rockpi_4.md @@ -1,6 +1,8 @@ --- title: "Radxa ROCK PI 4c" description: "Installing Talos on Radxa ROCK PI 4c SBC using raw disk image." +aliases: + - ../../../single-board-computers/rockpi_4 --- ## Prerequisites @@ -22,8 +24,8 @@ chmod +x /usr/local/bin/talosctl Download the image and decompress it: ```bash -curl -LO https://github.com/siderolabs/talos/releases/download/{{< release >}}/metal-rockpi_4-arm64.img.xz -xz -d metal-rockpi_4-arm64.img.xz +curl -LO https://github.com/siderolabs/talos/releases/download/{{< release >}}/metal-rockpi_4c-arm64.img.xz +xz -d metal-rockpi_4c-arm64.img.xz ``` ## Writing the Image @@ -81,9 +83,9 @@ sudo dd if=rkspi_loader-v20.11.2-trunk-v2.img of=/dev/mtdblock0 bs=4K - Optionally, you can also write Talos image to the SSD drive right from your Rock PI board: ```bash -curl -LO https://github.com/siderolabs/talos/releases/download/{{< release >}}/metal-rockpi_4-arm64.img.xz -xz -d metal-rockpi_4-arm64.img.xz -sudo dd if=metal-rockpi_4-arm64.img.xz of=/dev/nvme0n1 +curl -LO https://github.com/siderolabs/talos/releases/download/{{< release >}}/metal-rockpi_4c-arm64.img.xz +xz -d metal-rockpi_4c-arm64.img.xz +sudo dd if=metal-rockpi_4c-arm64.img.xz of=/dev/nvme0n1 ``` - remove SD card and reboot. diff --git a/website/content/v1.0/single-board-computers/rpi_4.md b/website/content/v1.0/talos-guides/install/single-board-computers/rpi_4.md similarity index 98% rename from website/content/v1.0/single-board-computers/rpi_4.md rename to website/content/v1.0/talos-guides/install/single-board-computers/rpi_4.md index fa0335d51..6d4edb8dd 100644 --- a/website/content/v1.0/single-board-computers/rpi_4.md +++ b/website/content/v1.0/talos-guides/install/single-board-computers/rpi_4.md @@ -1,6 +1,8 @@ --- title: "Raspberry Pi 4 Model B" description: "Installing Talos on Rpi4 SBC using raw disk image." +aliases: + - ../../../single-board-computers/rpi_4 --- ## Video Walkthrough diff --git a/website/content/v1.0/talos-guides/install/virtualized-platforms/_index.md b/website/content/v1.0/talos-guides/install/virtualized-platforms/_index.md new file mode 100644 index 000000000..7da4e1a6a --- /dev/null +++ b/website/content/v1.0/talos-guides/install/virtualized-platforms/_index.md @@ -0,0 +1,5 @@ +--- +title: "Virtualized Platforms" +weight: 30 +description: "Installation of Talos Linux for virtualization platforms." +--- diff --git a/website/content/v1.0/virtualized-platforms/hyper-v.md b/website/content/v1.0/talos-guides/install/virtualized-platforms/hyper-v.md similarity index 98% rename from website/content/v1.0/virtualized-platforms/hyper-v.md rename to website/content/v1.0/talos-guides/install/virtualized-platforms/hyper-v.md index 58318701e..2d300b1c3 100644 --- a/website/content/v1.0/virtualized-platforms/hyper-v.md +++ b/website/content/v1.0/talos-guides/install/virtualized-platforms/hyper-v.md @@ -1,6 +1,8 @@ --- title: "Hyper-V" description: "Creating a Talos Kubernetes cluster using Hyper-V." +aliases: + - ../../../virtualized-platforms/hyper-v --- ## Pre-requisities diff --git a/website/content/v1.0/talos-guides/install/virtualized-platforms/kvm.md b/website/content/v1.0/talos-guides/install/virtualized-platforms/kvm.md new file mode 100644 index 000000000..e49806631 --- /dev/null +++ b/website/content/v1.0/talos-guides/install/virtualized-platforms/kvm.md @@ -0,0 +1,9 @@ +--- +title: "KVM" +aliases: + - ../../../virtualized-platforms/kvm +--- + +Talos is known to work on KVM. +We don't yet have a documented guide specific to KVM; however, you can follow the [General Getting Started Guide]({{< relref "../../../introduction/getting-started" >}}). +If you run into any issues, our [community](https://slack.dev.talos-systems.io/) can probably help! diff --git a/website/content/v1.0/virtualized-platforms/proxmox.md b/website/content/v1.0/talos-guides/install/virtualized-platforms/proxmox.md similarity index 99% rename from website/content/v1.0/virtualized-platforms/proxmox.md rename to website/content/v1.0/talos-guides/install/virtualized-platforms/proxmox.md index 3d8726951..bc3ff5d2f 100644 --- a/website/content/v1.0/virtualized-platforms/proxmox.md +++ b/website/content/v1.0/talos-guides/install/virtualized-platforms/proxmox.md @@ -1,6 +1,8 @@ --- title: Proxmox description: "Creating Talos Kubernetes cluster using Proxmox." +aliases: + - ../../../virtualized-platforms/proxmox --- In this guide we will create a Kubernetes cluster using Proxmox. diff --git a/website/content/v1.0/virtualized-platforms/vmware.md b/website/content/v1.0/talos-guides/install/virtualized-platforms/vmware.md similarity index 99% rename from website/content/v1.0/virtualized-platforms/vmware.md rename to website/content/v1.0/talos-guides/install/virtualized-platforms/vmware.md index 061f4143d..a9cb3e415 100644 --- a/website/content/v1.0/virtualized-platforms/vmware.md +++ b/website/content/v1.0/talos-guides/install/virtualized-platforms/vmware.md @@ -1,6 +1,8 @@ --- title: "VMware" description: "Creating Talos Kubernetes cluster using VMware." +aliases: + - ../../../virtualized-platforms/vmware --- ## Creating a Cluster via the `govc` CLI diff --git a/website/content/v1.0/virtualized-platforms/vmware/cp.patch.yaml b/website/content/v1.0/talos-guides/install/virtualized-platforms/vmware/cp.patch.yaml similarity index 100% rename from website/content/v1.0/virtualized-platforms/vmware/cp.patch.yaml rename to website/content/v1.0/talos-guides/install/virtualized-platforms/vmware/cp.patch.yaml diff --git a/website/content/v1.0/virtualized-platforms/vmware/vmware.sh b/website/content/v1.0/talos-guides/install/virtualized-platforms/vmware/vmware.sh similarity index 100% rename from website/content/v1.0/virtualized-platforms/vmware/vmware.sh rename to website/content/v1.0/talos-guides/install/virtualized-platforms/vmware/vmware.sh diff --git a/website/content/v1.1/virtualized-platforms/xen.md b/website/content/v1.0/talos-guides/install/virtualized-platforms/xen.md similarity index 58% rename from website/content/v1.1/virtualized-platforms/xen.md rename to website/content/v1.0/talos-guides/install/virtualized-platforms/xen.md index 503d46f68..00beea04f 100644 --- a/website/content/v1.1/virtualized-platforms/xen.md +++ b/website/content/v1.0/talos-guides/install/virtualized-platforms/xen.md @@ -1,7 +1,9 @@ --- title: "Xen" +aliases: + - ../../../virtualized-platforms/xen --- Talos is known to work on Xen. -We don't yet have a documented guide specific to Xen; however, you can follow the [General Getting Started Guide](../../introduction/getting-started). +We don't yet have a documented guide specific to Xen; however, you can follow the [General Getting Started Guide]({{< relref "../../../introduction/getting-started" >}}). If you run into any issues, our [community](https://slack.dev.talos-systems.io/) can probably help! diff --git a/website/content/v1.0/talos-guides/network/_index.md b/website/content/v1.0/talos-guides/network/_index.md new file mode 100644 index 000000000..40e8ec1b1 --- /dev/null +++ b/website/content/v1.0/talos-guides/network/_index.md @@ -0,0 +1,5 @@ +--- +title: "Network" +weight: 30 +description: "Set up networking layers for Talos Linux" +--- diff --git a/website/content/v1.1/guides/configuring-corporate-proxies.md b/website/content/v1.0/talos-guides/network/corporate-proxies.md similarity index 82% rename from website/content/v1.1/guides/configuring-corporate-proxies.md rename to website/content/v1.0/talos-guides/network/corporate-proxies.md index 8cc13ba45..0877d248d 100644 --- a/website/content/v1.1/guides/configuring-corporate-proxies.md +++ b/website/content/v1.0/talos-guides/network/corporate-proxies.md @@ -1,6 +1,8 @@ --- -title: "Configuring Corporate Proxies" -description: "" +title: "Corporate Proxies" +description: "How to configure Talos Linux to use proxies in a corporate environment" +aliases: + - ../../guides/configuring-corporate-proxies --- ## Appending the Certificate Authority of MITM Proxies diff --git a/website/content/v1.0/guides/vip.md b/website/content/v1.0/talos-guides/network/vip.md similarity index 95% rename from website/content/v1.0/guides/vip.md rename to website/content/v1.0/talos-guides/network/vip.md index 3ae5ce5dd..183960370 100644 --- a/website/content/v1.0/guides/vip.md +++ b/website/content/v1.0/talos-guides/network/vip.md @@ -1,5 +1,8 @@ --- -title: Virtual (shared) IP +title: "Virtual (shared) IP" +description: "Using Talos Linux to set up a floating virtual IP address for cluster access." +aliases: + - ../../guides/vip --- One of the biggest pain points when building a high-availability controlplane diff --git a/website/content/v1.0/guides/configuring-wireguard-network.md b/website/content/v1.0/talos-guides/network/wireguard-network.md similarity index 91% rename from website/content/v1.0/guides/configuring-wireguard-network.md rename to website/content/v1.0/talos-guides/network/wireguard-network.md index 6102d3966..c8ffafd19 100644 --- a/website/content/v1.0/guides/configuring-wireguard-network.md +++ b/website/content/v1.0/talos-guides/network/wireguard-network.md @@ -1,6 +1,8 @@ --- -title: "Configuring Wireguard Network" -description: "In this guide you will learn how to set up Wireguard network using Kernel module." +title: "Wireguard Network" +description: "A guide on how to set up Wireguard network using Kernel module." +aliases: + - ../../../guides/configuring-wireguard-network --- ## Configuring Wireguard Network @@ -99,4 +101,4 @@ network: When `networkd` gets this configuration it will create the device, configure it and will bring it up (equivalent to `ip link set up dev wg0`). -All supported config parameters are described in the [Machine Config Reference](../../reference/configuration/#devicewireguardconfig). +All supported config parameters are described in the [Machine Config Reference]({{< relref "../../reference/configuration#devicewireguardconfig" >}}). diff --git a/website/content/v1.1/guides/resetting-a-machine.md b/website/content/v1.0/talos-guides/resetting-a-machine.md similarity index 94% rename from website/content/v1.1/guides/resetting-a-machine.md rename to website/content/v1.0/talos-guides/resetting-a-machine.md index fb8a780e7..f3514ce33 100644 --- a/website/content/v1.1/guides/resetting-a-machine.md +++ b/website/content/v1.0/talos-guides/resetting-a-machine.md @@ -1,6 +1,8 @@ --- title: "Resetting a Machine" -description: "" +description: "Steps on how to reset a Talos Linux machine to a clean state." +aliases: + - ../guides/resetting-a-machine --- From time to time, it may be beneficial to reset a Talos machine to its "original" state. diff --git a/website/content/v1.0/guides/upgrading-talos.md b/website/content/v1.0/talos-guides/upgrading-talos.md similarity index 96% rename from website/content/v1.0/guides/upgrading-talos.md rename to website/content/v1.0/talos-guides/upgrading-talos.md index d8f671dbf..ff0074a33 100644 --- a/website/content/v1.0/guides/upgrading-talos.md +++ b/website/content/v1.0/talos-guides/upgrading-talos.md @@ -1,5 +1,8 @@ --- -title: Upgrading Talos Linux +title: "Upgrading Talos Linux" +description: "Guide on upgrading a Talos Linux machine." +aliases: + - ../guides/upgrading-talos --- OS upgrades, like other operations on Talos Linux, are effected by an API call, which can be sent via the `talosctl` CLI utility. @@ -78,11 +81,11 @@ future. There are new machine configuration features which can be used after an upgrade: -- `.machine.pods` to specify [static pods]({{< ref "static-pods">}}) +- `.machine.pods` to specify [static pods]({{< relref "../advanced/static-pods" >}}) - `.machine.sysfs` to set `sysfs` (`/sys`) kernel parameters - `.machine.kernel` to load the kernel modules (Talos doesn't ship with kernel modules, only for custom builds) - `.machine.kubelet.extraConfig` to override `kubelet` configuration -- `.machine.install.extensions` to specify [system extensions]({{< ref "system-extensions">}}) to be installed +- `.machine.install.extensions` to specify [system extensions]({{< relref "configuration/system-extensions" >}}) to be installed - `.cluster.apiServer.env`, `.cluster.controllerManager.env` and `cluster.scheduler.env` to set the environment variables for the control plane components - `.cluster.apiServer.admissionControl` to specify admission plugin configuration diff --git a/website/content/v1.0/virtualized-platforms/_index.md b/website/content/v1.0/virtualized-platforms/_index.md deleted file mode 100644 index 66f845511..000000000 --- a/website/content/v1.0/virtualized-platforms/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Virtualized Platforms" -weight: 30 ---- diff --git a/website/content/v1.0/virtualized-platforms/kvm.md b/website/content/v1.0/virtualized-platforms/kvm.md deleted file mode 100644 index a21999956..000000000 --- a/website/content/v1.0/virtualized-platforms/kvm.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "KVM" ---- - -Talos is known to work on KVM. -We don't yet have a documented guide specific to Xen; however, you can follow the [General Getting Started Guide](../../introduction/getting-started). -If you run into any issues, our [community](https://slack.dev.talos-systems.io/) can probably help! diff --git a/website/content/v1.1/_index.md b/website/content/v1.1/_index.md index 838e32de4..aeab6c106 100644 --- a/website/content/v1.1/_index.md +++ b/website/content/v1.1/_index.md @@ -15,9 +15,9 @@ prevKubernetesRelease: "1.23.5" Welcome to the Talos documentation. If you are just getting familiar with Talos, we recommend starting here: -- [What is Talos](introduction/what-is-talos/): a quick description of Talos -- [Quickstart](introduction/quickstart/): the fastest way to get a Talos cluster up and running -- [Getting Started](introduction/getting-started/): a long-form, guided tour of getting a full Talos cluster deployed +- [What is Talos]({{< relref "introduction/what-is-talos" >}}): a quick description of Talos +- [Quickstart]({{< relref "introduction/quickstart" >}}): the fastest way to get a Talos cluster up and running +- [Getting Started]({{< relref "introduction/getting-started" >}}): a long-form, guided tour of getting a full Talos cluster deployed ## Open Source diff --git a/website/content/v1.1/advanced/_index.md b/website/content/v1.1/advanced/_index.md new file mode 100644 index 000000000..3b85c2391 --- /dev/null +++ b/website/content/v1.1/advanced/_index.md @@ -0,0 +1,4 @@ +--- +title: "Advanced Guides" +weight: 60 +--- diff --git a/website/content/v1.0/guides/advanced-networking.md b/website/content/v1.1/advanced/advanced-networking.md similarity index 93% rename from website/content/v1.0/guides/advanced-networking.md rename to website/content/v1.1/advanced/advanced-networking.md index 8361db677..11090497d 100644 --- a/website/content/v1.0/guides/advanced-networking.md +++ b/website/content/v1.1/advanced/advanced-networking.md @@ -1,5 +1,8 @@ --- title: "Advanced Networking" +description: "How to configure advanced networking options on Talos Linux." +aliases: + - ../guides/advanced-networking --- ## Static Addressing diff --git a/website/content/v1.1/guides/air-gapped.md b/website/content/v1.1/advanced/air-gapped.md similarity index 91% rename from website/content/v1.1/guides/air-gapped.md rename to website/content/v1.1/advanced/air-gapped.md index d34525c53..80c5903fc 100644 --- a/website/content/v1.1/guides/air-gapped.md +++ b/website/content/v1.1/advanced/air-gapped.md @@ -1,16 +1,19 @@ --- -title: Air-gapped Environments +title: "Air-gapped Environments" +description: "Setting up Talos Linux to work in environments with no internet access." +aliases: + - ../guides/air-gapped --- In this guide we will create a Talos cluster running in an air-gapped environment with all the required images being pulled from an internal registry. -We will use the [QEMU](../../local-platforms/qemu/) provisioner available in `talosctl` to create a local cluster, but the same approach could be used to deploy Talos in bigger air-gapped networks. +We will use the [QEMU]({{< relref "../talos-guides/install/local-platforms/qemu" >}}) provisioner available in `talosctl` to create a local cluster, but the same approach could be used to deploy Talos in bigger air-gapped networks. ## Requirements The follow are requirements for this guide: - Docker 18.03 or greater -- Requirements for the Talos [QEMU](../../local-platforms/qemu/) cluster +- Requirements for the Talos [QEMU]({{< relref "../talos-guides/install/local-platforms/qemu" >}}) cluster ## Identifying Images diff --git a/website/content/v1.1/guides/customizing-the-kernel.md b/website/content/v1.1/advanced/customizing-the-kernel.md similarity index 93% rename from website/content/v1.1/guides/customizing-the-kernel.md rename to website/content/v1.1/advanced/customizing-the-kernel.md index 0da33e3ad..bdb83d4e8 100644 --- a/website/content/v1.1/guides/customizing-the-kernel.md +++ b/website/content/v1.1/advanced/customizing-the-kernel.md @@ -1,6 +1,8 @@ --- title: "Customizing the Kernel" -description: "" +description: "Guide on how to customize the kernel used by Talos Linux." +aliases: + - ../guides/customizing-the-kernel --- The installer image contains [`ONBUILD`](https://docs.docker.com/engine/reference/builder/#onbuild) instructions that handle the following: diff --git a/website/content/v1.1/guides/customizing-the-root-filesystem.md b/website/content/v1.1/advanced/customizing-the-root-filesystem.md similarity index 93% rename from website/content/v1.1/guides/customizing-the-root-filesystem.md rename to website/content/v1.1/advanced/customizing-the-root-filesystem.md index 7009aa55d..2e7eaabbe 100644 --- a/website/content/v1.1/guides/customizing-the-root-filesystem.md +++ b/website/content/v1.1/advanced/customizing-the-root-filesystem.md @@ -1,6 +1,8 @@ --- title: "Customizing the Root Filesystem" -description: "" +description: "How to add your own content to the immutable root file system of Talos Linux." +aliases: + - ../guides/customizing-the-root-filesystem --- The installer image contains [`ONBUILD`](https://docs.docker.com/engine/reference/builder/#onbuild) instructions that handle the following: diff --git a/website/content/v1.0/learn-more/developing-talos.md b/website/content/v1.1/advanced/developing-talos.md similarity index 98% rename from website/content/v1.0/learn-more/developing-talos.md rename to website/content/v1.1/advanced/developing-talos.md index 07b643b31..52c640fe1 100644 --- a/website/content/v1.0/learn-more/developing-talos.md +++ b/website/content/v1.1/advanced/developing-talos.md @@ -1,6 +1,8 @@ --- title: "Developing Talos" -weight: 130 +description: "Learn how to set up a development environment for local testing and hacking on Talos itself!" +aliases: + - ../learn-more/developing-talos --- This guide outlines steps and tricks to develop Talos operating systems and related components. diff --git a/website/content/v1.1/guides/disaster-recovery.md b/website/content/v1.1/advanced/disaster-recovery.md similarity index 99% rename from website/content/v1.1/guides/disaster-recovery.md rename to website/content/v1.1/advanced/disaster-recovery.md index 34eac184d..defe58dd4 100644 --- a/website/content/v1.1/guides/disaster-recovery.md +++ b/website/content/v1.1/advanced/disaster-recovery.md @@ -1,6 +1,8 @@ --- title: "Disaster Recovery" description: "Procedure for snapshotting etcd database and recovering from catastrophic control plane failure." +aliases: + - ../guides/disaster-recovery --- `etcd` database backs Kubernetes control plane state, so if the `etcd` service is unavailable diff --git a/website/content/v1.1/learn-more/extension-services.md b/website/content/v1.1/advanced/extension-services.md similarity index 93% rename from website/content/v1.1/learn-more/extension-services.md rename to website/content/v1.1/advanced/extension-services.md index 35b737190..290228591 100644 --- a/website/content/v1.1/learn-more/extension-services.md +++ b/website/content/v1.1/advanced/extension-services.md @@ -1,13 +1,15 @@ --- title: "Extension Services" -weight: 105 +description: "Use extension services in Talos Linux." +aliases: + - ../learn-more/extention-services --- Talos provides a way to run additional system services early in the Talos boot process. -Extension services should be included into the Talos root filesystem (e.g. using [system extensions](../../guides/system-extensions/)). +Extension services should be included into the Talos root filesystem (e.g. using [system extensions]({{< relref "../talos-guides/configuration/system-extensions" >}})). Extension services run as privileged containers with ephemeral root filesystem located in the Talos root filesystem. -Extension services can be used to use extend core features of Talos in a way that is not possible via [static pods](../../guides/static-pods) or +Extension services can be used to use extend core features of Talos in a way that is not possible via [static pods]({{< relref "../advanced/static-pods" >}}) or Kubernetes DaemonSets. Potential extension services use-cases: diff --git a/website/content/v1.1/guides/adding-a-proprietary-kernel-module.md b/website/content/v1.1/advanced/proprietary-kernel-modules.md similarity index 94% rename from website/content/v1.1/guides/adding-a-proprietary-kernel-module.md rename to website/content/v1.1/advanced/proprietary-kernel-modules.md index 7f935b4db..21e3dc308 100644 --- a/website/content/v1.1/guides/adding-a-proprietary-kernel-module.md +++ b/website/content/v1.1/advanced/proprietary-kernel-modules.md @@ -1,6 +1,8 @@ --- -title: "Adding a proprietary kernel module to Talos Linux" -description: "" +title: "Proprietary Kernel Modules" +description: "Adding a proprietary kernel module to Talos Linux" +aliases: + - ../guides/adding-a-proprietary-kernel-module --- 1. Patching and building the kernel image diff --git a/website/content/v1.0/guides/static-pods.md b/website/content/v1.1/advanced/static-pods.md similarity index 97% rename from website/content/v1.0/guides/static-pods.md rename to website/content/v1.1/advanced/static-pods.md index afbccdb80..da2eaae22 100644 --- a/website/content/v1.0/guides/static-pods.md +++ b/website/content/v1.1/advanced/static-pods.md @@ -1,5 +1,8 @@ --- title: "Static Pods" +description: "Using Talos Linux to set up static pods in Kubernetes." +aliases: + - ../guides/static-pods --- ## Static Pods diff --git a/website/content/v1.0/guides/troubleshooting-control-plane.md b/website/content/v1.1/advanced/troubleshooting-control-plane.md similarity index 98% rename from website/content/v1.0/guides/troubleshooting-control-plane.md rename to website/content/v1.1/advanced/troubleshooting-control-plane.md index b7712014c..defc2875e 100644 --- a/website/content/v1.0/guides/troubleshooting-control-plane.md +++ b/website/content/v1.1/advanced/troubleshooting-control-plane.md @@ -1,6 +1,8 @@ --- title: "Troubleshooting Control Plane" description: "Troubleshoot control plane failures for running cluster and bootstrap process." +aliases: + - ../guides/troubleshooting-control-plane --- @@ -48,7 +50,7 @@ Therefore, the number of control plane nodes should almost always be 3. In some particularly large or distributed clusters, the count may be 5, but this is very rare. -See [this document](../../learn-more/concepts/#control-planes-are-not-linear-replicas) on the topic for more information. +See [this document]({{< relref "../learn-more/concepts#control-planes-are-not-linear-replicas" >}}) on the topic for more information. ### What is the control plane endpoint? @@ -77,7 +79,7 @@ As mentioned above, this can be achieved by a number of strategies, including: - an external load balancer - DNS records -- Talos-builtin shared IP ([VIP](../vip/) +- Talos-builtin shared IP ([VIP]({{< relref "../talos-guides/network/vip" >}})) - BGP peering of a shared IP (such as with [kube-vip](https://kube-vip.io)) Using a DNS name here is usually a good idea, it being the most flexible diff --git a/website/content/v1.1/bare-metal-platforms/_index.md b/website/content/v1.1/bare-metal-platforms/_index.md deleted file mode 100644 index a4c9c94d2..000000000 --- a/website/content/v1.1/bare-metal-platforms/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Bare Metal Platforms" -weight: 20 ---- diff --git a/website/content/v1.1/cloud-platforms/_index.md b/website/content/v1.1/cloud-platforms/_index.md deleted file mode 100644 index 3307f8f0f..000000000 --- a/website/content/v1.1/cloud-platforms/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Cloud Platforms" -weight: 40 ---- diff --git a/website/content/v1.1/guides/_index.md b/website/content/v1.1/guides/_index.md deleted file mode 100644 index 4294954ba..000000000 --- a/website/content/v1.1/guides/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Guides" -weight: 60 ---- diff --git a/website/content/v1.1/introduction/_index.md b/website/content/v1.1/introduction/_index.md index 143d3ae12..a12a4a13c 100644 --- a/website/content/v1.1/introduction/_index.md +++ b/website/content/v1.1/introduction/_index.md @@ -1,4 +1,4 @@ --- title: "Introduction" -weight: 1 +weight: 10 --- diff --git a/website/content/v1.1/introduction/getting-started.md b/website/content/v1.1/introduction/getting-started.md index 2bc8c7884..decc36eff 100644 --- a/website/content/v1.1/introduction/getting-started.md +++ b/website/content/v1.1/introduction/getting-started.md @@ -1,10 +1,11 @@ --- title: Getting Started -weight: 3 +weight: 30 +description: "A guide to setting up a Talos Linux cluster on multiple machines." --- This document will walk you through installing a full Talos Cluster. -You may wish to try the [Quickstart](../quickstart/) first, to quickly create a local virtual cluster on your workstation. +You may wish to try the [Quickstart]({{< relref "quickstart" >}}) first, to quickly create a local virtual cluster on your workstation. Regardless of where you run Talos, there is a pattern to deploying it. In general you need to: @@ -63,7 +64,7 @@ For network booting and self-built media, you can use the published kernel and i - ARM64: [vmlinuz-arm64](https://github.com/siderolabs/talos/releases/download/{{< release >}}/vmlinuz-arm64) [initramfs-arm64.xz](https://github.com/siderolabs/talos/releases/download/{{< release >}}/initramfs-arm64.xz) Note that to use alternate booting, there are a number of required kernel parameters. -Please see the [kernel](../../reference/kernel/) docs for more information. +Please see the [kernel]({{< relref "../reference/kernel" >}}) docs for more information. ## Decide the Kubernetes Endpoint @@ -118,7 +119,7 @@ https://192.168.0.15:6443 You are free to set a DNS record to this IP address to identify the endpoint, but you will need to use the IP address itself, not the DNS name, to configure the shared IP (`machine.network.interfaces[].vip.ip`) in the Talos configuration. For more information about using a shared IP, see the related -[Guide](../../guides/vip/) +[Guide]({{< relref "../talos-guides/network/vip" >}}) ### DNS records @@ -176,7 +177,7 @@ In cases where a PXE server can be available, this is much more efficient than manually configuring each node. If you do use this method, just note that Talos does require a number of other kernel commandline parameters. -See the [required kernel parameters](../../reference/kernel/) for more information. +See the [required kernel parameters]({{< relref "../reference/kernel" >}}) for more information. In either case, we need to generate the configuration which is to be provided. Luckily, the `talosctl` tool comes with a configuration generator for exactly @@ -385,7 +386,7 @@ Server: ``` For a more in-depth discussion of Endpoints and Nodes, please see -[talosctl](../../learn-more/talosctl/). +[talosctl]({{< relref "../learn-more/talosctl" >}}). ### Default configuration file diff --git a/website/content/v1.1/introduction/quickstart.md b/website/content/v1.1/introduction/quickstart.md index 160244638..bd1dbefea 100644 --- a/website/content/v1.1/introduction/quickstart.md +++ b/website/content/v1.1/introduction/quickstart.md @@ -1,6 +1,7 @@ --- title: Quickstart -weight: 2 +weight: 20 +description: "A short guide on setting up a simple Talos Linux cluster locally with Docker." --- There are two easy ways to try out Talos Linux. diff --git a/website/content/v1.1/introduction/support-matrix.md b/website/content/v1.1/introduction/support-matrix.md index e2c91e358..8fb896094 100644 --- a/website/content/v1.1/introduction/support-matrix.md +++ b/website/content/v1.1/introduction/support-matrix.md @@ -1,21 +1,22 @@ --- title: Support Matrix -weight: 6 +weight: 60 +description: "Table of supported Talos Linux versions and respective platforms." --- | Talos Version | 1.1 | 1.0 | |----------------------------------------------------------------------------------------------------------------|------------------------------------|------------------------------------| | Release Date | 2022-06-01, T | 2022-03-29 (1.0.0) | | End of Community Support | 1.2.0 release (2022-09-01, TBD) | 1.1.0 release (2022-06-01, TBD) | -| Enterprise Support | [offered by Sidero Labs Inc.](https://www.siderolabs.com/support/) | -| Kubernetes | 1.24, 1.23, 1.22 | 1.23, 1.22, 1.21 | -| Architecture | amd64, arm64 | +| Enterprise Support | [offered by Sidero Labs Inc.](https://www.siderolabs.com/support/) | [offered by Sidero Labs Inc.](https://www.siderolabs.com/support/) | +| Kubernetes | 1.23, 1.22, 1.21 | 1.23, 1.22, 1.21 | +| Architecture | amd64, arm64 | amd64, arm64 | | **Platforms** | | | -| Cloud | AWS, GCP, Azure, Digital Ocean, Hetzner, OpenStack, Oracle Cloud, Scaleway, Vultr, Upcloud | AWS, GCP, Azure, Digital Ocean, Hetzner, OpenStack, Scaleway, Vultr, Upcloud | -| Bare Metal | x86: BIOS, UEFI; arm64: UEFI; boot: ISO, PXE, disk image | -| Virtualized | VMware, Hyper-V, KVM, Proxmox, Xen | -| SBCs | Banana Pi M64, Jetson Nano, Libre Computer Board ALL-H3-CC, Pine64, Pine64 Rock64, Radxa ROCK Pi 4, Raspberry Pi 4B |Banana Pi M64, Jetson Nano, Libre Computer Board ALL-H3-CC, Pine64, Pine64 Rock64, Radxa ROCK Pi 4c, Raspberry Pi 4B| -| Local | Docker, QEMU | +| - cloud | AWS, GCP, Azure, Digital Ocean, Hetzner, OpenStack, Oracle Cloud, Scaleway, Vultr, Upcloud | AWS, GCP, Azure, Digital Ocean, Hetzner, OpenStack, Scaleway, Vultr, Upcloud | +| - bare metal | x86: BIOS, UEFI; arm64: UEFI; boot: ISO, PXE, disk image | x86: BIOS, UEFI; arm64: UEFI; boot: ISO, PXE, disk image | +| - virtualized | VMware, Hyper-V, KVM, Proxmox, Xen | VMware, Hyper-V, KVM, Proxmox, Xen | +| - SBCs | Banana Pi M64, Jetson Nano, Libre Computer Board ALL-H3-CC, Pine64, Pine64 Rock64, Radxa ROCK Pi 4c, Raspberry Pi 4B | Raspberry Pi4, Banana Pi M64, Pine64, and other | +| - local | Docker, QEMU | Docker, QEMU | | **Cluster API** | | | | [CAPI Bootstrap Provider Talos](https://github.com/siderolabs/cluster-api-bootstrap-provider-talos) | >= 0.5.3 | >= 0.5.3 | | [CAPI Control Plane Provider Talos](https://github.com/siderolabs/cluster-api-control-plane-provider-talos) | >= 0.4.5 | >= 0.4.5 | diff --git a/website/content/v1.1/introduction/system-requirements.md b/website/content/v1.1/introduction/system-requirements.md index ee5cbe6df..734c84da2 100644 --- a/website/content/v1.1/introduction/system-requirements.md +++ b/website/content/v1.1/introduction/system-requirements.md @@ -1,6 +1,7 @@ --- title: System Requirements -weight: 4 +weight: 40 +description: "Hardware requirements for running Talos Linux." --- ## Minimum Requirements diff --git a/website/content/v1.1/introduction/what-is-new.md b/website/content/v1.1/introduction/what-is-new.md index 6e521114d..bf2330429 100644 --- a/website/content/v1.1/introduction/what-is-new.md +++ b/website/content/v1.1/introduction/what-is-new.md @@ -1,6 +1,7 @@ --- title: What's New in Talos 1.1 -weight: 5 +weight: 50 +description: "List of new and shiny features in Talos Linux." --- TBD diff --git a/website/content/v1.1/introduction/what-is-talos.md b/website/content/v1.1/introduction/what-is-talos.md index 7ba56ac43..d0b047d99 100644 --- a/website/content/v1.1/introduction/what-is-talos.md +++ b/website/content/v1.1/introduction/what-is-talos.md @@ -1,6 +1,7 @@ --- title: What is Talos? -weight: 1 +weight: 10 +description: "A quick introduction in to what Talos is and why it should be used." --- Talos is a container optimized Linux distro; a reimagining of Linux for distributed systems such as Kubernetes. diff --git a/website/content/v1.1/kubernetes-guides/_index.md b/website/content/v1.1/kubernetes-guides/_index.md new file mode 100644 index 000000000..1c9c43e36 --- /dev/null +++ b/website/content/v1.1/kubernetes-guides/_index.md @@ -0,0 +1,5 @@ +--- +title: "Kubernetes Guides" +weight: 30 +description: "Management of a Kubernetes Cluster hosted by Talos Linux" +--- diff --git a/website/content/v1.1/kubernetes-guides/configuration/_index.md b/website/content/v1.1/kubernetes-guides/configuration/_index.md new file mode 100644 index 000000000..d44941272 --- /dev/null +++ b/website/content/v1.1/kubernetes-guides/configuration/_index.md @@ -0,0 +1,5 @@ +--- +title: "Configuration" +weight: 10 +description: "How to configure components of the Kubernetes cluster itself." +--- diff --git a/website/content/v1.1/guides/configuring-ceph-with-rook.md b/website/content/v1.1/kubernetes-guides/configuration/ceph-with-rook.md similarity index 98% rename from website/content/v1.1/guides/configuring-ceph-with-rook.md rename to website/content/v1.1/kubernetes-guides/configuration/ceph-with-rook.md index 2fb159bfa..49d99f30f 100644 --- a/website/content/v1.1/guides/configuring-ceph-with-rook.md +++ b/website/content/v1.1/kubernetes-guides/configuration/ceph-with-rook.md @@ -1,6 +1,8 @@ --- -title: "Configuring Ceph with Rook" -description: "" +title: "Ceph Storage cluster with Rook" +description: "Guide on how to create a simple Ceph storage cluster with Rook for Kubernetes" +aliases: + - ../../guides/configuring-ceph-with-rook --- ## Preparation diff --git a/website/content/v1.1/guides/configuring-the-cluster-endpoint.md b/website/content/v1.1/kubernetes-guides/configuration/cluster-endpoint.md similarity index 88% rename from website/content/v1.1/guides/configuring-the-cluster-endpoint.md rename to website/content/v1.1/kubernetes-guides/configuration/cluster-endpoint.md index 9c2ef9760..55e9a631d 100644 --- a/website/content/v1.1/guides/configuring-the-cluster-endpoint.md +++ b/website/content/v1.1/kubernetes-guides/configuration/cluster-endpoint.md @@ -1,6 +1,8 @@ --- -title: "Configuring the Cluster Endpoint" -description: "" +title: "Cluster Endpoint" +description: "How to explicitly set up an endpoint for the cluster API" +alises: + - ../../guides/configuring-the-cluster-endpoint --- In this section, we will step through the configuration of a Talos based Kubernetes cluster. @@ -31,7 +33,7 @@ The configuration can either be done on a Loadbalancer, or simply trough DNS. For example: > This is in the config file for the cluster e.g. controlplane.yaml and worker.yaml. -> for more details, please see: [v1alpha1 endpoint configuration](../../reference/configuration/#controlplaneconfig) +> for more details, please see: [v1alpha1 endpoint configuration]({{< relref "../../reference/configuration#controlplaneconfig" >}}) ```yaml ..... diff --git a/website/content/v1.1/guides/deploy-metrics-server.md b/website/content/v1.1/kubernetes-guides/configuration/deploy-metrics-server.md similarity index 97% rename from website/content/v1.1/guides/deploy-metrics-server.md rename to website/content/v1.1/kubernetes-guides/configuration/deploy-metrics-server.md index 0471cdbfc..59986d423 100644 --- a/website/content/v1.1/guides/deploy-metrics-server.md +++ b/website/content/v1.1/kubernetes-guides/configuration/deploy-metrics-server.md @@ -1,6 +1,8 @@ --- title: "Deploying Metrics Server" description: "In this guide you will learn how to set up metrics-server." +aliases: + - ../../guides/deploy-metrics-server --- Metrics Server enables use of the [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) and [Vertical Pod Autoscaler](https://github.com/kubernetes/autoscaler/tree/master/vertical-pod-autoscaler). diff --git a/website/content/v1.1/guides/discovery.md b/website/content/v1.1/kubernetes-guides/configuration/discovery.md similarity index 96% rename from website/content/v1.1/guides/discovery.md rename to website/content/v1.1/kubernetes-guides/configuration/discovery.md index f31aa0d4c..af68334ea 100644 --- a/website/content/v1.1/guides/discovery.md +++ b/website/content/v1.1/kubernetes-guides/configuration/discovery.md @@ -1,5 +1,8 @@ --- title: "Discovery" +description: "How to use Talos Linux cluster discovery" +aliases: + - ../../guides/discovery --- ## Video Walkthrough @@ -39,7 +42,7 @@ Annotations: cluster.talos.dev/node-id: Utoh3O0ZneV0kT2IUBrh7TgdouRcUW2yz ... ``` -`Service` registry uses external [Discovery Service](../../learn-more/discovery/) to exchange encrypted information about cluster members. +`Service` registry uses external [Discovery Service]({{< relref "../../learn-more/discovery/" >}}) to exchange encrypted information about cluster members. ## Resource Definitions diff --git a/website/content/v1.0/guides/pod-security.md b/website/content/v1.1/kubernetes-guides/configuration/pod-security.md similarity index 99% rename from website/content/v1.0/guides/pod-security.md rename to website/content/v1.1/kubernetes-guides/configuration/pod-security.md index 98a54ed5f..f102e1460 100644 --- a/website/content/v1.0/guides/pod-security.md +++ b/website/content/v1.1/kubernetes-guides/configuration/pod-security.md @@ -1,6 +1,8 @@ --- title: "Pod Security" description: "Enabling Pod Security Admission plugin to configure Pod Security Standards." +aliases: + - ../../guides/pod-security --- Kubernetes deprecated [Pod Security Policy](https://kubernetes.io/docs/concepts/policy/pod-security-policy/) as of v1.21, and it is diff --git a/website/content/v1.1/guides/storage.md b/website/content/v1.1/kubernetes-guides/configuration/storage.md similarity index 98% rename from website/content/v1.1/guides/storage.md rename to website/content/v1.1/kubernetes-guides/configuration/storage.md index 39a90857e..30f143a1b 100644 --- a/website/content/v1.1/guides/storage.md +++ b/website/content/v1.1/kubernetes-guides/configuration/storage.md @@ -1,6 +1,8 @@ --- title: "Storage" -description: "" +description: "Setting up storage for a Kubernetes cluster" +aliases: + - ../../guides/storage --- In Kubernetes, using storage in the right way is well-facilitated by the API. diff --git a/website/content/v1.1/kubernetes-guides/network/_index.md b/website/content/v1.1/kubernetes-guides/network/_index.md new file mode 100644 index 000000000..420161673 --- /dev/null +++ b/website/content/v1.1/kubernetes-guides/network/_index.md @@ -0,0 +1,5 @@ +--- +title: "Network" +weight: 20 +description: "Managing the Kubernetes cluster networking" +--- diff --git a/website/content/v1.0/guides/deploying-cilium.md b/website/content/v1.1/kubernetes-guides/network/deploying-cilium.md similarity index 99% rename from website/content/v1.0/guides/deploying-cilium.md rename to website/content/v1.1/kubernetes-guides/network/deploying-cilium.md index ce3a36db0..a33f758c5 100644 --- a/website/content/v1.0/guides/deploying-cilium.md +++ b/website/content/v1.1/kubernetes-guides/network/deploying-cilium.md @@ -1,6 +1,8 @@ --- title: "Deploying Cilium CNI" description: "In this guide you will learn how to set up Cilium CNI on Talos." +aliases: + - ../../guides/deploying-cilium --- From v1.9 onwards Cilium does no longer provide a one-liner install manifest that can be used to install Cilium on a node via `kubectl apply -f` or passing it in as an extra url in the `urls` part in the Talos machine configuration. diff --git a/website/content/v1.1/guides/kubespan.md b/website/content/v1.1/kubernetes-guides/network/kubespan.md similarity index 98% rename from website/content/v1.1/guides/kubespan.md rename to website/content/v1.1/kubernetes-guides/network/kubespan.md index d764fd114..417a160e5 100644 --- a/website/content/v1.1/guides/kubespan.md +++ b/website/content/v1.1/kubernetes-guides/network/kubespan.md @@ -1,5 +1,8 @@ --- title: "KubeSpan" +description: "Learn to use KubeSpan to connect Talos Linux machines securely across networks." +aliases: + - ../../guides/kubespan --- KubeSpan is a feature of Talos that automates the setup and maintenance of a full mesh [WireGuard](https://www.wireguard.com) network for your cluster, giving you the ability to operate hybrid Kubernetes clusters that can span the edge, datacenter, and cloud. diff --git a/website/content/v1.0/guides/upgrading-kubernetes.md b/website/content/v1.1/kubernetes-guides/upgrading-kubernetes.md similarity index 98% rename from website/content/v1.0/guides/upgrading-kubernetes.md rename to website/content/v1.1/kubernetes-guides/upgrading-kubernetes.md index ca3015e8e..dcefadb50 100644 --- a/website/content/v1.0/guides/upgrading-kubernetes.md +++ b/website/content/v1.1/kubernetes-guides/upgrading-kubernetes.md @@ -1,9 +1,12 @@ --- -title: Upgrading Kubernetes +title: "Upgrading Kubernetes" +description: "Guide on how to upgrade the Kubernetes cluster from Talos Linux." +aliases: + - guides/upgrading-kubernetes --- This guide covers upgrading Kubernetes on Talos Linux clusters. -For upgrading the Talos Linux operating system, see [Upgrading Talos](../upgrading-talos/) +For upgrading the Talos Linux operating system, see [Upgrading Talos]({{< relref "../talos-guides/upgrading-talos" >}}) ## Video Walkthrough diff --git a/website/content/v1.1/learn-more/architecture.md b/website/content/v1.1/learn-more/architecture.md index dcd1ab795..8190149e6 100644 --- a/website/content/v1.1/learn-more/architecture.md +++ b/website/content/v1.1/learn-more/architecture.md @@ -1,6 +1,7 @@ --- title: "Architecture" -weight: 30 +weight: 20 +description: "Learn the system architecture of Talos Linux itself." --- Talos is designed to be **atomic** in _deployment_ and **modular** in _composition_. diff --git a/website/content/v1.1/learn-more/components.md b/website/content/v1.1/learn-more/components.md index e9a1cce79..9b680ccc5 100644 --- a/website/content/v1.1/learn-more/components.md +++ b/website/content/v1.1/learn-more/components.md @@ -1,6 +1,7 @@ --- title: "Components" weight: 40 +description: "Understand the system components that make up Talos Linux." --- In this section, we discuss the various components that underpin Talos. diff --git a/website/content/v1.1/learn-more/concepts.md b/website/content/v1.1/learn-more/concepts.md index 96b22b3b0..4d5a32051 100644 --- a/website/content/v1.1/learn-more/concepts.md +++ b/website/content/v1.1/learn-more/concepts.md @@ -1,6 +1,7 @@ --- title: "Concepts" -weight: 20 +weight: 30 +description: "Summary of Talos Linux." --- When people come across Talos, they frequently want a nice, bite-sized summary diff --git a/website/content/v1.1/learn-more/control-plane.md b/website/content/v1.1/learn-more/control-plane.md index 0e4c51b5b..35bb526bf 100644 --- a/website/content/v1.1/learn-more/control-plane.md +++ b/website/content/v1.1/learn-more/control-plane.md @@ -1,6 +1,7 @@ --- title: "Control Plane" -weight: 80 +weight: 50 +description: "Understand the Kubernetes Control Plane." --- This guide provides details on how Talos runs and bootstraps the Kubernetes control plane. diff --git a/website/content/v1.1/learn-more/controllers-resources.md b/website/content/v1.1/learn-more/controllers-resources.md index 111ecfad4..bf15801f0 100644 --- a/website/content/v1.1/learn-more/controllers-resources.md +++ b/website/content/v1.1/learn-more/controllers-resources.md @@ -1,6 +1,7 @@ --- title: "Controllers and Resources" -weight: 90 +weight: 60 +description: "Discover how Talos Linux uses the concepts on Controllers and Resources." --- diff --git a/website/content/v1.1/learn-more/discovery.md b/website/content/v1.1/learn-more/discovery.md index 99ebaff8d..44461f8dc 100644 --- a/website/content/v1.1/learn-more/discovery.md +++ b/website/content/v1.1/learn-more/discovery.md @@ -1,6 +1,7 @@ --- title: "Discovery" -weight: 110 +weight: 90 +description: "Discover how Sidero Labs impliments Talos node discovery." --- We maintain a public discovery service whereby members of your cluster can use a common and unique key to coordinate the most basic connection information (i.e. the set of possible "endpoints", or IP:port pairs). diff --git a/website/content/v1.1/learn-more/faqs.md b/website/content/v1.1/learn-more/faqs.md index a6fe3b1af..290766a5a 100644 --- a/website/content/v1.1/learn-more/faqs.md +++ b/website/content/v1.1/learn-more/faqs.md @@ -1,6 +1,7 @@ --- title: "FAQs" -weight: 60 +weight: 999 +description: "Frequently Asked Questions about Talos Linux." --- diff --git a/website/content/v1.1/learn-more/kubespan.md b/website/content/v1.1/learn-more/kubespan.md index e55d0e5ba..f0f53647c 100644 --- a/website/content/v1.1/learn-more/kubespan.md +++ b/website/content/v1.1/learn-more/kubespan.md @@ -1,6 +1,7 @@ --- title: "KubeSpan" -weight: 120 +weight: 100 +description: "Understand more about KubeSpan for Talos Linux." --- ## WireGuard Peer Discovery @@ -28,7 +29,7 @@ For this discussion, we will point out two of these tiers: - an external service - a Kubernetes-based system -See [discovery service](../discovery) to learn more about the external service. +See [discovery service]({{< relref "discovery" >}}) to learn more about the external service. The Kubernetes-based system utilises annotations on Kubernetes Nodes which describe each node's public key and local addresses. diff --git a/website/content/v1.1/learn-more/networking-resources.md b/website/content/v1.1/learn-more/networking-resources.md index 2739dc6f2..5f664ae4e 100644 --- a/website/content/v1.1/learn-more/networking-resources.md +++ b/website/content/v1.1/learn-more/networking-resources.md @@ -1,9 +1,10 @@ --- title: "Networking Resources" -weight: 100 +weight: 70 +description: "Delve deeper into networking of Talos Linux." --- -Starting with version 0.11, a new implementation of the network configuration subsystem is powered by [COSI](../controllers-resources/). +Starting with version 0.11, a new implementation of the network configuration subsystem is powered by [COSI]({{< relref "controllers-resources" >}}). The new implementation is still using the same machine configuration file format and external sources to configure a node's network, so there should be no difference in the way Talos works in 0.11. diff --git a/website/content/v1.1/learn-more/philosophy.md b/website/content/v1.1/learn-more/philosophy.md index 744ee9517..a81c3c9f5 100644 --- a/website/content/v1.1/learn-more/philosophy.md +++ b/website/content/v1.1/learn-more/philosophy.md @@ -1,6 +1,7 @@ --- title: Philosophy weight: 10 +description: "Learn about the philosophy behind the need for Talos Linux." --- ## Distributed diff --git a/website/content/v1.1/guides/configuring-network-connectivity.md b/website/content/v1.1/learn-more/talos-network-connectivity.md similarity index 93% rename from website/content/v1.1/guides/configuring-network-connectivity.md rename to website/content/v1.1/learn-more/talos-network-connectivity.md index 0165990fc..ad60662a7 100644 --- a/website/content/v1.1/guides/configuring-network-connectivity.md +++ b/website/content/v1.1/learn-more/talos-network-connectivity.md @@ -1,6 +1,9 @@ --- -title: "Configuring Network Connectivity" -description: "" +title: "Network Connectivity" +weight: 80 +description: "Description of the Networking Connectivity needed by Talos Linux" +aliases: + - ../guides/configuring-network-connectivity --- ## Configuring Network Connectivity diff --git a/website/content/v1.1/learn-more/talosctl.md b/website/content/v1.1/learn-more/talosctl.md index b560d08b2..2580dbeb0 100644 --- a/website/content/v1.1/learn-more/talosctl.md +++ b/website/content/v1.1/learn-more/talosctl.md @@ -1,6 +1,7 @@ --- title: "talosctl" -weight: 70 +weight: 110 +description: "The design and use of the Talos Linux control application." --- The `talosctl` tool packs a lot of power into a small package. @@ -59,4 +60,4 @@ number of kubernetes clusters from the same workstation. ## Commands -Please see the [CLI reference](../../reference/cli/) for the entire list of commands which are available from `talosctl`. +Please see the [CLI reference]({{< relref "../reference/cli" >}}) for the entire list of commands which are available from `talosctl`. diff --git a/website/content/v1.1/local-platforms/_index.md b/website/content/v1.1/local-platforms/_index.md deleted file mode 100644 index e9b720762..000000000 --- a/website/content/v1.1/local-platforms/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Local Platforms" -weight: 50 ---- diff --git a/website/content/v1.1/reference/kernel.md b/website/content/v1.1/reference/kernel.md index 2a7cbedd3..7b4062691 100644 --- a/website/content/v1.1/reference/kernel.md +++ b/website/content/v1.1/reference/kernel.md @@ -1,6 +1,6 @@ --- -title: Kernel -desription: Linux kernel reference. +title: "Kernel" +description: "Linux kernel reference." --- ## Commandline Parameters diff --git a/website/content/v1.1/reference/platform.md b/website/content/v1.1/reference/platform.md index ade1369b0..5d9b53f58 100644 --- a/website/content/v1.1/reference/platform.md +++ b/website/content/v1.1/reference/platform.md @@ -1,5 +1,6 @@ --- -title: Platform +title: "Platform" +description: "Visualization of the bootstrap process on bare metal machines." --- ### Metal diff --git a/website/content/v1.1/single-board-computers/_index.md b/website/content/v1.1/single-board-computers/_index.md deleted file mode 100644 index 31b2227f4..000000000 --- a/website/content/v1.1/single-board-computers/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Single Board Computers" -weight: 55 ---- diff --git a/website/content/v1.1/talos-guides/_index.md b/website/content/v1.1/talos-guides/_index.md new file mode 100644 index 000000000..1596f8566 --- /dev/null +++ b/website/content/v1.1/talos-guides/_index.md @@ -0,0 +1,5 @@ +--- +title: Talos Linux Guides +weight: 20 +description: "Documentation on how to manage Talos Linux" +--- diff --git a/website/content/v1.1/talos-guides/configuration/_index.md b/website/content/v1.1/talos-guides/configuration/_index.md new file mode 100644 index 000000000..a3ced180e --- /dev/null +++ b/website/content/v1.1/talos-guides/configuration/_index.md @@ -0,0 +1,5 @@ +--- +title: "Configuration" +weight: 20 +description: "Guides on how to configure Talos Linux machines" +--- diff --git a/website/content/v1.0/guides/configuring-certificate-authorities.md b/website/content/v1.1/talos-guides/configuration/certificate-authorities.md similarity index 66% rename from website/content/v1.0/guides/configuring-certificate-authorities.md rename to website/content/v1.1/talos-guides/configuration/certificate-authorities.md index e759c5054..7af72aa46 100644 --- a/website/content/v1.0/guides/configuring-certificate-authorities.md +++ b/website/content/v1.1/talos-guides/configuration/certificate-authorities.md @@ -1,6 +1,8 @@ --- -title: "Configuring Certificate Authorities" -description: "" +title: "Custom Certificate Authorities" +description: "How to supply custom certificate authorities" +aliases: + - ../../guides/configuring-certificate-authorities --- ## Appending the Certificate Authority diff --git a/website/content/v1.0/guides/configuring-containerd.md b/website/content/v1.1/talos-guides/configuration/containerd.md similarity index 90% rename from website/content/v1.0/guides/configuring-containerd.md rename to website/content/v1.1/talos-guides/configuration/containerd.md index 192a2303d..bf396a041 100644 --- a/website/content/v1.0/guides/configuring-containerd.md +++ b/website/content/v1.1/talos-guides/configuration/containerd.md @@ -1,6 +1,8 @@ --- -title: "Configuring Containerd" -description: "" +title: "Containerd" +description: "Customize Containerd Settings" +aliases: + - ../../guides/configuring-containerd --- The base containerd configuration expects to merge in any additional configs present in `/var/cri/conf.d/*.toml`. diff --git a/website/content/v1.0/guides/disk-encryption.md b/website/content/v1.1/talos-guides/configuration/disk-encryption.md similarity index 99% rename from website/content/v1.0/guides/disk-encryption.md rename to website/content/v1.1/talos-guides/configuration/disk-encryption.md index 974f75de1..63cf5c699 100644 --- a/website/content/v1.0/guides/disk-encryption.md +++ b/website/content/v1.1/talos-guides/configuration/disk-encryption.md @@ -1,6 +1,8 @@ --- title: "Disk Encryption" description: "Guide on using system disk encryption" +aliases: + - ../../guides/disk-encryption --- It is possible to enable encryption for system disks at the OS level. diff --git a/website/content/v1.0/guides/editing-machine-configuration.md b/website/content/v1.1/talos-guides/configuration/editing-machine-configuration.md similarity index 97% rename from website/content/v1.0/guides/editing-machine-configuration.md rename to website/content/v1.1/talos-guides/configuration/editing-machine-configuration.md index dbe1428d5..0adf836a2 100644 --- a/website/content/v1.0/guides/editing-machine-configuration.md +++ b/website/content/v1.1/talos-guides/configuration/editing-machine-configuration.md @@ -1,9 +1,11 @@ --- title: "Editing Machine Configuration" description: "How to edit and patch Talos machine configuration, with reboot, immediately, or stage update on reboot." +aliases: + - ../../guides/editing-machine-configuration --- -Talos node state is fully defined by [machine configuration](../../reference/configuration/). +Talos node state is fully defined by [machine configuration]({{< relref "../../reference/configuration" >}}). Initial configuration is delivered to the node at bootstrap time, but configuration can be updated while the node is running. > Note: Be sure that config is persisted so that configuration updates are not overwritten on reboots. diff --git a/website/content/v1.1/guides/logging.md b/website/content/v1.1/talos-guides/configuration/logging.md similarity index 99% rename from website/content/v1.1/guides/logging.md rename to website/content/v1.1/talos-guides/configuration/logging.md index 9822fe13a..389f3084f 100644 --- a/website/content/v1.1/guides/logging.md +++ b/website/content/v1.1/talos-guides/configuration/logging.md @@ -1,5 +1,8 @@ --- -title: Logging +title: "Logging" +description: "Dealing with Talos Linux logs." +aliases: + - ../../guiides/logging --- ## Viewing logs diff --git a/website/content/v1.0/guides/managing-pki.md b/website/content/v1.1/talos-guides/configuration/managing-pki.md similarity index 93% rename from website/content/v1.0/guides/managing-pki.md rename to website/content/v1.1/talos-guides/configuration/managing-pki.md index a3f5f94d4..5d14dcf7d 100644 --- a/website/content/v1.0/guides/managing-pki.md +++ b/website/content/v1.1/talos-guides/configuration/managing-pki.md @@ -1,6 +1,8 @@ --- title: "Managing PKI" -description: "" +description: "How to manage Public Key Infrastructure" +aliases: + - ../../guides/managing-pki --- ## Generating an Administrator Key Pair diff --git a/website/content/v1.0/guides/nvidia-gpu.md b/website/content/v1.1/talos-guides/configuration/nvidia-gpu.md similarity index 98% rename from website/content/v1.0/guides/nvidia-gpu.md rename to website/content/v1.1/talos-guides/configuration/nvidia-gpu.md index 9baed4728..f734f40be 100644 --- a/website/content/v1.0/guides/nvidia-gpu.md +++ b/website/content/v1.1/talos-guides/configuration/nvidia-gpu.md @@ -1,6 +1,8 @@ --- title: "NVIDIA GPU" description: "In this guide we'll follow the procedure to support NVIDIA GPU on Talos." +aliases: + - ../../guides/nvidia-gpu --- > Enabling NVIDIA GPU support on Talos is bound by [NVIDIA EULA](https://www.nvidia.com/en-us/drivers/nvidia-license/) @@ -13,7 +15,7 @@ These are the steps to enabling NVIDIA support in Talos. - Building NVIDIA container toolkit system extension which allows to register a custom runtime with containerd - Upgrading Talos with the custom installer and enabling NVIDIA modules and the system extension -Both these components require that the user build and maintain their own Talos installer image and the NVIDIA container toolkit [Talos System Extension]({{< relref "system-extensions">}}). +Both these components require that the user build and maintain their own Talos installer image and the NVIDIA container toolkit [Talos System Extension]({{< relref "system-extensions" >}}). ## Prerequisites diff --git a/website/content/v1.1/guides/configuring-pull-through-cache.md b/website/content/v1.1/talos-guides/configuration/pull-through-cache.md similarity index 87% rename from website/content/v1.1/guides/configuring-pull-through-cache.md rename to website/content/v1.1/talos-guides/configuration/pull-through-cache.md index 3b2e05fbc..2b4066c89 100644 --- a/website/content/v1.1/guides/configuring-pull-through-cache.md +++ b/website/content/v1.1/talos-guides/configuration/pull-through-cache.md @@ -1,5 +1,8 @@ --- -title: Configuring Pull Through Cache +title: Pull Through Image Cache +description: "How to set up local transparent container images caches." +aliases: + - ../../guides/configuring-pull-through-cache --- In this guide we will create a set of local caching Docker registry proxies to minimize local cluster startup time. @@ -20,7 +23,7 @@ To see a live demo of this writeup, see the video below: The follow are requirements for creating the set of caching proxies: - Docker 18.03 or greater -- Local cluster requirements for either [docker](../../local-platforms/docker/) or [QEMU](../../local-platforms/qemu/). +- Local cluster requirements for either [docker]({{< relref "../install/local-platforms/docker" >}}) or [QEMU]({{< relref "../install/local-platforms/qemu" >}}). ## Launch the Caching Docker Registry Proxies @@ -62,7 +65,7 @@ host port (5000, 5001, 5002, 5003 and 5004). ## Using Caching Registries with `QEMU` Local Cluster -With a [QEMU](../../local-platforms/qemu/) local cluster, a bridge interface is created on the host. +With a [QEMU]({{< relref "../install/local-platforms/qemu" >}}) local cluster, a bridge interface is created on the host. As registry containers expose their ports on the host, we can use bridge IP to direct proxy requests. ```bash @@ -82,7 +85,7 @@ The first time cluster boots, images are pulled and cached, so next cluster boot ## Using Caching Registries with `docker` Local Cluster -With a [docker](../../local-platforms/docker/) local cluster we can use docker bridge IP, default value for that IP is `172.17.0.1`. +With a [docker]({{< relref "../install/local-platforms/docker" >}}) local cluster we can use docker bridge IP, default value for that IP is `172.17.0.1`. On Linux, the docker bridge address can be inspected with `ip addr show docker0`. ```bash diff --git a/website/content/v1.1/guides/rbac.md b/website/content/v1.1/talos-guides/configuration/rbac.md similarity index 82% rename from website/content/v1.1/guides/rbac.md rename to website/content/v1.1/talos-guides/configuration/rbac.md index 2376ec7d2..99c193cf3 100644 --- a/website/content/v1.1/guides/rbac.md +++ b/website/content/v1.1/talos-guides/configuration/rbac.md @@ -1,5 +1,8 @@ --- -title: Role-based access control (RBAC) +title: "Role-based access control (RBAC)" +description: "Set up RBAC on the Talos Linux API." +aliases: + - ../../guides/rbac --- Talos v0.11 introduced initial support for role-based access control (RBAC). @@ -9,11 +12,11 @@ This guide will explain what that is and how to enable it without losing access Talos uses certificates to authorize users. The certificate subject's organization field is used to encode user roles. -There is a set of predefined roles that allow access to different [API methods](../../reference/api/): +There is a set of predefined roles that allow access to different [API methods]({{< relref "../../reference/api" >}}): * `os:admin` grants access to all methods; * `os:reader` grants access to "safe" methods (for example, that includes the ability to list files, but does not include the ability to read files content); -* `os:etcd:backup` grants access to [`/machine.MachineService/EtcdSnapshot`](../../reference/api/#machine.EtcdSnapshotRequest) method. +* `os:etcd:backup` grants access to [`/machine.MachineService/EtcdSnapshot`]({{< relref "../../reference/api#machine.EtcdSnapshotRequest" >}}) method. Roles in the current `talosconfig` can be checked with the following command: @@ -29,7 +32,7 @@ RBAC is enabled by default in new clusters created with `talosctl` v0.11+ and di ## Enabling RBAC -First, both the Talos cluster and `talosctl` tool should be [upgraded](../upgrading-talos/). +First, both the Talos cluster and `talosctl` tool should be [upgraded]({{< relref "../upgrading-talos" >}}). Then the `talosctl config new` command should be used to generate a new client configuration with the `os:admin` role. Additional configurations and certificates for different roles can be generated by passing `--roles` flag: diff --git a/website/content/v1.1/guides/system-extensions.md b/website/content/v1.1/talos-guides/configuration/system-extensions.md similarity index 96% rename from website/content/v1.1/guides/system-extensions.md rename to website/content/v1.1/talos-guides/configuration/system-extensions.md index e19cdffcc..c924803bb 100644 --- a/website/content/v1.1/guides/system-extensions.md +++ b/website/content/v1.1/talos-guides/configuration/system-extensions.md @@ -1,5 +1,8 @@ --- title: "System Extensions" +description: "Customizing the Talos Linux immutable root file system." +aliases: + - ../../guides/system-extensions --- System extensions allow extending the Talos root filesystem, which enables a variety of features, such as including custom diff --git a/website/content/v1.1/talos-guides/install/_index.md b/website/content/v1.1/talos-guides/install/_index.md new file mode 100644 index 000000000..263e121d3 --- /dev/null +++ b/website/content/v1.1/talos-guides/install/_index.md @@ -0,0 +1,5 @@ +--- +title: "Installation" +weight: 10 +description: "How to install Talos Linux on various platforms" +--- diff --git a/website/content/v1.1/talos-guides/install/bare-metal-platforms/_index.md b/website/content/v1.1/talos-guides/install/bare-metal-platforms/_index.md new file mode 100644 index 000000000..1c8527cef --- /dev/null +++ b/website/content/v1.1/talos-guides/install/bare-metal-platforms/_index.md @@ -0,0 +1,5 @@ +--- +title: "Bare Metal Platforms" +weight: 20 +description: "Installation of Talos Linux on various bare-metal platforms." +--- diff --git a/website/content/v1.1/bare-metal-platforms/digital-rebar.md b/website/content/v1.1/talos-guides/install/bare-metal-platforms/digital-rebar.md similarity index 93% rename from website/content/v1.1/bare-metal-platforms/digital-rebar.md rename to website/content/v1.1/talos-guides/install/bare-metal-platforms/digital-rebar.md index e8dac16c9..7414864d9 100644 --- a/website/content/v1.1/bare-metal-platforms/digital-rebar.md +++ b/website/content/v1.1/talos-guides/install/bare-metal-platforms/digital-rebar.md @@ -1,14 +1,16 @@ --- title: "Digital Rebar" description: "In this guide we will create an Kubernetes cluster with 1 worker node, and 2 controlplane nodes using an existing digital rebar deployment." +aliases: + - ../../../bare-metal-platforms/digital-rebar --- ## Prerequisites -- 3 nodes (please see [hardware requirements]({{< relref "../introduction/system-requirements/">}})) +- 3 nodes (please see [hardware requirements]({{< relref "../../../introduction/system-requirements/" >}})) - Loadbalancer - Digital Rebar Server -- Talosctl access (see [talosctl setup]({{< relref "../introduction/getting-started/#talosctl">}})) +- Talosctl access (see [talosctl setup]({{< relref "../../../introduction/getting-started/#talosctl" >}})) ## Creating a Cluster @@ -144,7 +146,7 @@ Once selected, you need to assign to following: This will provision the Stage and Bootenv with the talos values. Once this is done, you can boot the machine. -To understand the boot process, we have a higher level overview located at [metal overview](../../reference/platform/). +To understand the boot process, we have a higher level overview located at [metal overview]({{< relref "../../../reference/platform" >}}). ### Bootstrap Etcd diff --git a/website/content/v1.0/bare-metal-platforms/equinix-metal.md b/website/content/v1.1/talos-guides/install/bare-metal-platforms/equinix-metal.md similarity index 98% rename from website/content/v1.0/bare-metal-platforms/equinix-metal.md rename to website/content/v1.1/talos-guides/install/bare-metal-platforms/equinix-metal.md index 0d6603eb9..cd6f3a33a 100644 --- a/website/content/v1.0/bare-metal-platforms/equinix-metal.md +++ b/website/content/v1.1/talos-guides/install/bare-metal-platforms/equinix-metal.md @@ -1,6 +1,8 @@ --- title: "Equinix Metal" description: "Creating Talos cluster using Equinix Metal." +aliases: + - ../../../bare-metal-platforms/equinix-metal --- ## Prerequisites diff --git a/website/content/v1.0/bare-metal-platforms/matchbox.md b/website/content/v1.1/talos-guides/install/bare-metal-platforms/matchbox.md similarity index 98% rename from website/content/v1.0/bare-metal-platforms/matchbox.md rename to website/content/v1.1/talos-guides/install/bare-metal-platforms/matchbox.md index 5cd55bd24..97bb8f3a9 100644 --- a/website/content/v1.0/bare-metal-platforms/matchbox.md +++ b/website/content/v1.1/talos-guides/install/bare-metal-platforms/matchbox.md @@ -1,6 +1,8 @@ --- title: "Matchbox" description: "In this guide we will create an HA Kubernetes cluster with 3 worker nodes using an existing load balancer and matchbox deployment." +aliases: + - ../../../bare-metal-platforms/matchbox --- ## Creating a Cluster diff --git a/website/content/v1.1/bare-metal-platforms/sidero.md b/website/content/v1.1/talos-guides/install/bare-metal-platforms/sidero.md similarity index 89% rename from website/content/v1.1/bare-metal-platforms/sidero.md rename to website/content/v1.1/talos-guides/install/bare-metal-platforms/sidero.md index 59968ea65..f3a531ed3 100644 --- a/website/content/v1.1/bare-metal-platforms/sidero.md +++ b/website/content/v1.1/talos-guides/install/bare-metal-platforms/sidero.md @@ -1,6 +1,8 @@ --- title: "Sidero" description: "Sidero is a project created by the Talos team that has native support for Talos." +aliases: + - ../../../bare-metal-platforms/sidero --- Sidero Metal is a project created by the Talos team that provides a bare metal installer for Cluster API, and that has native support for Talos Linux. diff --git a/website/content/v1.1/talos-guides/install/cloud-platforms/_index.md b/website/content/v1.1/talos-guides/install/cloud-platforms/_index.md new file mode 100644 index 000000000..e18473381 --- /dev/null +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/_index.md @@ -0,0 +1,5 @@ +--- +title: "Cloud Platforms" +weight: 40 +description: "Installation of Talos Linux on many cloud platforms." +--- diff --git a/website/content/v1.1/cloud-platforms/aws.md b/website/content/v1.1/talos-guides/install/cloud-platforms/aws.md similarity index 99% rename from website/content/v1.1/cloud-platforms/aws.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/aws.md index 75c2d0f13..ce8a2f97c 100644 --- a/website/content/v1.1/cloud-platforms/aws.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/aws.md @@ -1,6 +1,8 @@ --- title: "AWS" description: "Creating a cluster via the AWS CLI." +aliases: + - ../../../cloud-platforms/aws --- ## Official AMI Images diff --git a/website/content/v1.1/cloud-platforms/azure.md b/website/content/v1.1/talos-guides/install/cloud-platforms/azure.md similarity index 99% rename from website/content/v1.1/cloud-platforms/azure.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/azure.md index e45d59e85..d257110a6 100644 --- a/website/content/v1.1/cloud-platforms/azure.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/azure.md @@ -1,6 +1,8 @@ --- title: "Azure" description: "Creating a cluster via the CLI on Azure." +aliases: + - ../../../cloud-platforms/azure --- ## Creating a Cluster via the CLI diff --git a/website/content/v1.0/cloud-platforms/digitalocean.md b/website/content/v1.1/talos-guides/install/cloud-platforms/digitalocean.md similarity index 98% rename from website/content/v1.0/cloud-platforms/digitalocean.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/digitalocean.md index 832178e3f..4c8ab2b66 100644 --- a/website/content/v1.0/cloud-platforms/digitalocean.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/digitalocean.md @@ -1,6 +1,8 @@ --- title: "DigitalOcean" description: "Creating a cluster via the CLI on DigitalOcean." +aliases: + - ../../../cloud-platforms/digitalocean --- ## Creating a Cluster via the CLI diff --git a/website/content/v1.1/cloud-platforms/gcp.md b/website/content/v1.1/talos-guides/install/cloud-platforms/gcp.md similarity index 98% rename from website/content/v1.1/cloud-platforms/gcp.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/gcp.md index 71e6385e7..c8572b49f 100644 --- a/website/content/v1.1/cloud-platforms/gcp.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/gcp.md @@ -1,6 +1,8 @@ --- title: "GCP" description: "Creating a cluster via the CLI on Google Cloud Platform." +aliases: + - ../../../cloud-platforms/gcp --- ## Creating a Cluster via the CLI @@ -9,7 +11,7 @@ In this guide, we will create an HA Kubernetes cluster in GCP with 1 worker node We will assume an existing [Cloud Storage bucket](https://cloud.google.com/storage/docs/creating-buckets), and some familiarity with Google Cloud. If you need more information on Google Cloud specifics, please see the [official Google documentation](https://cloud.google.com/docs/). -[jq](https://stedolan.github.io/jq/) and [talosctl](../../introduction/quickstart/#talosctl) also needs to be installed +[jq](https://stedolan.github.io/jq/) and [talosctl]({{< relref "../../../introduction/quickstart#talosctl" >}}) also needs to be installed ## Manual Setup diff --git a/website/content/v1.1/cloud-platforms/gcp/config.yaml b/website/content/v1.1/talos-guides/install/cloud-platforms/gcp/config.yaml similarity index 100% rename from website/content/v1.1/cloud-platforms/gcp/config.yaml rename to website/content/v1.1/talos-guides/install/cloud-platforms/gcp/config.yaml diff --git a/website/content/v1.1/cloud-platforms/gcp/gcp-ccm.yaml b/website/content/v1.1/talos-guides/install/cloud-platforms/gcp/gcp-ccm.yaml similarity index 100% rename from website/content/v1.1/cloud-platforms/gcp/gcp-ccm.yaml rename to website/content/v1.1/talos-guides/install/cloud-platforms/gcp/gcp-ccm.yaml diff --git a/website/content/v1.1/cloud-platforms/gcp/talos-ha.jinja b/website/content/v1.1/talos-guides/install/cloud-platforms/gcp/talos-ha.jinja similarity index 100% rename from website/content/v1.1/cloud-platforms/gcp/talos-ha.jinja rename to website/content/v1.1/talos-guides/install/cloud-platforms/gcp/talos-ha.jinja diff --git a/website/content/v1.0/cloud-platforms/hetzner.md b/website/content/v1.1/talos-guides/install/cloud-platforms/hetzner.md similarity index 99% rename from website/content/v1.0/cloud-platforms/hetzner.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/hetzner.md index 25309941e..2c684348e 100644 --- a/website/content/v1.0/cloud-platforms/hetzner.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/hetzner.md @@ -1,6 +1,8 @@ --- title: "Hetzner" description: "Creating a cluster via the CLI (hcloud) on Hetzner." +aliases: + - ../../../cloud-platforms/hetzner --- ## Upload image diff --git a/website/content/v1.0/cloud-platforms/nocloud.md b/website/content/v1.1/talos-guides/install/cloud-platforms/nocloud.md similarity index 98% rename from website/content/v1.0/cloud-platforms/nocloud.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/nocloud.md index f721f852d..c78d3a9aa 100644 --- a/website/content/v1.0/cloud-platforms/nocloud.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/nocloud.md @@ -1,6 +1,8 @@ --- title: "Nocloud" description: "Creating a cluster via the CLI using qemu." +aliases: + - ../../../cloud-platforms/nocloud --- Talos supports [nocloud](https://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html) data source implementation. diff --git a/website/content/v1.0/cloud-platforms/openstack.md b/website/content/v1.1/talos-guides/install/cloud-platforms/openstack.md similarity index 99% rename from website/content/v1.0/cloud-platforms/openstack.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/openstack.md index 0faab530c..0694c15e5 100644 --- a/website/content/v1.0/cloud-platforms/openstack.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/openstack.md @@ -1,6 +1,8 @@ --- title: "Openstack" description: "Creating a cluster via the CLI on Openstack." +aliases: + - ../../../cloud-platforms/openstack --- ## Creating a Cluster via the CLI diff --git a/website/content/v1.0/cloud-platforms/oracle.md b/website/content/v1.1/talos-guides/install/cloud-platforms/oracle.md similarity index 99% rename from website/content/v1.0/cloud-platforms/oracle.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/oracle.md index e2e951fa9..f61ef2cee 100644 --- a/website/content/v1.0/cloud-platforms/oracle.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/oracle.md @@ -1,6 +1,8 @@ --- title: "Oracle" description: "Creating a cluster via the CLI (oci) on OracleCloud.com." +aliases: + - ../../../cloud-platforms/oracle --- ## Upload image diff --git a/website/content/v1.0/cloud-platforms/scaleway.md b/website/content/v1.1/talos-guides/install/cloud-platforms/scaleway.md similarity index 78% rename from website/content/v1.0/cloud-platforms/scaleway.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/scaleway.md index c80795482..4c74889a7 100644 --- a/website/content/v1.0/cloud-platforms/scaleway.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/scaleway.md @@ -1,6 +1,8 @@ --- title: "Scaleway" description: "Creating a cluster via the CLI (scw) on scaleway.com." +aliases: + - ../../../cloud-platforms/scaleway --- Talos is known to work on scaleway.com; however, it is currently undocumented. diff --git a/website/content/v1.0/cloud-platforms/upcloud.md b/website/content/v1.1/talos-guides/install/cloud-platforms/upcloud.md similarity index 78% rename from website/content/v1.0/cloud-platforms/upcloud.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/upcloud.md index 588e8c72d..6c9823262 100644 --- a/website/content/v1.0/cloud-platforms/upcloud.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/upcloud.md @@ -1,6 +1,8 @@ --- title: "UpCloud" description: "Creating a cluster via the CLI (upctl) on UpCloud.com." +aliases: + - ../../../cloud-platforms/upcloud --- Talos is known to work on UpCloud.com; however, it is currently undocumented. diff --git a/website/content/v1.0/cloud-platforms/vultr.md b/website/content/v1.1/talos-guides/install/cloud-platforms/vultr.md similarity index 79% rename from website/content/v1.0/cloud-platforms/vultr.md rename to website/content/v1.1/talos-guides/install/cloud-platforms/vultr.md index 51352d934..d404426ea 100644 --- a/website/content/v1.0/cloud-platforms/vultr.md +++ b/website/content/v1.1/talos-guides/install/cloud-platforms/vultr.md @@ -1,6 +1,8 @@ --- title: "Vultr" description: "Creating a cluster via the CLI (vultr-cli) on Vultr.com." +aliases: + - ../../../cloud-platforms/vultr --- Talos is known to work on Vultr.com; however, it is currently undocumented. diff --git a/website/content/v1.1/talos-guides/install/local-platforms/_index.md b/website/content/v1.1/talos-guides/install/local-platforms/_index.md new file mode 100644 index 000000000..f73b363d5 --- /dev/null +++ b/website/content/v1.1/talos-guides/install/local-platforms/_index.md @@ -0,0 +1,5 @@ +--- +title: "Local Platforms" +weight: 50 +description: "Installation of Talos Linux on local platforms, helpful for testing and developing." +--- diff --git a/website/content/v1.1/local-platforms/docker.md b/website/content/v1.1/talos-guides/install/local-platforms/docker.md similarity index 97% rename from website/content/v1.1/local-platforms/docker.md rename to website/content/v1.1/talos-guides/install/local-platforms/docker.md index 2116d084b..3cc3f0b91 100644 --- a/website/content/v1.1/local-platforms/docker.md +++ b/website/content/v1.1/talos-guides/install/local-platforms/docker.md @@ -1,6 +1,8 @@ --- title: Docker description: "Creating Talos Kubernetes cluster using Docker." +aliases: + - ../../../local-platforms/docker --- In this guide we will create a Kubernetes cluster in Docker, using a containerized version of Talos. diff --git a/website/content/v1.1/local-platforms/qemu.md b/website/content/v1.1/talos-guides/install/local-platforms/qemu.md similarity index 98% rename from website/content/v1.1/local-platforms/qemu.md rename to website/content/v1.1/talos-guides/install/local-platforms/qemu.md index d08a71835..0ea6a1211 100644 --- a/website/content/v1.1/local-platforms/qemu.md +++ b/website/content/v1.1/talos-guides/install/local-platforms/qemu.md @@ -1,6 +1,8 @@ --- title: QEMU description: "Creating Talos Kubernetes cluster using QEMU VMs." +aliases: + - ../../../local-platforms/qemu --- In this guide we will create a Kubernetes cluster using QEMU. @@ -91,7 +93,7 @@ Before the first cluster is created, `talosctl` will download the CNI bundle for Once the above finishes successfully, your talosconfig (`~/.talos/config`) will be configured to point to the new cluster, and `kubeconfig` will be downloaded and merged into default kubectl config location (`~/.kube/config`). -Cluster provisioning process can be optimized with [registry pull-through caches](../../guides/configuring-pull-through-cache/). +Cluster provisioning process can be optimized with [registry pull-through caches]({{< relref "../../configuration/pull-through-cache" >}}). ## Using the Cluster diff --git a/website/content/v1.0/local-platforms/virtualbox.md b/website/content/v1.1/talos-guides/install/local-platforms/virtualbox.md similarity index 99% rename from website/content/v1.0/local-platforms/virtualbox.md rename to website/content/v1.1/talos-guides/install/local-platforms/virtualbox.md index 2615055f7..15fabe4cc 100644 --- a/website/content/v1.0/local-platforms/virtualbox.md +++ b/website/content/v1.1/talos-guides/install/local-platforms/virtualbox.md @@ -1,6 +1,8 @@ --- title: VirtualBox description: "Creating Talos Kubernetes cluster using VurtualBox VMs." +aliases: + - ../../../local-platforms/virtualbox --- In this guide we will create a Kubernetes cluster using VirtualBox. diff --git a/website/content/v1.1/talos-guides/install/single-board-computers/_index.md b/website/content/v1.1/talos-guides/install/single-board-computers/_index.md new file mode 100644 index 000000000..2078f5339 --- /dev/null +++ b/website/content/v1.1/talos-guides/install/single-board-computers/_index.md @@ -0,0 +1,5 @@ +--- +title: "Single Board Computers" +weight: 55 +description: "Installation of Talos Linux on single-board computers." +--- diff --git a/website/content/v1.1/single-board-computers/bananapi_m64.md b/website/content/v1.1/talos-guides/install/single-board-computers/bananapi_m64.md similarity index 96% rename from website/content/v1.1/single-board-computers/bananapi_m64.md rename to website/content/v1.1/talos-guides/install/single-board-computers/bananapi_m64.md index 0cf01cb38..cbe64b81b 100644 --- a/website/content/v1.1/single-board-computers/bananapi_m64.md +++ b/website/content/v1.1/talos-guides/install/single-board-computers/bananapi_m64.md @@ -1,6 +1,8 @@ --- title: "Banana Pi M64" description: "Installing Talos on Banana Pi M64 SBC using raw disk image." +aliases: + - ../../../single-board-computers/bananapi_m64 --- ## Prerequisites diff --git a/website/content/v1.1/single-board-computers/jetson_nano.md b/website/content/v1.1/talos-guides/install/single-board-computers/jetson_nano.md similarity index 98% rename from website/content/v1.1/single-board-computers/jetson_nano.md rename to website/content/v1.1/talos-guides/install/single-board-computers/jetson_nano.md index 0b6bddf2c..bccf399a8 100644 --- a/website/content/v1.1/single-board-computers/jetson_nano.md +++ b/website/content/v1.1/talos-guides/install/single-board-computers/jetson_nano.md @@ -1,6 +1,8 @@ --- title: "Jetson Nano" description: "Installing Talos on Jetson Nano SBC using raw disk image." +aliases: + - ../../../single-board-computers/jetson_nano --- ## Prerequisites diff --git a/website/content/v1.0/single-board-computers/libretech_all_h3_cc_h5.md b/website/content/v1.1/talos-guides/install/single-board-computers/libretech_all_h3_cc_h5.md similarity index 95% rename from website/content/v1.0/single-board-computers/libretech_all_h3_cc_h5.md rename to website/content/v1.1/talos-guides/install/single-board-computers/libretech_all_h3_cc_h5.md index cc0fa2aa1..0d1a0afb0 100644 --- a/website/content/v1.0/single-board-computers/libretech_all_h3_cc_h5.md +++ b/website/content/v1.1/talos-guides/install/single-board-computers/libretech_all_h3_cc_h5.md @@ -1,6 +1,8 @@ --- title: "Libre Computer Board ALL-H3-CC" description: "Installing Talos on Libre Computer Board ALL-H3-CC SBC using raw disk image." +aliases: + - ../../../single-board-computers/libretech_all_h3_cc_h5 --- ## Prerequisites diff --git a/website/content/v1.1/single-board-computers/pine64.md b/website/content/v1.1/talos-guides/install/single-board-computers/pine64.md similarity index 96% rename from website/content/v1.1/single-board-computers/pine64.md rename to website/content/v1.1/talos-guides/install/single-board-computers/pine64.md index b7b836e52..8ffa51b3d 100644 --- a/website/content/v1.1/single-board-computers/pine64.md +++ b/website/content/v1.1/talos-guides/install/single-board-computers/pine64.md @@ -1,6 +1,8 @@ --- title: "Pine64" description: "Installing Talos on a Pine64 SBC using raw disk image." +aliases: + - ../../../single-board-computers/pine64 --- ## Prerequisites diff --git a/website/content/v1.0/single-board-computers/rock64.md b/website/content/v1.1/talos-guides/install/single-board-computers/rock64.md similarity index 96% rename from website/content/v1.0/single-board-computers/rock64.md rename to website/content/v1.1/talos-guides/install/single-board-computers/rock64.md index bcf697e87..6588e936a 100644 --- a/website/content/v1.0/single-board-computers/rock64.md +++ b/website/content/v1.1/talos-guides/install/single-board-computers/rock64.md @@ -1,6 +1,8 @@ --- title: "Pine64 Rock64" description: "Installing Talos on Pine64 Rock64 SBC using raw disk image." +aliases: + - ../../../single-board-computers/rock64 --- ## Prerequisites diff --git a/website/content/v1.1/single-board-computers/rockpi_4.md b/website/content/v1.1/talos-guides/install/single-board-computers/rockpi_4.md similarity index 98% rename from website/content/v1.1/single-board-computers/rockpi_4.md rename to website/content/v1.1/talos-guides/install/single-board-computers/rockpi_4.md index 36b32c903..82755a0d6 100644 --- a/website/content/v1.1/single-board-computers/rockpi_4.md +++ b/website/content/v1.1/talos-guides/install/single-board-computers/rockpi_4.md @@ -1,6 +1,8 @@ --- title: "Radxa ROCK PI 4" description: "Installing Talos on Radxa ROCK PI 4a/4b SBC using raw disk image." +aliases: + - ../../../single-board-computers/rockpi_4c --- ## Prerequisites diff --git a/website/content/v1.1/single-board-computers/rockpi_4c.md b/website/content/v1.1/talos-guides/install/single-board-computers/rockpi_4c.md similarity index 100% rename from website/content/v1.1/single-board-computers/rockpi_4c.md rename to website/content/v1.1/talos-guides/install/single-board-computers/rockpi_4c.md diff --git a/website/content/v1.1/single-board-computers/rpi_4.md b/website/content/v1.1/talos-guides/install/single-board-computers/rpi_4.md similarity index 98% rename from website/content/v1.1/single-board-computers/rpi_4.md rename to website/content/v1.1/talos-guides/install/single-board-computers/rpi_4.md index fa0335d51..6d4edb8dd 100644 --- a/website/content/v1.1/single-board-computers/rpi_4.md +++ b/website/content/v1.1/talos-guides/install/single-board-computers/rpi_4.md @@ -1,6 +1,8 @@ --- title: "Raspberry Pi 4 Model B" description: "Installing Talos on Rpi4 SBC using raw disk image." +aliases: + - ../../../single-board-computers/rpi_4 --- ## Video Walkthrough diff --git a/website/content/v1.1/talos-guides/install/virtualized-platforms/_index.md b/website/content/v1.1/talos-guides/install/virtualized-platforms/_index.md new file mode 100644 index 000000000..7da4e1a6a --- /dev/null +++ b/website/content/v1.1/talos-guides/install/virtualized-platforms/_index.md @@ -0,0 +1,5 @@ +--- +title: "Virtualized Platforms" +weight: 30 +description: "Installation of Talos Linux for virtualization platforms." +--- diff --git a/website/content/v1.1/virtualized-platforms/hyper-v.md b/website/content/v1.1/talos-guides/install/virtualized-platforms/hyper-v.md similarity index 98% rename from website/content/v1.1/virtualized-platforms/hyper-v.md rename to website/content/v1.1/talos-guides/install/virtualized-platforms/hyper-v.md index 58318701e..2d300b1c3 100644 --- a/website/content/v1.1/virtualized-platforms/hyper-v.md +++ b/website/content/v1.1/talos-guides/install/virtualized-platforms/hyper-v.md @@ -1,6 +1,8 @@ --- title: "Hyper-V" description: "Creating a Talos Kubernetes cluster using Hyper-V." +aliases: + - ../../../virtualized-platforms/hyper-v --- ## Pre-requisities diff --git a/website/content/v1.1/talos-guides/install/virtualized-platforms/kvm.md b/website/content/v1.1/talos-guides/install/virtualized-platforms/kvm.md new file mode 100644 index 000000000..e49806631 --- /dev/null +++ b/website/content/v1.1/talos-guides/install/virtualized-platforms/kvm.md @@ -0,0 +1,9 @@ +--- +title: "KVM" +aliases: + - ../../../virtualized-platforms/kvm +--- + +Talos is known to work on KVM. +We don't yet have a documented guide specific to KVM; however, you can follow the [General Getting Started Guide]({{< relref "../../../introduction/getting-started" >}}). +If you run into any issues, our [community](https://slack.dev.talos-systems.io/) can probably help! diff --git a/website/content/v1.1/virtualized-platforms/proxmox.md b/website/content/v1.1/talos-guides/install/virtualized-platforms/proxmox.md similarity index 99% rename from website/content/v1.1/virtualized-platforms/proxmox.md rename to website/content/v1.1/talos-guides/install/virtualized-platforms/proxmox.md index 3d8726951..bc3ff5d2f 100644 --- a/website/content/v1.1/virtualized-platforms/proxmox.md +++ b/website/content/v1.1/talos-guides/install/virtualized-platforms/proxmox.md @@ -1,6 +1,8 @@ --- title: Proxmox description: "Creating Talos Kubernetes cluster using Proxmox." +aliases: + - ../../../virtualized-platforms/proxmox --- In this guide we will create a Kubernetes cluster using Proxmox. diff --git a/website/content/v1.1/virtualized-platforms/vmware.md b/website/content/v1.1/talos-guides/install/virtualized-platforms/vmware.md similarity index 99% rename from website/content/v1.1/virtualized-platforms/vmware.md rename to website/content/v1.1/talos-guides/install/virtualized-platforms/vmware.md index 061f4143d..a9cb3e415 100644 --- a/website/content/v1.1/virtualized-platforms/vmware.md +++ b/website/content/v1.1/talos-guides/install/virtualized-platforms/vmware.md @@ -1,6 +1,8 @@ --- title: "VMware" description: "Creating Talos Kubernetes cluster using VMware." +aliases: + - ../../../virtualized-platforms/vmware --- ## Creating a Cluster via the `govc` CLI diff --git a/website/content/v1.1/virtualized-platforms/vmware/cp.patch b/website/content/v1.1/talos-guides/install/virtualized-platforms/vmware/cp.patch.yaml similarity index 100% rename from website/content/v1.1/virtualized-platforms/vmware/cp.patch rename to website/content/v1.1/talos-guides/install/virtualized-platforms/vmware/cp.patch.yaml diff --git a/website/content/v1.1/virtualized-platforms/vmware/vmware.sh b/website/content/v1.1/talos-guides/install/virtualized-platforms/vmware/vmware.sh similarity index 100% rename from website/content/v1.1/virtualized-platforms/vmware/vmware.sh rename to website/content/v1.1/talos-guides/install/virtualized-platforms/vmware/vmware.sh diff --git a/website/content/v1.0/virtualized-platforms/xen.md b/website/content/v1.1/talos-guides/install/virtualized-platforms/xen.md similarity index 58% rename from website/content/v1.0/virtualized-platforms/xen.md rename to website/content/v1.1/talos-guides/install/virtualized-platforms/xen.md index 503d46f68..00beea04f 100644 --- a/website/content/v1.0/virtualized-platforms/xen.md +++ b/website/content/v1.1/talos-guides/install/virtualized-platforms/xen.md @@ -1,7 +1,9 @@ --- title: "Xen" +aliases: + - ../../../virtualized-platforms/xen --- Talos is known to work on Xen. -We don't yet have a documented guide specific to Xen; however, you can follow the [General Getting Started Guide](../../introduction/getting-started). +We don't yet have a documented guide specific to Xen; however, you can follow the [General Getting Started Guide]({{< relref "../../../introduction/getting-started" >}}). If you run into any issues, our [community](https://slack.dev.talos-systems.io/) can probably help! diff --git a/website/content/v1.1/talos-guides/network/_index.md b/website/content/v1.1/talos-guides/network/_index.md new file mode 100644 index 000000000..40e8ec1b1 --- /dev/null +++ b/website/content/v1.1/talos-guides/network/_index.md @@ -0,0 +1,5 @@ +--- +title: "Network" +weight: 30 +description: "Set up networking layers for Talos Linux" +--- diff --git a/website/content/v1.0/guides/configuring-corporate-proxies.md b/website/content/v1.1/talos-guides/network/corporate-proxies.md similarity index 82% rename from website/content/v1.0/guides/configuring-corporate-proxies.md rename to website/content/v1.1/talos-guides/network/corporate-proxies.md index 8cc13ba45..0877d248d 100644 --- a/website/content/v1.0/guides/configuring-corporate-proxies.md +++ b/website/content/v1.1/talos-guides/network/corporate-proxies.md @@ -1,6 +1,8 @@ --- -title: "Configuring Corporate Proxies" -description: "" +title: "Corporate Proxies" +description: "How to configure Talos Linux to use proxies in a corporate environment" +aliases: + - ../../guides/configuring-corporate-proxies --- ## Appending the Certificate Authority of MITM Proxies diff --git a/website/content/v1.1/guides/vip.md b/website/content/v1.1/talos-guides/network/vip.md similarity index 95% rename from website/content/v1.1/guides/vip.md rename to website/content/v1.1/talos-guides/network/vip.md index 3ae5ce5dd..183960370 100644 --- a/website/content/v1.1/guides/vip.md +++ b/website/content/v1.1/talos-guides/network/vip.md @@ -1,5 +1,8 @@ --- -title: Virtual (shared) IP +title: "Virtual (shared) IP" +description: "Using Talos Linux to set up a floating virtual IP address for cluster access." +aliases: + - ../../guides/vip --- One of the biggest pain points when building a high-availability controlplane diff --git a/website/content/v1.1/guides/configuring-wireguard-network.md b/website/content/v1.1/talos-guides/network/wireguard-network.md similarity index 91% rename from website/content/v1.1/guides/configuring-wireguard-network.md rename to website/content/v1.1/talos-guides/network/wireguard-network.md index 6102d3966..c8ffafd19 100644 --- a/website/content/v1.1/guides/configuring-wireguard-network.md +++ b/website/content/v1.1/talos-guides/network/wireguard-network.md @@ -1,6 +1,8 @@ --- -title: "Configuring Wireguard Network" -description: "In this guide you will learn how to set up Wireguard network using Kernel module." +title: "Wireguard Network" +description: "A guide on how to set up Wireguard network using Kernel module." +aliases: + - ../../../guides/configuring-wireguard-network --- ## Configuring Wireguard Network @@ -99,4 +101,4 @@ network: When `networkd` gets this configuration it will create the device, configure it and will bring it up (equivalent to `ip link set up dev wg0`). -All supported config parameters are described in the [Machine Config Reference](../../reference/configuration/#devicewireguardconfig). +All supported config parameters are described in the [Machine Config Reference]({{< relref "../../reference/configuration#devicewireguardconfig" >}}). diff --git a/website/content/v1.0/guides/resetting-a-machine.md b/website/content/v1.1/talos-guides/resetting-a-machine.md similarity index 94% rename from website/content/v1.0/guides/resetting-a-machine.md rename to website/content/v1.1/talos-guides/resetting-a-machine.md index fb8a780e7..f3514ce33 100644 --- a/website/content/v1.0/guides/resetting-a-machine.md +++ b/website/content/v1.1/talos-guides/resetting-a-machine.md @@ -1,6 +1,8 @@ --- title: "Resetting a Machine" -description: "" +description: "Steps on how to reset a Talos Linux machine to a clean state." +aliases: + - ../guides/resetting-a-machine --- From time to time, it may be beneficial to reset a Talos machine to its "original" state. diff --git a/website/content/v1.1/guides/upgrading-talos.md b/website/content/v1.1/talos-guides/upgrading-talos.md similarity index 98% rename from website/content/v1.1/guides/upgrading-talos.md rename to website/content/v1.1/talos-guides/upgrading-talos.md index 15a1a8a14..95bfec5bc 100644 --- a/website/content/v1.1/guides/upgrading-talos.md +++ b/website/content/v1.1/talos-guides/upgrading-talos.md @@ -1,5 +1,8 @@ --- -title: Upgrading Talos Linux +title: "Upgrading Talos Linux" +description: "Guide on upgrading a Talos Linux machine." +aliases: + - ../guides/upgrading-talos --- OS upgrades, like other operations on Talos Linux, are effected by an API call, which can be sent via the `talosctl` CLI utility. diff --git a/website/content/v1.1/virtualized-platforms/_index.md b/website/content/v1.1/virtualized-platforms/_index.md deleted file mode 100644 index 66f845511..000000000 --- a/website/content/v1.1/virtualized-platforms/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Virtualized Platforms" -weight: 30 ---- diff --git a/website/content/v1.1/virtualized-platforms/kvm.md b/website/content/v1.1/virtualized-platforms/kvm.md deleted file mode 100644 index a21999956..000000000 --- a/website/content/v1.1/virtualized-platforms/kvm.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "KVM" ---- - -Talos is known to work on KVM. -We don't yet have a documented guide specific to Xen; however, you can follow the [General Getting Started Guide](../../introduction/getting-started). -If you run into any issues, our [community](https://slack.dev.talos-systems.io/) can probably help! diff --git a/website/layouts/index.netlify_redirect b/website/layouts/index.netlify_redirect index 662fa5cab..d63d53c0e 100644 --- a/website/layouts/index.netlify_redirect +++ b/website/layouts/index.netlify_redirect @@ -3,3 +3,10 @@ /docs/* /:splat 302 /latest {{ .Site.Params.url_latest_version }} 302 /latest/* {{ .Site.Params.url_latest_version }}/:splat 302 + +# Use netlify to redirect alias pages +{{- range $p := .Site.Pages }} +{{- range .Aliases }} +{{ printf "%s %s %d" (cond (hasPrefix . "/") . (path.Join $p.RelPermalink .)) $p.RelPermalink ($p.Params.HTTPCode | default 301) }} +{{- end }} +{{- end }}