docs: add live walkthroughs where applicable

This PR adds embedded youtube videos in places where we have done
walkthroughs of this functionality.

Signed-off-by: Spencer Smith <robertspencersmith@gmail.com>
This commit is contained in:
Spencer Smith 2020-11-10 14:54:36 -05:00 committed by Spencer Smith
parent bf1e81b1f4
commit 762feabe05
7 changed files with 48 additions and 4 deletions

View File

@ -9,6 +9,12 @@ We spin up local caching pass-through registries to cache images and configure a
A similar approach might be used to run Talos in production in air-gapped environments. A similar approach might be used to run Talos in production in air-gapped environments.
It can be also used to verify that all the images are available in local registries. It can be also used to verify that all the images are available in local registries.
## Video Walkthrough
To see a live demo of this writeup, see the video below:
<iframe width="560" height="315" src="https://www.youtube.com/embed/PRiQJR9Q33s" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Requirements ## Requirements
The follow are requirements for creating the set of caching proxies: The follow are requirements for creating the set of caching proxies:

View File

@ -2,13 +2,21 @@
title: Upgrading Kubernetes title: Upgrading Kubernetes
--- ---
## Kubernetes ## Video Walkthrough
To see a live demo of this writeup, see the video below:
<iframe width="560" height="315" src="https://www.youtube.com/embed/sw78qS8vBGc" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Kubelet Image
In Kubernetes 1.19, the official `hyperkube` image was removed. In Kubernetes 1.19, the official `hyperkube` image was removed.
This means that in order to upgrade Kubernetes, Talos users will have to change the `command`, and `image` fields of each control plane component. This means that in order to upgrade Kubernetes, Talos users will have to change the `command`, and `image` fields of each control plane component.
The `kubelet` image will also have to be updated, if you wish to specify the `kubelet` image explicitly. The `kubelet` image will also have to be updated, if you wish to specify the `kubelet` image explicitly.
The default used by Talos is sufficient in most cases. The default used by Talos is sufficient in most cases.
## Kubeconfig
In order to edit the control plane, we will need a working `kubectl` config. In order to edit the control plane, we will need a working `kubectl` config.
If you don't already have one, you can get one by running: If you don't already have one, you can get one by running:

View File

@ -2,6 +2,12 @@
title: Upgrading Talos title: Upgrading Talos
--- ---
## Video Walkthrough
To see a live demo of this writeup, see the video below:
<iframe width="560" height="315" src="https://www.youtube.com/embed/sw78qS8vBGc" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Talos ## Talos
In an effort to create more production ready clusters, Talos will now taint control plane nodes as unschedulable. In an effort to create more production ready clusters, Talos will now taint control plane nodes as unschedulable.

View File

@ -9,6 +9,12 @@ We spin up local caching pass-through registries to cache images and configure a
A similar approach might be used to run Talos in production in air-gapped environments. A similar approach might be used to run Talos in production in air-gapped environments.
It can be also used to verify that all the images are available in local registries. It can be also used to verify that all the images are available in local registries.
## Video Walkthrough
To see a live demo of this writeup, see the video below:
<iframe width="560" height="315" src="https://www.youtube.com/embed/PRiQJR9Q33s" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Requirements ## Requirements
The follow are requirements for creating the set of caching proxies: The follow are requirements for creating the set of caching proxies:

View File

@ -2,7 +2,13 @@
title: Upgrading Kubernetes title: Upgrading Kubernetes
--- ---
## Kubernetes ## Video Walkthrough
To see a live demo of this writeup, see the video below:
<iframe width="560" height="315" src="https://www.youtube.com/embed/sw78qS8vBGc" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Kubeconfig
In order to edit the control plane, we will need a working `kubectl` config. In order to edit the control plane, we will need a working `kubectl` config.
If you don't already have one, you can get one by running: If you don't already have one, you can get one by running:

View File

@ -5,7 +5,13 @@ title: Upgrading Talos
Talos upgrades are effected by an API call. Talos upgrades are effected by an API call.
The `talosctl` CLI utility will facilitate this, or you can use the automatic upgrade features provided by the [talos controller manager](https://github.com/talos-systems/talos-controller-manager). The `talosctl` CLI utility will facilitate this, or you can use the automatic upgrade features provided by the [talos controller manager](https://github.com/talos-systems/talos-controller-manager).
## talosctl upgrade ## Video Walkthrough
To see a live demo of this writeup, see the video below:
<iframe width="560" height="315" src="https://www.youtube.com/embed/sw78qS8vBGc" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## `talosctl` Upgrade
To manually upgrade a Talos node, you will specify the node's IP address and the To manually upgrade a Talos node, you will specify the node's IP address and the
installer container image for the version of Talos to which you wish to upgrade. installer container image for the version of Talos to which you wish to upgrade.
@ -23,7 +29,7 @@ There is an option to this command: `--preserve`, which can be used to explicitl
In most cases, it is correct to just let Talos perform its default action. In most cases, it is correct to just let Talos perform its default action.
However, if you are running a single-node control-plane, you will want to make sure that `--preserve=true`. However, if you are running a single-node control-plane, you will want to make sure that `--preserve=true`.
## Talos controller manager ## Talos Controller Manager
The Talos Controller Manager can coordinate upgrades of your nodes The Talos Controller Manager can coordinate upgrades of your nodes
automatically. automatically.

View File

@ -7,6 +7,12 @@ The `talosctl` tool packs a lot of power into a small package.
It acts as a reference implementation for the Talos API, but it also handles a lot of It acts as a reference implementation for the Talos API, but it also handles a lot of
conveniences for the use of Talos and its clusters. conveniences for the use of Talos and its clusters.
### Video Walkthrough
To see some live examples of talosctl usage, view the following video:
<iframe width="560" height="315" src="https://www.youtube.com/embed/pl0l_K_3Y6o" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Client Configuration ## Client Configuration
Talosctl configuration is located in `$XDG_CONFIG_HOME/talos/config.yaml` if `$XDG_CONFIG_HOME` is defined. Talosctl configuration is located in `$XDG_CONFIG_HOME/talos/config.yaml` if `$XDG_CONFIG_HOME` is defined.