Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for management components upgrade commands #8726

Merged
merged 1 commit into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/eksctl-anywhere/cmd/upgrademanagementcomponents.go
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
@@ -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" >}})
Original file line number Diff line number Diff line change
@@ -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

Loading