feat(website): add clustertool commands section from autogeneration

This commit is contained in:
Kjeld Schouten
2024-10-25 22:08:53 +02:00
parent fd5da655b6
commit 7a76117b6b
34 changed files with 1034 additions and 0 deletions

View File

@@ -0,0 +1,28 @@
---
title: clustertool adv bootstrap
---
## clustertool adv bootstrap
bootstrap first Talos Node
```
clustertool adv bootstrap [flags]
```
### Examples
```
clustertool adv bootstrap
```
### Options
```
-h, --help help for bootstrap
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool adv health
---
## clustertool adv health
Check Talos Cluster Health
```
clustertool adv health [flags]
```
### Examples
```
clustertool adv health
```
### Options
```
-h, --help help for health
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool adv
---
## clustertool adv
Advanced cluster maintanence commands
### Synopsis
These are all advanced commands that should generally not be needed
### Examples
```
clustertool adv <bootstrap/health/precommit>
```
### Options
```
-h, --help help for adv
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool adv precommit
---
## clustertool adv precommit
Runs the PreCommit encryption check
```
clustertool adv precommit [flags]
```
### Examples
```
clustertool adv precommit
```
### Options
```
-h, --help help for precommit
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool adv reset
---
## clustertool adv reset
Reset Talos Nodes and Kubernetes
```
clustertool adv reset [flags]
```
### Examples
```
clustertool adv reset <NodeIP>
```
### Options
```
-h, --help help for reset
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,26 @@
---
title: clustertool adv test
---
## clustertool adv test
tests specific code for developer usages
### Synopsis
This command is mostly just for development usage and should NEVER be used by end-users.
```
clustertool adv test [flags]
```
### Options
```
-h, --help help for test
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool apply
---
## clustertool apply
apply TalosConfig
```
clustertool apply [flags]
```
### Examples
```
clustertool apply <NodeIP>
```
### Options
```
-h, --help help for apply
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool charts bump
---
## clustertool charts bump
generate a bumped image version
```
clustertool charts bump [flags]
```
### Examples
```
clustertool charts bump <version> <kind>
```
### Options
```
-h, --help help for bump
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool charts deps
---
## clustertool charts deps
Download, Update and Verify Helm dependencies
```
clustertool charts deps [flags]
```
### Examples
```
clustertool charts deps <chart> <chart> <chart>
```
### Options
```
-h, --help help for deps
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool charts genchangelog
---
## clustertool charts genchangelog
Generate changelog for charts
```
clustertool charts genchangelog [flags]
```
### Examples
```
clustertool charts genchangelog <repo path> <template path> <charts dir>
```
### Options
```
-h, --help help for genchangelog
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool charts genchartlist
---
## clustertool charts genchartlist
Generate chart list json file
```
clustertool charts genchartlist [flags]
```
### Examples
```
clustertool charts genchartlist <path to charts folder>
```
### Options
```
-h, --help help for genchartlist
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool charts genmeta
---
## clustertool charts genmeta
Generate and update Chart.yaml metadata
```
clustertool charts genmeta [flags]
```
### Examples
```
clustertool charts genmeta
```
### Options
```
-h, --help help for genmeta
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,33 @@
---
title: clustertool charts
---
## clustertool charts
A tool to help with creating Talos cluster
### Synopsis
charttool was a tool to help you build TrueCharts Charts.
It has since been merged into Clustertool as "clustertool charts"
Example commands
> charttool bump 1.2.3 patch
> charttool tagclean soemtag@somedigest
### Examples
```
charttool bump 1.2.3 patch
```
### Options
```
-h, --help help for charts
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool charts tagcleaner
---
## clustertool charts tagcleaner
Creates a clean version tag from a container digest
```
clustertool charts tagcleaner [flags]
```
### Examples
```
clustertool charts tagclean <tag>
```
### Options
```
-h, --help help for tagcleaner
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool checkcrypt
---
## clustertool checkcrypt
Checks if all files are encrypted correctly in accordance with .sops.yaml
```
clustertool checkcrypt [flags]
```
### Examples
```
clustertool checkcrypt
```
### Options
```
-h, --help help for checkcrypt
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,47 @@
---
title: clustertool completion bash
---
## clustertool completion bash
Generate the autocompletion script for bash
### Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
source <(clustertool completion bash)
To load completions for every new session, execute once:
#### Linux:
clustertool completion bash > /etc/bash_completion.d/clustertool
#### macOS:
clustertool completion bash > $(brew --prefix)/etc/bash_completion.d/clustertool
You will need to start a new shell for this setup to take effect.
```
clustertool completion bash
```
### Options
```
-h, --help help for bash
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,38 @@
---
title: clustertool completion fish
---
## clustertool completion fish
Generate the autocompletion script for fish
### Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
clustertool completion fish | source
To load completions for every new session, execute once:
clustertool completion fish > ~/.config/fish/completions/clustertool.fish
You will need to start a new shell for this setup to take effect.
```
clustertool completion fish [flags]
```
### Options
```
-h, --help help for fish
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,24 @@
---
title: clustertool completion
---
## clustertool completion
Generate the autocompletion script for the specified shell
### Synopsis
Generate the autocompletion script for clustertool for the specified shell.
See each sub-command's help for details on how to use the generated script.
### Options
```
-h, --help help for completion
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,35 @@
---
title: clustertool completion powershell
---
## clustertool completion powershell
Generate the autocompletion script for powershell
### Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
clustertool completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command
to your powershell profile.
```
clustertool completion powershell [flags]
```
### Options
```
-h, --help help for powershell
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,49 @@
---
title: clustertool completion zsh
---
## clustertool completion zsh
Generate the autocompletion script for zsh
### Synopsis
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(clustertool completion zsh)
To load completions for every new session, execute once:
#### Linux:
clustertool completion zsh > "${fpath[1]}/_clustertool"
#### macOS:
clustertool completion zsh > $(brew --prefix)/share/zsh/site-functions/_clustertool
You will need to start a new shell for this setup to take effect.
```
clustertool completion zsh [flags]
```
### Options
```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool decrypt
---
## clustertool decrypt
Decrypt all high-risk data using sops
```
clustertool decrypt [flags]
```
### Examples
```
clustertool decrypt
```
### Options
```
-h, --help help for decrypt
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool encrypt
---
## clustertool encrypt
Encrypt all high-risk data using sops
```
clustertool encrypt [flags]
```
### Examples
```
clustertool encrypt
```
### Options
```
-h, --help help for encrypt
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool fluxbootstrap
---
## clustertool fluxbootstrap
Manually bootstrap fluxcd on existing cluster
```
clustertool fluxbootstrap [flags]
```
### Examples
```
clustertool fluxbootstrap
```
### Options
```
-h, --help help for fluxbootstrap
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,36 @@
---
title: clustertool genconfig
---
## clustertool genconfig
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.
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/)
```
clustertool genconfig [flags]
```
### Examples
```
clustertool genconfig
```
### Options
```
-h, --help help for genconfig
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool helmrelease
---
## clustertool helmrelease
A toolkit to load helm-release files onto a cluster without flux
### Synopsis
These are all advanced commands that should generally not be needed
### Examples
```
clustertool helmrelease <install/upgrade>
```
### Options
```
-h, --help help for helmrelease
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool helmrelease install
---
## clustertool helmrelease install
install a helm-release file without flux, helm-release file needs to be called helm-release.yaml
```
clustertool helmrelease install [flags]
```
### Examples
```
clustertool helmrelease install
```
### Options
```
-h, --help help for install
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool helmrelease upgrade
---
## clustertool helmrelease upgrade
run helm-upgrade using a helm-release file without flux
```
clustertool helmrelease upgrade [flags]
```
### Examples
```
clustertool helmrelease upgrade
```
### Options
```
-h, --help help for upgrade
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,25 @@
---
title: clustertool
---
## clustertool
A tool to help with creating Talos cluster
### Synopsis
clustertool is a tool to help you easily deploy and maintain a Talos Kubernetes Cluster.
Workflow:
Create talconfig.yaml file defining your nodes information like so:
Available commands
> clustertool init
> clustertool genconfig
### Options
```
--cluster string Cluster name (default "main")
-h, --help help for clustertool
```

View File

@@ -0,0 +1,40 @@
---
title: clustertool info
---
## clustertool info
Prints information about the clustertool binary
### Synopsis
clustertool is a tool to help you easily deploy and maintain a Talos Kubernetes Cluster.
Workflow:
Create talconfig.yaml file defining your nodes information like so:
Available commands
> clustertool init
> clustertool genconfig
```
clustertool info [flags]
```
### Examples
```
clustertool info
```
### Options
```
-h, --help help for info
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,37 @@
---
title: clustertool init
---
## clustertool init
generate Basic ClusterTool file-and-folder structure in current folder
### Synopsis
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
```
clustertool init [flags]
```
### Examples
```
clustertool init
```
### Options
```
-h, --help help for init
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool scale export
---
## clustertool scale export
Export SCALE Apps to file
```
clustertool scale export [flags]
```
### Examples
```
clustertool scale export
```
### Options
```
-h, --help help for export
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool scale
---
## clustertool scale
Commands for handling TrueNAS SCALE
### Synopsis
These are all advanced commands that should generally not be needed
### Examples
```
clustertool scale export
```
### Options
```
-h, --help help for scale
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool scale migrate
---
## clustertool scale migrate
Migrate exported SCALE Apps to the Talos Cluster
```
clustertool scale migrate [flags]
```
### Examples
```
clustertool scale migrate
```
### Options
```
-h, --help help for migrate
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```

View File

@@ -0,0 +1,28 @@
---
title: clustertool upgrade
---
## clustertool upgrade
Upgrade Talos Nodes and Kubernetes
```
clustertool upgrade [flags]
```
### Examples
```
clustertool upgrade <NodeIP>
```
### Options
```
-h, --help help for upgrade
```
### Options inherited from parent commands
```
--cluster string Cluster name (default "main")
```