From 63f4f0217dcd26a4ed2f2a00dddb2411797417dc Mon Sep 17 00:00:00 2001 From: Kjeld Schouten Date: Fri, 25 Oct 2024 22:30:35 +0200 Subject: [PATCH] chore(clustertool): update lots of docs --- clustertool/cmd/apply.go | 27 ++++++++++++ clustertool/cmd/checkcrypt.go | 3 ++ clustertool/cmd/decrypt.go | 2 + clustertool/cmd/encrypt.go | 2 + clustertool/cmd/genconfig.go | 8 ++-- clustertool/cmd/init.go | 6 +-- clustertool/cmd/upgrade.go | 4 ++ .../docs/clustertool/commands/apply.md | 30 +++++++++++++ .../docs/clustertool/commands/checkcrypt.md | 6 +++ .../docs/clustertool/commands/decrypt.md | 5 +++ .../docs/clustertool/commands/encrypt.md | 5 +++ .../docs/clustertool/commands/genconfig.md | 7 ++-- .../content/docs/clustertool/commands/init.md | 4 +- .../docs/clustertool/commands/upgrade.md | 7 ++++ .../{functions/init.md => files-folders.md} | 11 +---- .../clustertool/functions/adv/bootstrap.md | 5 --- .../docs/clustertool/functions/adv/health.md | 5 --- .../docs/clustertool/functions/adv/index.md | 5 --- .../docs/clustertool/functions/adv/reset.md | 5 --- .../docs/clustertool/functions/apply.md | 42 ------------------- .../clustertool/functions/charts/index.md | 7 ---- .../docs/clustertool/functions/checkcrypt.md | 17 -------- .../docs/clustertool/functions/decrypt.md | 16 ------- .../docs/clustertool/functions/encrypt.md | 16 ------- .../docs/clustertool/functions/genconfig.md | 20 --------- .../functions/helmrelease/index.md | 5 --- .../functions/helmrelease/install.md | 4 -- .../functions/helmrelease/upgrade.md | 4 -- .../functions/scale/scaleexport.md | 5 --- .../functions/scale/scalemigrate.md | 5 --- .../docs/clustertool/functions/upgrade.md | 18 -------- 31 files changed, 105 insertions(+), 201 deletions(-) rename website/src/content/docs/clustertool/{functions/init.md => files-folders.md} (73%) delete mode 100644 website/src/content/docs/clustertool/functions/adv/bootstrap.md delete mode 100644 website/src/content/docs/clustertool/functions/adv/health.md delete mode 100644 website/src/content/docs/clustertool/functions/adv/index.md delete mode 100644 website/src/content/docs/clustertool/functions/adv/reset.md delete mode 100644 website/src/content/docs/clustertool/functions/apply.md delete mode 100644 website/src/content/docs/clustertool/functions/charts/index.md delete mode 100644 website/src/content/docs/clustertool/functions/checkcrypt.md delete mode 100644 website/src/content/docs/clustertool/functions/decrypt.md delete mode 100644 website/src/content/docs/clustertool/functions/encrypt.md delete mode 100644 website/src/content/docs/clustertool/functions/genconfig.md delete mode 100644 website/src/content/docs/clustertool/functions/helmrelease/index.md delete mode 100644 website/src/content/docs/clustertool/functions/helmrelease/install.md delete mode 100644 website/src/content/docs/clustertool/functions/helmrelease/upgrade.md delete mode 100644 website/src/content/docs/clustertool/functions/scale/scaleexport.md delete mode 100644 website/src/content/docs/clustertool/functions/scale/scalemigrate.md delete mode 100644 website/src/content/docs/clustertool/functions/upgrade.md diff --git a/clustertool/cmd/apply.go b/clustertool/cmd/apply.go index 26e36669a74..30c8bf3f09b 100644 --- a/clustertool/cmd/apply.go +++ b/clustertool/cmd/apply.go @@ -12,6 +12,33 @@ import ( ) var applyLongHelp = strings.TrimSpace(` +The "apply" command applies your Talos System configuration to each node in the cluster, existing or new It also runs automated checking of your config file and health checks between each node it has processed, to ensure you don't accidentally take down your whole cluster. + +## Bootstrapping +If the cluster has not been bootstrapped yet, Apply will automatically detect this and ask if you want to bootstrap the cluster + +Bootstrapping will apply your config to the first (top) controlplane node in your "talconfig.yaml", it then "bootstraps" hence creating a new cluster with said node. + +After this is done, we apply a number of helm-charts and manifests by default such as: + +- Metallb +- Metallb-Config +- Cilium (CNI) +- Certificate-Approver +- Spegel +- Kubernetes-Dashboard + +### Bootstrapping FluxCD + +During Bootstrapping, if a "GITHUB_REPOSITORY" is set in "clusterenv.yaml", you will be asked if you also want to bootstrap FluxCD, checkout the getting-started guide for more info + +## About Bootstrapping + +While we load a lot of helm-charts during bootstrap, we will *never* manage them for you. +You're responsible for maintaining and configuring your cluster after bootstrapping. + +Apply and *all other* commands, are just for maintaining Talos itself. +Not any contained helm-charts `) diff --git a/clustertool/cmd/checkcrypt.go b/clustertool/cmd/checkcrypt.go index 127e432d854..2ed34dd6952 100644 --- a/clustertool/cmd/checkcrypt.go +++ b/clustertool/cmd/checkcrypt.go @@ -10,6 +10,9 @@ import ( ) var checkcyptLongHelp = strings.TrimSpace(` +It's imperative that you always ensure the config you send to the internet is thoroughly encrypted. Using "clustertool checkcrypt" you can easily check if all files that are due to being encrypted, as specified in ".sops.yaml", will actually be encrypted. + +This tool can, for example, be used as a pre-commit check and will fail with a non-zero exit code if unencrypted files are detected that should've been encrypted in accordance with ".sops.yaml" configuration. `) diff --git a/clustertool/cmd/decrypt.go b/clustertool/cmd/decrypt.go index bacfe170e9b..278c25a69d2 100644 --- a/clustertool/cmd/decrypt.go +++ b/clustertool/cmd/decrypt.go @@ -9,6 +9,8 @@ import ( ) var decryptLongHelp = strings.TrimSpace(` +The decryption feature of ClusterTool goes over all config files and, if encrypted, checks if ".sops.yaml" specifies that they should be decrypted. +If so, they are decrypted using your "age.agekey" file as specified in ".sops.yaml". `) diff --git a/clustertool/cmd/encrypt.go b/clustertool/cmd/encrypt.go index 851cbe7de5b..530222ee6d3 100644 --- a/clustertool/cmd/encrypt.go +++ b/clustertool/cmd/encrypt.go @@ -9,6 +9,8 @@ import ( ) var encryptLongHelp = strings.TrimSpace(` +The encryption feature of ClusterTool goes over all config files and, if not encrypted already, checks if ".sops.yaml" mandates that they should be encrypted. +Afterwards, they are encrypted using your "age.agekey" file as specified in ".sops.yaml". `) diff --git a/clustertool/cmd/genconfig.go b/clustertool/cmd/genconfig.go index e4a6467ecd5..6ac6a66cc30 100644 --- a/clustertool/cmd/genconfig.go +++ b/clustertool/cmd/genconfig.go @@ -12,12 +12,12 @@ import ( ) var genConfigLongHelp = strings.TrimSpace(` -ClusterTool after all your settings are entered into talconfig.yaml and talenv.yaml, Clustertool generates a complete clusterconfiguration using TalHelper and various other tools. +After all your settings are entered into talconfig.yaml and clusterenv.yaml, Clustertool generates a complete clusterconfiguration using TalHelper and various other tools. -Its important to note, that running clustertool genconfig, again after each settings change, is absolutely imperative to be able to deploy said settings to your cluster. - -Powered by TalHelper (https://budimanjojo.github.io/talhelper/) +It's important to note that running clustertool genconfig, again after each settings change, is absolutely imperative to be able to deploy said settings to your cluster. +This does not only generate the Talos "Machine Config" files, but also ensures an updated configmap containing your "clusterenv.yaml" settings, is added to the /manifests/ directory, for consumption by FluxCD when added. +It also ensures the same configmap is always added by updating the patches. `) var genConfig = &cobra.Command{ diff --git a/clustertool/cmd/init.go b/clustertool/cmd/init.go index 965197b45f5..653589b09ae 100644 --- a/clustertool/cmd/init.go +++ b/clustertool/cmd/init.go @@ -12,11 +12,9 @@ var initLongHelp = strings.TrimSpace(` ClusterTool requires a specific directory layout to ensure smooth operators and standardised environments. To ensure smooth deployment, the init function can pre-generate all required files in the right places. -Afterwards you can edit talconfig.yaml and clusterenv.yaml to reflect your personal settings. - -When done, please run clustertool genconfig to generate all configarion based on your personal settings - +Afterwards, you can edit talconfig.yaml and clusterenv.yaml to reflect your personal settings. +When done, please run clustertool genconfig to generate all configurations based on your personal settings. `) var initFiles = &cobra.Command{ diff --git a/clustertool/cmd/upgrade.go b/clustertool/cmd/upgrade.go index 8c543e30bff..cf899cd477d 100644 --- a/clustertool/cmd/upgrade.go +++ b/clustertool/cmd/upgrade.go @@ -11,6 +11,10 @@ import ( ) var upgradeLongHelp = strings.TrimSpace(` +The "upgrade" command updates Talos to the latest version specified in talconfig.yaml for all nodes. +It also applies any changed "extentions" and/or "overlays" specified there. + +On top of this, after upgrading Talos on all nodes, it also executes kubernetes-upgrades for the whole cluster as well. `) diff --git a/website/src/content/docs/clustertool/commands/apply.md b/website/src/content/docs/clustertool/commands/apply.md index 272d29af846..3940b5af37f 100644 --- a/website/src/content/docs/clustertool/commands/apply.md +++ b/website/src/content/docs/clustertool/commands/apply.md @@ -5,6 +5,36 @@ title: apply apply TalosConfig +### Synopsis + +The "apply" command applies your Talos System configuration to each node in the cluster, existing or new It also runs automated checking of your config file and health checks between each node it has processed, to ensure you don't accidentally take down your whole cluster. + +## Bootstrapping +If the cluster has not been bootstrapped yet, Apply will automatically detect this and ask if you want to bootstrap the cluster + +Bootstrapping will apply your config to the first (top) controlplane node in your "talconfig.yaml", it then "bootstraps" hence creating a new cluster with said node. + +After this is done, we apply a number of helm-charts and manifests by default such as: + +- Metallb +- Metallb-Config +- Cilium (CNI) +- Certificate-Approver +- Spegel +- Kubernetes-Dashboard + +### Bootstrapping FluxCD + +During Bootstrapping, if a "GITHUB_REPOSITORY" is set in "clusterenv.yaml", you will be asked if you also want to bootstrap FluxCD, checkout the getting-started guide for more info + +## About Bootstrapping + +While we load a lot of helm-charts during bootstrap, we will *never* manage them for you. +You're responsible for maintaining and configuring your cluster after bootstrapping. + +Apply and *all other* commands, are just for maintaining Talos itself. +Not any contained helm-charts + ``` clustertool apply [flags] ``` diff --git a/website/src/content/docs/clustertool/commands/checkcrypt.md b/website/src/content/docs/clustertool/commands/checkcrypt.md index 0228df3eac4..9e5b0c9f482 100644 --- a/website/src/content/docs/clustertool/commands/checkcrypt.md +++ b/website/src/content/docs/clustertool/commands/checkcrypt.md @@ -5,6 +5,12 @@ title: checkcrypt Checks if all files are encrypted correctly in accordance with .sops.yaml +### Synopsis + +It's imperative that you always ensure the config you send to the internet is thoroughly encrypted. Using "clustertool checkcrypt" you can easily check if all files that are due to being encrypted, as specified in ".sops.yaml", will actually be encrypted. + +This tool can, for example, be used as a pre-commit check and will fail with a non-zero exit code if unencrypted files are detected that should've been encrypted in accordance with ".sops.yaml" configuration. + ``` clustertool checkcrypt [flags] ``` diff --git a/website/src/content/docs/clustertool/commands/decrypt.md b/website/src/content/docs/clustertool/commands/decrypt.md index c4741adcbca..a526da207f4 100644 --- a/website/src/content/docs/clustertool/commands/decrypt.md +++ b/website/src/content/docs/clustertool/commands/decrypt.md @@ -5,6 +5,11 @@ title: decrypt Decrypt all high-risk data using sops +### Synopsis + +The decryption feature of ClusterTool goes over all config files and, if encrypted, checks if ".sops.yaml" specifies that they should be decrypted. +If so, they are decrypted using your "age.agekey" file as specified in ".sops.yaml". + ``` clustertool decrypt [flags] ``` diff --git a/website/src/content/docs/clustertool/commands/encrypt.md b/website/src/content/docs/clustertool/commands/encrypt.md index 6997b69afa9..cbff50f6081 100644 --- a/website/src/content/docs/clustertool/commands/encrypt.md +++ b/website/src/content/docs/clustertool/commands/encrypt.md @@ -5,6 +5,11 @@ title: encrypt Encrypt all high-risk data using sops +### Synopsis + +The encryption feature of ClusterTool goes over all config files and, if not encrypted already, checks if ".sops.yaml" mandates that they should be encrypted. +Afterwards, they are encrypted using your "age.agekey" file as specified in ".sops.yaml". + ``` clustertool encrypt [flags] ``` diff --git a/website/src/content/docs/clustertool/commands/genconfig.md b/website/src/content/docs/clustertool/commands/genconfig.md index ed16b3a975c..f8f7303ff3d 100644 --- a/website/src/content/docs/clustertool/commands/genconfig.md +++ b/website/src/content/docs/clustertool/commands/genconfig.md @@ -7,11 +7,12 @@ generate Configuration files ### Synopsis -ClusterTool after all your settings are entered into talconfig.yaml and talenv.yaml, Clustertool generates a complete clusterconfiguration using TalHelper and various other tools. +After all your settings are entered into talconfig.yaml and clusterenv.yaml, Clustertool generates a complete clusterconfiguration using TalHelper and various other tools. -Its important to note, that running clustertool genconfig, again after each settings change, is absolutely imperative to be able to deploy said settings to your cluster. +It's important to note that running clustertool genconfig, again after each settings change, is absolutely imperative to be able to deploy said settings to your cluster. -Powered by TalHelper (https://budimanjojo.github.io/talhelper/) +This does not only generate the Talos "Machine Config" files, but also ensures an updated configmap containing your "clusterenv.yaml" settings, is added to the /manifests/ directory, for consumption by FluxCD when added. +It also ensures the same configmap is always added by updating the patches. ``` clustertool genconfig [flags] diff --git a/website/src/content/docs/clustertool/commands/init.md b/website/src/content/docs/clustertool/commands/init.md index 1144fdb4784..6d547a4a0b7 100644 --- a/website/src/content/docs/clustertool/commands/init.md +++ b/website/src/content/docs/clustertool/commands/init.md @@ -10,9 +10,9 @@ generate Basic ClusterTool file-and-folder structure in current folder ClusterTool requires a specific directory layout to ensure smooth operators and standardised environments. To ensure smooth deployment, the init function can pre-generate all required files in the right places. -Afterwards you can edit talconfig.yaml and clusterenv.yaml to reflect your personal settings. +Afterwards, you can edit talconfig.yaml and clusterenv.yaml to reflect your personal settings. -When done, please run clustertool genconfig to generate all configarion based on your personal settings +When done, please run clustertool genconfig to generate all configurations based on your personal settings. ``` clustertool init [flags] diff --git a/website/src/content/docs/clustertool/commands/upgrade.md b/website/src/content/docs/clustertool/commands/upgrade.md index eb74bb4dff4..f226e0a48ac 100644 --- a/website/src/content/docs/clustertool/commands/upgrade.md +++ b/website/src/content/docs/clustertool/commands/upgrade.md @@ -5,6 +5,13 @@ title: upgrade Upgrade Talos Nodes and Kubernetes +### Synopsis + +The "upgrade" command updates Talos to the latest version specified in talconfig.yaml for all nodes. +It also applies any changed "extentions" and/or "overlays" specified there. + +On top of this, after upgrading Talos on all nodes, it also executes kubernetes-upgrades for the whole cluster as well. + ``` clustertool upgrade [flags] ``` diff --git a/website/src/content/docs/clustertool/functions/init.md b/website/src/content/docs/clustertool/files-folders.md similarity index 73% rename from website/src/content/docs/clustertool/functions/init.md rename to website/src/content/docs/clustertool/files-folders.md index e3a033ce5f1..b025f8e9a7b 100644 --- a/website/src/content/docs/clustertool/functions/init.md +++ b/website/src/content/docs/clustertool/files-folders.md @@ -1,7 +1,5 @@ --- -sidebar: - order: 4 -title: Init +title: Files and Folders --- :::caution[Work In Progress] @@ -12,12 +10,7 @@ All code and docs are considered Pre-Beta drafts ::: -ClusterTool requires a specific directory layout to ensure smooth operators and standardised environments. - -To ensure smooth deployment, the init function can pre-generate all required files in the right places. -Afterwards, you can edit talconfig.yaml and clusterenv.yaml to reflect your personal settings. - -When done, please run clustertool genconfig to generate all configurations based on your personal settings. +File and Folder structure on init, is as follows ## Created Files and Folders diff --git a/website/src/content/docs/clustertool/functions/adv/bootstrap.md b/website/src/content/docs/clustertool/functions/adv/bootstrap.md deleted file mode 100644 index d274ce51759..00000000000 --- a/website/src/content/docs/clustertool/functions/adv/bootstrap.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Bootstrap ---- - -# Bootstrap-Only diff --git a/website/src/content/docs/clustertool/functions/adv/health.md b/website/src/content/docs/clustertool/functions/adv/health.md deleted file mode 100644 index bbbc789057e..00000000000 --- a/website/src/content/docs/clustertool/functions/adv/health.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Health ---- - -# Health diff --git a/website/src/content/docs/clustertool/functions/adv/index.md b/website/src/content/docs/clustertool/functions/adv/index.md deleted file mode 100644 index 834a8248db6..00000000000 --- a/website/src/content/docs/clustertool/functions/adv/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Advanced ---- - -# Advanced diff --git a/website/src/content/docs/clustertool/functions/adv/reset.md b/website/src/content/docs/clustertool/functions/adv/reset.md deleted file mode 100644 index 5d7d8c2295e..00000000000 --- a/website/src/content/docs/clustertool/functions/adv/reset.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Reset ---- - -# Reset diff --git a/website/src/content/docs/clustertool/functions/apply.md b/website/src/content/docs/clustertool/functions/apply.md deleted file mode 100644 index 344f3624d29..00000000000 --- a/website/src/content/docs/clustertool/functions/apply.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar: - order: 7 -title: Apply ---- - -:::caution[Work In Progress] - -This program, all its features and its general design, are all a Work-In-Progress. It is not done and not widely available. - -All code and docs are considered Pre-Beta drafts - -::: - -The `apply` command applies your Talos System configuration to each node in the cluster, existing or new It also runs automated checking of your config file and health checks between each node it has processed, to ensure you don't accidentally take down your whole cluster. - -## Bootstrapping -If the cluster has not been bootstrapped yet, Apply will automatically detect this and ask if you want to bootstrap the cluster - -Bootstrapping will apply your config to the first (top) controlplane node in your `talconfig.yaml`, it then "bootstraps" hence creating a new cluster with said node. - -After this is done, we apply a number of helm-charts and manifests by default such as: - -- Metallb -- Metallb-Config -- Cilium (CNI) -- Certificate-Approver -- Spegel -- KubeApps -- Kubernetes-Dashboard - -### Bootstrapping FluxCD - -During Bootstrapping, if a `GITHUB_REPOSITORY` is set in `clusterenv.yaml`, you will be asked if you also want to bootstrap FluxCD, checkout the getting-started guide for more info - -## About Bootstrapping - -While we load a lot of helm-charts during bootstrap, we will *never* manage them for you. -You're responsible for maintaining and configuring your cluster after bootstrapping. - -Apply and *all other* commands, are just for maintaining Talos itself. -Not any contained helm-charts diff --git a/website/src/content/docs/clustertool/functions/charts/index.md b/website/src/content/docs/clustertool/functions/charts/index.md deleted file mode 100644 index b9ddef9d529..00000000000 --- a/website/src/content/docs/clustertool/functions/charts/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: CI Charts ---- - -# Charts(-CI) - -These are CI functions used to build and test TrueCharts Helm Charts diff --git a/website/src/content/docs/clustertool/functions/checkcrypt.md b/website/src/content/docs/clustertool/functions/checkcrypt.md deleted file mode 100644 index e60055e595d..00000000000 --- a/website/src/content/docs/clustertool/functions/checkcrypt.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -sidebar: - order: 3 -title: checkcrypt ---- - -:::caution[Work In Progress] - -This program, all its features and its general design, are all a Work-In-Progress. It is not done and not widely available. - -All code and docs are considered Pre-Beta drafts - -::: - -It's imperative that you always ensure the config you send to the internet is thoroughly encrypted. Using `clustertool checkcrypt` you can easily check if all files that are due to being encrypted, as specified in `.sops.yaml`, will actually be encrypted. - -This tool can, for example, be used as a pre-commit check and will fail with a non-zero exit code if unencrypted files are detected that should've been encrypted in accordance with `.sops.yaml` configuration. diff --git a/website/src/content/docs/clustertool/functions/decrypt.md b/website/src/content/docs/clustertool/functions/decrypt.md deleted file mode 100644 index 07cf8db4549..00000000000 --- a/website/src/content/docs/clustertool/functions/decrypt.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -sidebar: - order: 5 -title: decrypt ---- - -:::caution[Work In Progress] - -This program, all its features and its general design, are all a Work-In-Progress. It is not done and not widely available. - -All code and docs are considered Pre-Beta drafts - -::: - -The decryption feature of ClusterTool goes over all config files and, if encrypted, checks if `.sops.yaml` specifies that they should be decrypted. -If so, they are decrypted using your `age.agekey` file as specified in `.sops.yaml`. diff --git a/website/src/content/docs/clustertool/functions/encrypt.md b/website/src/content/docs/clustertool/functions/encrypt.md deleted file mode 100644 index 43293608bf5..00000000000 --- a/website/src/content/docs/clustertool/functions/encrypt.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -sidebar: - order: 4 -title: encrypt ---- - -:::caution[Work In Progress] - -This program, all its features and its general design, are all a Work-In-Progress. It is not done and not widely available. - -All code and docs are considered Pre-Beta drafts - -::: - -The encryption feature of ClusterTool goes over all config files and, if not encrypted already, checks if `.sops.yaml` mandates that they should be encrypted. -Afterwards, they are encrypted using your `age.agekey` file as specified in `.sops.yaml`. diff --git a/website/src/content/docs/clustertool/functions/genconfig.md b/website/src/content/docs/clustertool/functions/genconfig.md deleted file mode 100644 index 3f5119e6787..00000000000 --- a/website/src/content/docs/clustertool/functions/genconfig.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -sidebar: - order: 2 -title: genconfig ---- - -:::caution[Work In Progress] - -This program, all its features and its general design, are all a Work-In-Progress. It is not done and not widely available. - -All code and docs are considered Pre-Beta drafts - -::: - -After all your settings are entered into talconfig.yaml and clusterenv.yaml, Clustertool generates a complete clusterconfiguration using TalHelper and various other tools. - -It's important to note that running `clustertool genconfig`, again after each settings change, is absolutely imperative to be able to deploy said settings to your cluster. - -This does not only generate the Talos "Machine Config" files, but also ensures an updated configmap containing your "clusterenv.yaml" settings, is added to the /manifests/ directory, for consumption by FluxCD when added. -It also ensures the same configmap is always added by updating the patches. diff --git a/website/src/content/docs/clustertool/functions/helmrelease/index.md b/website/src/content/docs/clustertool/functions/helmrelease/index.md deleted file mode 100644 index ae63a0bc86f..00000000000 --- a/website/src/content/docs/clustertool/functions/helmrelease/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: HELM Release ---- - -# HelmRelease diff --git a/website/src/content/docs/clustertool/functions/helmrelease/install.md b/website/src/content/docs/clustertool/functions/helmrelease/install.md deleted file mode 100644 index 50b10025302..00000000000 --- a/website/src/content/docs/clustertool/functions/helmrelease/install.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: HELM Install ---- -# Install diff --git a/website/src/content/docs/clustertool/functions/helmrelease/upgrade.md b/website/src/content/docs/clustertool/functions/helmrelease/upgrade.md deleted file mode 100644 index caf09909301..00000000000 --- a/website/src/content/docs/clustertool/functions/helmrelease/upgrade.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: HELM Upgrade ---- -# Upgrade diff --git a/website/src/content/docs/clustertool/functions/scale/scaleexport.md b/website/src/content/docs/clustertool/functions/scale/scaleexport.md deleted file mode 100644 index 9b4657b9f08..00000000000 --- a/website/src/content/docs/clustertool/functions/scale/scaleexport.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: SCALE Export ---- - -# SCALEExport diff --git a/website/src/content/docs/clustertool/functions/scale/scalemigrate.md b/website/src/content/docs/clustertool/functions/scale/scalemigrate.md deleted file mode 100644 index 84046aa99d3..00000000000 --- a/website/src/content/docs/clustertool/functions/scale/scalemigrate.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: SCALE Migrate ---- - -# SCALEMigrate diff --git a/website/src/content/docs/clustertool/functions/upgrade.md b/website/src/content/docs/clustertool/functions/upgrade.md deleted file mode 100644 index df2a50bd423..00000000000 --- a/website/src/content/docs/clustertool/functions/upgrade.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -sidebar: - order: 8 -title: Upgrade ---- - -:::caution[Work In Progress] - -This program, all its features and its general design, are all a Work-In-Progress. It is not done and not widely available. - -All code and docs are considered Pre-Beta drafts - -::: - -The `upgrade` command updates Talos to the latest version specified in talconfig.yaml for all nodes. -It also applies any changed `extentions` and/or `overlays` specified there. - -On top of this, after upgrading Talos on all nodes, it also executes kubernetes-upgrades for the whole cluster as well.