mirror of
https://github.com/siderolabs/talos.git
synced 2025-12-16 06:51:27 +01:00
docs: reorganize documentation
Make improvements to help documentation discoverability and categorization. Ensure all content pages have a description. Ensure all link are replaced with Hugo shortcode. Ensure all moved pages have an alias so redirects work. Signed-off-by: Tim Jones <tim.jones@siderolabs.com>
This commit is contained in:
Tim Jones
parent
a91eb9358d
commit
fa57b5d922
@ -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
|
||||
|
||||
|
||||
4
website/content/v1.0/advanced/_index.md
Normal file
4
website/content/v1.0/advanced/_index.md
Normal file
@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Advanced Guides"
|
||||
weight: 60
|
||||
---
|
||||
@ -1,5 +1,8 @@
|
||||
---
|
||||
title: "Advanced Networking"
|
||||
description: "How to configure advanced networking options on Talos Linux."
|
||||
aliases:
|
||||
- ../guides/advanced-networking
|
||||
---
|
||||
|
||||
## Static Addressing
|
||||
@ -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
|
||||
|
||||
@ -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:
|
||||
@ -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:
|
||||
@ -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.
|
||||
@ -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
|
||||
@ -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:
|
||||
@ -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
|
||||
@ -1,5 +1,8 @@
|
||||
---
|
||||
title: "Static Pods"
|
||||
description: "Using Talos Linux to set up static pods in Kubernetes."
|
||||
aliases:
|
||||
- ../guides/static-pods
|
||||
---
|
||||
|
||||
## Static Pods
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Troubleshooting Control Plane"
|
||||
description: "Troubleshoot control plane failures for running cluster and bootstrap process."
|
||||
aliases:
|
||||
- ../guides/troubleshooting-control-plane
|
||||
---
|
||||
|
||||
<!-- markdownlint-disable MD026 -->
|
||||
@ -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
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
title: "Bare Metal Platforms"
|
||||
weight: 20
|
||||
---
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
title: "Cloud Platforms"
|
||||
weight: 40
|
||||
---
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
title: "Guides"
|
||||
weight: 60
|
||||
---
|
||||
@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Introduction"
|
||||
weight: 1
|
||||
weight: 10
|
||||
---
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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 |
|
||||
| - 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 |
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
title: System Requirements
|
||||
weight: 4
|
||||
weight: 40
|
||||
description: "Hardware requirements for running Talos Linux."
|
||||
---
|
||||
|
||||
## Minimum Requirements
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
5
website/content/v1.0/kubernetes-guides/_index.md
Normal file
5
website/content/v1.0/kubernetes-guides/_index.md
Normal file
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Kubernetes Guides"
|
||||
weight: 30
|
||||
description: "Management of a Kubernetes Cluster hosted by Talos Linux"
|
||||
---
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Configuration"
|
||||
weight: 10
|
||||
description: "How to configure components of the Kubernetes cluster itself."
|
||||
---
|
||||
@ -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
|
||||
@ -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
|
||||
.....
|
||||
@ -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).
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
@ -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.
|
||||
5
website/content/v1.0/kubernetes-guides/network/_index.md
Normal file
5
website/content/v1.0/kubernetes-guides/network/_index.md
Normal file
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Network"
|
||||
weight: 20
|
||||
description: "Managing the Kubernetes cluster networking"
|
||||
---
|
||||
@ -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.
|
||||
@ -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.
|
||||
@ -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
|
||||
|
||||
@ -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_.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "Controllers and Resources"
|
||||
weight: 90
|
||||
weight: 60
|
||||
description: "Discover how Talos Linux uses the concepts on Controllers and Resources."
|
||||
---
|
||||
|
||||
<!-- markdownlint-disable MD038 -->
|
||||
|
||||
@ -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).
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "FAQs"
|
||||
weight: 60
|
||||
weight: 999
|
||||
description: "Frequently Asked Questions about Talos Linux."
|
||||
---
|
||||
|
||||
<!-- markdownlint-disable MD026 -->
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Philosophy
|
||||
weight: 10
|
||||
description: "Learn about the philosophy behind the need for Talos Linux."
|
||||
---
|
||||
|
||||
## Distributed
|
||||
|
||||
@ -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
|
||||
@ -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`.
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
title: "Local Platforms"
|
||||
weight: 50
|
||||
---
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: API
|
||||
description: Talos gRPC API reference.
|
||||
title: "API"
|
||||
description: "Talos gRPC API reference."
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: CLI
|
||||
desription: Talosctl CLI tool reference.
|
||||
title: "CLI"
|
||||
description: "Talosctl CLI tool reference."
|
||||
---
|
||||
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuration
|
||||
desription: Talos node configuration file reference.
|
||||
title: "Configuration"
|
||||
description: "Talos node configuration file reference."
|
||||
---
|
||||
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Kernel
|
||||
desription: Linux kernel reference.
|
||||
title: "Kernel"
|
||||
description: "Linux kernel reference."
|
||||
---
|
||||
|
||||
## Commandline Parameters
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Platform
|
||||
title: "Platform"
|
||||
description: "Visualization of the bootstrap process on bare metal machines."
|
||||
---
|
||||
|
||||
### Metal
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
title: "Single Board Computers"
|
||||
weight: 55
|
||||
---
|
||||
5
website/content/v1.0/talos-guides/_index.md
Normal file
5
website/content/v1.0/talos-guides/_index.md
Normal file
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Talos Linux Guides
|
||||
weight: 20
|
||||
description: "Documentation on how to manage Talos Linux"
|
||||
---
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Configuration"
|
||||
weight: 20
|
||||
description: "Guides on how to configure Talos Linux machines"
|
||||
---
|
||||
@ -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
|
||||
@ -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`.
|
||||
@ -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.
|
||||
@ -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.
|
||||
@ -1,5 +1,8 @@
|
||||
---
|
||||
title: Logging
|
||||
title: "Logging"
|
||||
description: "Dealing with Talos Linux logs."
|
||||
aliases:
|
||||
- ../../guiides/logging
|
||||
---
|
||||
|
||||
## Viewing logs
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Managing PKI"
|
||||
description: ""
|
||||
description: "How to manage Public Key Infrastructure"
|
||||
aliases:
|
||||
- ../../guides/managing-pki
|
||||
---
|
||||
|
||||
## Generating an Administrator Key Pair
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
@ -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:
|
||||
|
||||
@ -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
|
||||
5
website/content/v1.0/talos-guides/install/_index.md
Normal file
5
website/content/v1.0/talos-guides/install/_index.md
Normal file
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Installation"
|
||||
weight: 10
|
||||
description: "How to install Talos Linux on various platforms"
|
||||
---
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Bare Metal Platforms"
|
||||
weight: 20
|
||||
description: "Installation of Talos Linux on various bare-metal platforms."
|
||||
---
|
||||
@ -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
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Equinix Metal"
|
||||
description: "Creating Talos cluster using Equinix Metal."
|
||||
aliases:
|
||||
- ../../../bare-metal-platforms/equinix-metal
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
@ -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
|
||||
@ -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.
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Cloud Platforms"
|
||||
weight: 40
|
||||
description: "Installation of Talos Linux on many cloud platforms."
|
||||
---
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "AWS"
|
||||
description: "Creating a cluster via the AWS CLI."
|
||||
aliases:
|
||||
- ../../../cloud-platforms/aws
|
||||
---
|
||||
|
||||
## Official AMI Images
|
||||
@ -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
|
||||
@ -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
|
||||
@ -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
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Hetzner"
|
||||
description: "Creating a cluster via the CLI (hcloud) on Hetzner."
|
||||
aliases:
|
||||
- ../../../cloud-platforms/hetzner
|
||||
---
|
||||
|
||||
## Upload image
|
||||
@ -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.
|
||||
@ -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
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Oracle"
|
||||
description: "Creating a cluster via the CLI (oci) on OracleCloud.com."
|
||||
aliases:
|
||||
- ../../../cloud-platforms/oracle
|
||||
---
|
||||
|
||||
## Upload image
|
||||
@ -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.
|
||||
@ -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.
|
||||
@ -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.
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Local Platforms"
|
||||
weight: 50
|
||||
description: "Installation of Talos Linux on local platforms, helpful for testing and developing."
|
||||
---
|
||||
@ -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.
|
||||
@ -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
|
||||
|
||||
@ -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.
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Single Board Computers"
|
||||
weight: 55
|
||||
description: "Installation of Talos Linux on single-board computers."
|
||||
---
|
||||
@ -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
|
||||
@ -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
|
||||
@ -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
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Pine64"
|
||||
description: "Installing Talos on a Pine64 SBC using raw disk image."
|
||||
aliases:
|
||||
- ../../../single-board-computers/pine64
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Pine64 Rock64"
|
||||
description: "Installing Talos on Pine64 Rock64 SBC using raw disk image."
|
||||
aliases:
|
||||
- ../../../single-board-computers/rock64
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
@ -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.
|
||||
@ -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
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Virtualized Platforms"
|
||||
weight: 30
|
||||
description: "Installation of Talos Linux for virtualization platforms."
|
||||
---
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Hyper-V"
|
||||
description: "Creating a Talos Kubernetes cluster using Hyper-V."
|
||||
aliases:
|
||||
- ../../../virtualized-platforms/hyper-v
|
||||
---
|
||||
|
||||
## Pre-requisities
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user