Update CLI doc with make docgen (#6717)

aws · Sep 22, 2023 · 81abfa4 · 81abfa4
1 parent 142fec0
commit 81abfa4
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 9 deletions.
diff --git a/docs/content/en/docs/reference/eksctl/anywhere_create_cluster.md b/docs/content/en/docs/reference/eksctl/anywhere_create_cluster.md
@@ -18,21 +18,21 @@ anywhere create cluster -f <cluster-config-file> [flags]
 ### Options
 
 ```
-      --bundles-override string             Override default Bundles manifest (not recommended)
+      --bundles-override string             A path to a custom bundles manifest
       --control-plane-wait-timeout string   Override the default control plane wait timeout (default "1h0m0s")
       --external-etcd-wait-timeout string   Override the default external etcd wait timeout (default "1h0m0s")
-  -f, --filename string                     Filename that contains EKS-A cluster configuration
+  -f, --filename string                     Path that contains a cluster configuration
   -z, --hardware-csv string                 Path to a CSV file containing hardware data.
   -h, --help                                help for cluster
       --install-packages string             Location of curated packages configuration files to install to the cluster
       --kubeconfig string                   Management cluster kubeconfig file
       --no-timeouts                         Disable timeout for all wait operations
-      --node-startup-timeout string         Override the default node startup timeout (Defaults to 20m for Tinkerbell clusters) (default "10m0s")
+      --node-startup-timeout string         (DEPRECATED) Override the default node startup timeout (Defaults to 20m for Tinkerbell clusters) (default "10m0s")
       --per-machine-wait-timeout string     Override the default machine wait timeout per machine (default "10m0s")
       --skip-ip-check                       Skip check for whether cluster control plane ip is in use
       --skip-validations stringArray        Bypass create validations by name. Valid arguments you can pass are --skip-validations=vsphere-user-privilege
-      --tinkerbell-bootstrap-ip string      Override the local tinkerbell IP in the bootstrap cluster
-      --unhealthy-machine-timeout string    Override the default unhealthy machine timeout (default "5m0s")
+      --tinkerbell-bootstrap-ip string      The IP used to expose the Tinkerbell stack from the bootstrap cluster
+      --unhealthy-machine-timeout string    (DEPRECATED) Override the default unhealthy machine timeout (default "5m0s")
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/en/docs/reference/eksctl/anywhere_generate.md b/docs/content/en/docs/reference/eksctl/anywhere_generate.md
@@ -31,4 +31,5 @@ Use eksctl anywhere generate to generate resources, such as clusterconfig yaml
 * [anywhere generate packages](../anywhere_generate_packages/)	 - Generate package(s) configuration
 * [anywhere generate support-bundle](../anywhere_generate_support-bundle/)	 - Generate a support bundle
 * [anywhere generate support-bundle-config](../anywhere_generate_support-bundle-config/)	 - Generate support bundle config
+* [anywhere generate tinkerbelltemplateconfig](../anywhere_generate_tinkerbelltemplateconfig/)	 - Generate TinkerbellTemplateConfig objects
 
diff --git a/.../content/en/docs/reference/eksctl/anywhere_generate_tinkerbelltemplateconfig.md b/.../content/en/docs/reference/eksctl/anywhere_generate_tinkerbelltemplateconfig.md
@@ -0,0 +1,48 @@
+---
+title: "anywhere generate tinkerbelltemplateconfig"
+linkTitle: "anywhere generate tinkerbelltemplateconfig"
+---
+
+## anywhere generate tinkerbelltemplateconfig
+
+Generate TinkerbellTemplateConfig objects
+
+### Synopsis
+
+Generate TinkerbellTemplateConfig objects for your cluster specification.
+
+The TinkerbellTemplateConfig is part of an EKS Anywhere bare metal cluster 
+specification. When no template config is specified on TinkerbellMachineConfig
+objects, EKS Anywhere generates the template config internally. The template 
+config defines the actions for provisioning a bare metal host such as streaming 
+an OS image to disk. Actions vary based on the OS - see the EKS Anywhere 
+documentation for more details on the individual actions.
+
+The template config include it in your bare metal cluster specification and
+reference it in the TinkerbellMachineConfig object using the .spec.templateRef
+field.
+
+
+```
+anywhere generate tinkerbelltemplateconfig [flags]
+```
+
+### Options
+
+```
+      --bundles-override string          A path to a custom bundles manifest
+  -f, --filename string                  Path that contains a cluster configuration
+  -h, --help                             help for tinkerbelltemplateconfig
+      --tinkerbell-bootstrap-ip string   The IP used to expose the Tinkerbell stack from the bootstrap cluster
+```
+
+### Options inherited from parent commands
+
+```
+  -v, --verbosity int   Set the log level verbosity
+```
+
+### SEE ALSO
+
+* [anywhere generate](../anywhere_generate/)	 - Generate resources
+
diff --git a/docs/content/en/docs/reference/eksctl/anywhere_upgrade_cluster.md b/docs/content/en/docs/reference/eksctl/anywhere_upgrade_cluster.md
@@ -18,18 +18,18 @@ anywhere upgrade cluster [flags]
 ### Options
 
 ```
-      --bundles-override string             Override default Bundles manifest (not recommended)
+      --bundles-override string             A path to a custom bundles manifest
       --control-plane-wait-timeout string   Override the default control plane wait timeout (default "1h0m0s")
       --external-etcd-wait-timeout string   Override the default external etcd wait timeout (default "1h0m0s")
-  -f, --filename string                     Filename that contains EKS-A cluster configuration
+  -f, --filename string                     Path that contains a cluster configuration
   -z, --hardware-csv string                 Path to a CSV file containing hardware data.
   -h, --help                                help for cluster
       --kubeconfig string                   Management cluster kubeconfig file
       --no-timeouts                         Disable timeout for all wait operations
-      --node-startup-timeout string         Override the default node startup timeout (Defaults to 20m for Tinkerbell clusters) (default "10m0s")
+      --node-startup-timeout string         (DEPRECATED) Override the default node startup timeout (Defaults to 20m for Tinkerbell clusters) (default "10m0s")
       --per-machine-wait-timeout string     Override the default machine wait timeout per machine (default "10m0s")
       --skip-validations stringArray        Bypass upgrade validations by name. Valid arguments you can pass are --skip-validations=pod-disruption,vsphere-user-privilege,eksa-version-skew
-      --unhealthy-machine-timeout string    Override the default unhealthy machine timeout (default "5m0s")
+      --unhealthy-machine-timeout string    (DEPRECATED) Override the default unhealthy machine timeout (default "5m0s")
   -w, --w-config string                     Kubeconfig file to use when upgrading a workload cluster
 ```