From b7beb4ecdaf05e759399561d372a39a6bc5050f2 Mon Sep 17 00:00:00 2001 From: Kjeld Schouten Date: Tue, 5 Nov 2024 22:05:48 +0100 Subject: [PATCH] chore(website): generate new clustertool docs --- .../{fluxbootstrap.md => flux/bootstrap.md} | 10 +++---- .../docs/clustertool/commands/flux/index.md | 28 +++++++++++++++++++ .../clustertool/commands/{ => talos}/apply.md | 8 +++--- .../commands/{adv => talos}/bootstrap.md | 6 ++-- .../commands/{adv => talos}/health.md | 6 ++-- .../docs/clustertool/commands/talos/index.md | 28 +++++++++++++++++++ .../commands/{adv => talos}/reset.md | 6 ++-- .../commands/{ => talos}/upgrade.md | 6 ++-- 8 files changed, 77 insertions(+), 21 deletions(-) rename website/src/content/docs/clustertool/commands/{fluxbootstrap.md => flux/bootstrap.md} (59%) create mode 100644 website/src/content/docs/clustertool/commands/flux/index.md rename website/src/content/docs/clustertool/commands/{ => talos}/apply.md (94%) rename website/src/content/docs/clustertool/commands/{adv => talos}/bootstrap.md (74%) rename website/src/content/docs/clustertool/commands/{adv => talos}/health.md (75%) create mode 100644 website/src/content/docs/clustertool/commands/talos/index.md rename website/src/content/docs/clustertool/commands/{adv => talos}/reset.md (77%) rename website/src/content/docs/clustertool/commands/{ => talos}/upgrade.md (87%) diff --git a/website/src/content/docs/clustertool/commands/fluxbootstrap.md b/website/src/content/docs/clustertool/commands/flux/bootstrap.md similarity index 59% rename from website/src/content/docs/clustertool/commands/fluxbootstrap.md rename to website/src/content/docs/clustertool/commands/flux/bootstrap.md index bcc41938d4f..2421fa85c0d 100644 --- a/website/src/content/docs/clustertool/commands/fluxbootstrap.md +++ b/website/src/content/docs/clustertool/commands/flux/bootstrap.md @@ -1,24 +1,24 @@ --- -title: fluxbootstrap +title: flux bootstrap --- -## clustertool fluxbootstrap +## clustertool flux bootstrap Manually bootstrap fluxcd on existing cluster ``` -clustertool fluxbootstrap [flags] +clustertool flux bootstrap [flags] ``` ### Examples ``` -clustertool fluxbootstrap +clustertool flux bootstrap ``` ### Options ``` - -h, --help help for fluxbootstrap + -h, --help help for bootstrap ``` ### Options inherited from parent commands diff --git a/website/src/content/docs/clustertool/commands/flux/index.md b/website/src/content/docs/clustertool/commands/flux/index.md new file mode 100644 index 00000000000..79b067431e5 --- /dev/null +++ b/website/src/content/docs/clustertool/commands/flux/index.md @@ -0,0 +1,28 @@ +--- +title: flux +--- +## clustertool flux + +Commands for handling FluxCD + +### Synopsis + +These are all advanced commands that should generally not be needed + +### Examples + +``` +clustertool flux bootstrap +``` + +### Options + +``` + -h, --help help for flux +``` + +### Options inherited from parent commands + +``` + --cluster string Cluster name (default "main") +``` diff --git a/website/src/content/docs/clustertool/commands/apply.md b/website/src/content/docs/clustertool/commands/talos/apply.md similarity index 94% rename from website/src/content/docs/clustertool/commands/apply.md rename to website/src/content/docs/clustertool/commands/talos/apply.md index 3940b5af37f..b5e8542011c 100644 --- a/website/src/content/docs/clustertool/commands/apply.md +++ b/website/src/content/docs/clustertool/commands/talos/apply.md @@ -1,9 +1,9 @@ --- -title: apply +title: talos apply --- -## clustertool apply +## clustertool talos apply -apply TalosConfig +apply ### Synopsis @@ -36,7 +36,7 @@ Apply and *all other* commands, are just for maintaining Talos itself. Not any contained helm-charts ``` -clustertool apply [flags] +clustertool talos apply [flags] ``` ### Examples diff --git a/website/src/content/docs/clustertool/commands/adv/bootstrap.md b/website/src/content/docs/clustertool/commands/talos/bootstrap.md similarity index 74% rename from website/src/content/docs/clustertool/commands/adv/bootstrap.md rename to website/src/content/docs/clustertool/commands/talos/bootstrap.md index 8217e8fbcb4..a5384199599 100644 --- a/website/src/content/docs/clustertool/commands/adv/bootstrap.md +++ b/website/src/content/docs/clustertool/commands/talos/bootstrap.md @@ -1,12 +1,12 @@ --- -title: adv bootstrap +title: talos bootstrap --- -## clustertool adv bootstrap +## clustertool talos bootstrap bootstrap first Talos Node ``` -clustertool adv bootstrap [flags] +clustertool talos bootstrap [flags] ``` ### Examples diff --git a/website/src/content/docs/clustertool/commands/adv/health.md b/website/src/content/docs/clustertool/commands/talos/health.md similarity index 75% rename from website/src/content/docs/clustertool/commands/adv/health.md rename to website/src/content/docs/clustertool/commands/talos/health.md index bc5bf261d71..7d5edc9a5fd 100644 --- a/website/src/content/docs/clustertool/commands/adv/health.md +++ b/website/src/content/docs/clustertool/commands/talos/health.md @@ -1,12 +1,12 @@ --- -title: adv health +title: talos health --- -## clustertool adv health +## clustertool talos health Check Talos Cluster Health ``` -clustertool adv health [flags] +clustertool talos health [flags] ``` ### Examples diff --git a/website/src/content/docs/clustertool/commands/talos/index.md b/website/src/content/docs/clustertool/commands/talos/index.md new file mode 100644 index 00000000000..d6ce3368706 --- /dev/null +++ b/website/src/content/docs/clustertool/commands/talos/index.md @@ -0,0 +1,28 @@ +--- +title: talos +--- +## clustertool talos + +Commands for handling Talos OS + +### Synopsis + +These are all advanced commands that should generally not be needed + +### Examples + +``` +clustertool talos apply +``` + +### Options + +``` + -h, --help help for talos +``` + +### Options inherited from parent commands + +``` + --cluster string Cluster name (default "main") +``` diff --git a/website/src/content/docs/clustertool/commands/adv/reset.md b/website/src/content/docs/clustertool/commands/talos/reset.md similarity index 77% rename from website/src/content/docs/clustertool/commands/adv/reset.md rename to website/src/content/docs/clustertool/commands/talos/reset.md index 6943752546b..6885bb1b921 100644 --- a/website/src/content/docs/clustertool/commands/adv/reset.md +++ b/website/src/content/docs/clustertool/commands/talos/reset.md @@ -1,12 +1,12 @@ --- -title: adv reset +title: talos reset --- -## clustertool adv reset +## clustertool talos reset Reset Talos Nodes and Kubernetes ``` -clustertool adv reset [flags] +clustertool talos reset [flags] ``` ### Examples diff --git a/website/src/content/docs/clustertool/commands/upgrade.md b/website/src/content/docs/clustertool/commands/talos/upgrade.md similarity index 87% rename from website/src/content/docs/clustertool/commands/upgrade.md rename to website/src/content/docs/clustertool/commands/talos/upgrade.md index f226e0a48ac..38fc29c5d90 100644 --- a/website/src/content/docs/clustertool/commands/upgrade.md +++ b/website/src/content/docs/clustertool/commands/talos/upgrade.md @@ -1,7 +1,7 @@ --- -title: upgrade +title: talos upgrade --- -## clustertool upgrade +## clustertool talos upgrade Upgrade Talos Nodes and Kubernetes @@ -13,7 +13,7 @@ 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] +clustertool talos upgrade [flags] ``` ### Examples