Add documentation for management components upgrade commands

aws · Sep 7, 2024 · de8a41c · de8a41c
1 parent a983cc3
commit de8a41c
Show file tree

Hide file tree

Showing 4 changed files with 74 additions and 2 deletions.
diff --git a/cmd/eksctl-anywhere/cmd/upgrademanagementcomponents.go b/cmd/eksctl-anywhere/cmd/upgrademanagementcomponents.go
@@ -27,7 +27,7 @@ func init() {
 var upgradeManagementComponentsCmd = &cobra.Command{
 	Use:          "management-components",
 	Short:        "Upgrade management components in a management cluster",
-	Long:         "The term 'management components' encompasses all Kubernetes controllers and their CRDs present in the management cluster that are responsible for reconciling your EKS Anywhere (EKS-A) cluster. This command is specifically designed to facilitate the upgrade of these management components. Post this upgrade, the cluster itself can be upgraded by updating the 'eksaRelease' field in your eksa cluster object.",
+	Long:         "The term 'management components' encompasses all Kubernetes controllers and their CRDs present in the management cluster that are responsible for reconciling your EKS Anywhere (EKS-A) cluster. This command is specifically designed to facilitate the upgrade of these management components. Post this upgrade, the cluster itself can be upgraded by updating the 'eksaVersion' field in your EKS-A Cluster object.",
 	PreRunE:      bindFlagsToViper,
 	SilenceUsage: true,
 	Args:         cobra.MaximumNArgs(1),

diff --git a/docs/content/en/docs/clustermgmt/cluster-upgrades/management-components-upgrade.md b/docs/content/en/docs/clustermgmt/cluster-upgrades/management-components-upgrade.md
@@ -75,4 +75,4 @@ Installing new eksa components
 🎉 Management components upgraded!
 ```
 
-At this point, a new `eksaVersion` custom resource will be available in your management cluster, which means new cluster components that correspond to the `eksaVersion` are available for cluster upgrades. You can subsequently run a workload cluster upgrade with the `eksctl anywhere upgrade cluster command`, or by updating `eksaVersion` field in your workload cluster's spec and applying it to your management cluster with Kubernetes API-compatible tooling such as kubectl, GitOps, or Terraform.
+At this point, a new `eksarelease` custom resource will be available in your management cluster, which means new cluster components that correspond to your current EKS Anywhere version are available for cluster upgrades. You can subsequently run a workload cluster upgrade with the `eksctl anywhere upgrade cluster command`, or by updating `eksaVersion` field in your workload cluster's spec and applying it to your management cluster with Kubernetes API-compatible tooling such as kubectl, GitOps, or Terraform.
diff --git a/docs/content/en/docs/reference/eksctl/anywhere_upgrade_management-components.md b/docs/content/en/docs/reference/eksctl/anywhere_upgrade_management-components.md
@@ -0,0 +1,35 @@
+---
+title: "anywhere upgrade management-components"
+linkTitle: "anywhere upgrade management-components"
+---
+
+## anywhere upgrade management-components
+
+Upgrade management components in a management cluster
+
+### Synopsis
+
+The term _management components_ encompasses all Kubernetes controllers and their CRDs present in the management cluster that are responsible for reconciling your EKS Anywhere (EKS-A) cluster. This command is specifically designed to facilitate the upgrade of these management components. Post this upgrade, the cluster itself can be upgraded by updating the 'eksaVersion' field in your EKS-A Cluster object.
+
+```
+anywhere upgrade management-components [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 management-components
+```
+
+### Options inherited from parent commands
+
+```
+  -v, --verbosity int   Set the log level verbosity
+```
+
+### SEE ALSO
+
+* [anywhere upgrade](../anywhere_upgrade/)	 - Upgrade resources
+* [Upgrade management components]({{< relref "../../clustermgmt/cluster-upgrades/management-components-upgrade" >}})
diff --git a/...content/en/docs/reference/eksctl/anywhere_upgrade_plan_management-components.md b/...content/en/docs/reference/eksctl/anywhere_upgrade_plan_management-components.md
@@ -0,0 +1,37 @@
+---
+title: "anywhere upgrade plan management-components"
+linkTitle: "anywhere upgrade plan management-components"
+---
+
+## anywhere upgrade plan management-components
+
+Lists the current and target versions for upgrading the management components in a management cluster
+
+### Synopsis
+
+Provides a list of current and target versions for upgrading the management components in a management cluster. The term _management components_ encompasses all Kubernetes controllers and their CRDs present in the management cluster that are responsible for reconciling your EKS Anywhere (EKS-A) cluster
+
+```
+anywhere upgrade plan management-components [flags]
+```
+
+### Options
+
+```
+      --bundles-override string   Override default Bundles manifest (not recommended)
+  -f, --filename string           Filename that contains EKS-A cluster configuration
+  -h, --help                      help for management-components
+      --kubeconfig string         Management cluster kubeconfig file
+  -o, --output string             Output format: text|json (default "text")
+```
+
+### Options inherited from parent commands
+
+```
+  -v, --verbosity int   Set the log level verbosity
+```
+
+### SEE ALSO
+
+* [anywhere upgrade plan](../anywhere_upgrade_plan/)	 - Provides information for a resource upgrade
+