Merge pull request kubernetes-sigs#6781 from oscr/clusterctl-missing-commands

📖 Add missing clusterctl commands in CAPI book

Author: k8s-ci-robot

docs/book/src/SUMMARY.md

@@ -32,6 +32,7 @@
     - [clusterctl Commands](clusterctl/commands/commands.md)
         - [init](clusterctl/commands/init.md)
         - [generate cluster](clusterctl/commands/generate-cluster.md)
+        - [generate provider](clusterctl/commands/generate-provider.md)
         - [generate yaml](clusterctl/commands/generate-yaml.md)
         - [get kubeconfig](clusterctl/commands/get-kubeconfig.md)
         - [describe cluster](clusterctl/commands/describe-cluster.md)
@@ -41,6 +42,7 @@
         - [completion](clusterctl/commands/completion.md)
         - [alpha rollout](clusterctl/commands/alpha-rollout.md)
         - [alpha topology plan](clusterctl/commands/alpha-topology-plan.md)
+        - [additional commands](clusterctl/commands/additional-commands.md)
     - [clusterctl Configuration](clusterctl/configuration.md)
     - [clusterctl Provider Contract](clusterctl/provider-contract.md)
     - [clusterctl for Developers](clusterctl/developers.md)

docs/book/src/clusterctl/commands/additional-commands.md

@@ -0,0 +1,24 @@
+# clusterctl backup
+
+Backup Cluster API objects and all dependencies from a management cluster.
+
+# clusterctl config repositories
+
+Display the list of providers and their repository configurations.
+
+clusterctl ships with a list of known providers; if necessary, edit
+$HOME/.cluster-api/clusterctl.yaml file to add a new provider or to customize existing ones.
+
+# clusterctl help
+
+Help provides help for any command in the application.
+Simply type `clusterctl help [command]` for full details.
+
+# clusterctl restore
+
+Restore Cluster API objects from file by glob. Object files are searched in the default config directory
+or in the provided directory.
+
+# clusterctl version
+
+Print clusterctl version.

docs/book/src/clusterctl/commands/commands.md

@@ -1,13 +1,19 @@
-# clusterctl Commands
+# clusterctl commands
 
-* [`clusterctl init`](init.md)
+* [`clusterctl alpha rollout`](alpha-rollout.md)
+* [`clusterctl alpha topology plan`](alpha-topology-plan.md)
+* [`clusterctl backup`](additional-commands.md#clusterctl-backup)
+* [`clusterctl completion`](completion.md)
+* [`clusterctl config`](additional-commands.md#clusterctl-config-repositories)
+* [`clusterctl delete`](delete.md)
+* [`clusterctl describe cluster`](describe-cluster.md)
 * [`clusterctl generate cluster`](generate-cluster.md)
+* [`clusterctl generate provider`](generate-provider.md)
 * [`clusterctl generate yaml`](generate-yaml.md)
 * [`clusterctl get kubeconfig`](get-kubeconfig.md)
-* [`clusterctl describe cluster`](describe-cluster.md)
+* [`clusterctl help`](additional-commands.md#clusterctl-help)
+* [`clusterctl init`](init.md)
 * [`clusterctl move`](move.md)
+* [`clusterctl restore`](additional-commands.md#clusterctl-restore)
 * [`clusterctl upgrade`](upgrade.md)
-* [`clusterctl delete`](delete.md)
-* [`clusterctl completion`](completion.md)
-* [`clusterctl alpha rollout`](alpha-rollout.md)
-* [`clusterctl alpha topology plan`](alpha-topology-plan.md)
+* [`clusterctl version`](additional-commands.md#clusterctl-version)

docs/book/src/clusterctl/commands/generate-provider.md

@@ -0,0 +1,32 @@
+# clusterctl generate provider
+
+Generate templates for provider components.
+
+clusterctl fetches the provider components from the provider repository and performs variable substitution.
+
+Variable values are either sourced from the clusterctl config file or
+from environment variables
+
+Usage: `clusterctl generate provider [flags]`
+
+Current usage of the command is as follows:
+```bash
+# Generates a yaml file for creating provider with variable values using
+# components defined in the provider repository.
+clusterctl generate provider --infrastructure aws
+
+# Generates a yaml file for creating provider for a specific version with variable values using
+# components defined in the provider repository.
+clusterctl generate provider --infrastructure aws:v0.4.1
+
+# Displays information about a specific infrastructure provider.
+# If applicable, prints out the list of required environment variables.
+clusterctl generate provider --infrastructure aws --describe
+
+# Displays information about a specific version of the infrastructure provider.
+clusterctl generate provider --infrastructure aws:v0.4.1 --describe
+
+# Generates a yaml file for creating provider for a specific version.
+# No variables will be processed and substituted using this flag
+clusterctl generate provider --infrastructure aws:v0.4.1 --raw
+```