-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc(readme): update versioning and compatibility matrix (#675)
Signed-off-by: Steven Zou <szou@vmware.com> fix #673
- Loading branch information
1 parent
fec3179
commit 7737964
Showing
2 changed files
with
27 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,25 @@ | ||
# How to upgrade your Harbor cluster | ||
|
||
The harbor operator only serves a specific version of the harbor and allows to upgrade the harbor cluster instances from the old version to the latest version the operator served. | ||
A specified version of Harbor operator supports a corresponding Harbor minor version as well as its subsequent patch releases. e.g: harbor operator v1.0.1 supports 2.2.x harbor versions such as 2.2.0, 2.2.1 and 2.2.2 etc. For upgrading your Harbor cluster, there might be two different cases. | ||
|
||
Assume that the harbor operator v1.0.0 which serves harbor v2.2.1 is installed in the Kubernetes cluster, and there is harbor clusters deployed in the Kubernetes cluster. Now the harbor operator v1.0.1 which serves harbor v2.2.2 is released, and the users want to upgrade the three harbor clusters to v2.2.2. Here are the steps to upgrade the harbor cluster managed by the harbor operator to the new version. | ||
## Upgrade to patch releases | ||
|
||
1. Upgrade the harbor operator to v1.0.1 by helm or kustomize, the method depends on the original way to install the harbor operator. [Installation](../installation/installation.md) is a reference resources to upgrade the harbor operator to new release. | ||
The guideline shown below describes how to upgrade your Harbor cluster from lower patch version to higher patch version without operator upgrading (because there is no need as a Harbor operator version supports all patch releases). | ||
|
||
2. Edit the manifest of the harbor cluster by `kubectl` and set the `version` field to `2.2.2` in the spec. | ||
Assume that the harbor operator v1.0.1 which serves harbor v2.2.x is installed in the Kubernetes cluster, and there is a harbor cluster v2.2.2 deployed in the Kubernetes cluster. | ||
|
||
If you want to upgrade the harbor cluster from v2.2.2 to v2.2.3, just edit the manifest of the harbor cluster by `kubectl` and set the `version` field from `2.2.2` to `2.2.3` and the harbor operator will upgrade the harbor cluster instance to harbor v2.2.3. | ||
|
||
## Upgrade to minor+ releases | ||
|
||
For upgrading Harbor cluster across different minor versions, an operator upgrading should be involved first (because one Harbor operator version only serves one minor version serials). Steps shown below describes how to do such upgrading. | ||
|
||
1. Upgrade the harbor operator to the newer version that supports the Harbor version you're planning to upgrade your existing Harbor cluster to by `helm` or `kustomize`, the method depends on the original way to install the harbor operator. [Installation](../installation/installation.md) is a reference resources to upgrade the harbor operator to new release. | ||
|
||
1. Edit the manifest of the harbor cluster by `kubectl` and set the `version` field to the newer Harbor version (e.g:`2.3.0`) in the spec. | ||
|
||
```bash | ||
kubectl -n harbor-cluster-ns edit harborclusters cluster-name | ||
``` | ||
|
||
3. The harbor operator will get an update event of the harbor cluster resource and reconcile to upgrade the harbor cluster to v2.2.2. | ||
1. The harbor operator will get an update event of the harbor cluster resource and reconcile to upgrade the harbor cluster to v2.3.0. |