From c96f8563ae223d12cd2bb1e960658b202ae7c277 Mon Sep 17 00:00:00 2001 From: Stuart Clements Date: Wed, 15 Jan 2020 16:15:22 +0100 Subject: [PATCH] Moved helm upgrade to upgrade section --- docs/1.10/index.md | 2 +- docs/1.10/install_config/helm_upgrade.md | 74 ------------------------ 2 files changed, 1 insertion(+), 75 deletions(-) delete mode 100644 docs/1.10/install_config/helm_upgrade.md diff --git a/docs/1.10/index.md b/docs/1.10/index.md index 01f658ca9..121f851b7 100644 --- a/docs/1.10/index.md +++ b/docs/1.10/index.md @@ -15,7 +15,6 @@ This section describes how to install Harbor and perform the required initial co - [Configure the Harbor YML File](install_config/configure_yml_file.md) - [Run the Installer Script](install_config/run_installer_script.md) - [Deploying Harbor with High Availability via Helm](install_config/harbor_ha_helm.md) - - [Upgrading Harbor Deployed with Helm](install_config/helm_upgrade.md) - [Troubleshooting Harbor Installation](install_config/troubleshoot_installation.md) - [Reconfigure Harbor and Manage the Harbor Lifecycle](install_config/reconfigure_manage_lifecycle.md) - [Customize the Harbor Token Service](install_config/customize_token_service.md) @@ -48,6 +47,7 @@ This section describes how to use and maintain Harbor after deployment. These da - [Configure System-Wide CVE Whitelists](administration/vulnerability_scanning/configure_system_whitelist.md) - [Garbage Collection](administration/garbage_collection.md) - [Upgrade Harbor and Migrate Data](administration/upgrade/upgrade_migrate_data.md) + - [Upgrading Harbor Deployed with Helm](administration/upgrade/helm_upgrade.md) - [Roll Back an Upgrade](administration/upgrade/roll_back_upgrade.md) - [Test Harbor Upgrade](administration/upgrade/upgradetest.md) diff --git a/docs/1.10/install_config/helm_upgrade.md b/docs/1.10/install_config/helm_upgrade.md deleted file mode 100644 index 5eef9ffe0..000000000 --- a/docs/1.10/install_config/helm_upgrade.md +++ /dev/null @@ -1,74 +0,0 @@ -[Back to table of contents](../index.md) - ----------- - -# Upgrading Harbor Deployed with Helm - -This guide is used to upgrade Harbor deployed by chart since version 0.3.0. - -## Notes - -- As the database schema may change between different versions of Harbor, there is a progress to migrate the schema during the upgrade and the downtime cannot be avoid -- The database schema cannot be downgraded automatically, so the `helm rollback` is not supported - -## Upgrade - -### 1. Backup database - -Backup the database used by Harbor in case the upgrade process fails. - -### 2. Download new chart - -Download the latest version of Harbor chart. - -### 3. Configure new chart - -Configure the new chart to make sure that the configuration items have the same values with the old one. - -> Note: if TLS is enabled and the certificate is generated by chart automatically, a new certificate will be generated and overwrite the old one during the upgrade, this may cause some issues if you have distributed the certificate. You can follow the below steps to configure the new chart to use the old certificate: - -1) Get the secret name which certificate is stored in: - - ```bash - kubectl get secret - ``` - - Find the secret whose name ends with `-harbor-ingress` (expose service via `Ingress`) or `-harbor-nginx`(expose service via `ClusterIP` or `NodePort`) - -2) Export the secret as yaml file: - - - ```bash - kubectl get secret -o yaml > secret.yaml - ``` - - - -3) Rename the secret by setting `metadata.name` in `secret.yaml` - -4) Create a new secret: - - ```bash - kubectl create -f secret.yaml - ``` - -5) Configure the chart to use the new secret by setting `expose.tls.secretName` as the value you set in step **3** - -### 4. Upgrade - -Run upgrade command: - -```bash -helm upgrade release-name --force . -``` - -> The `--force` is necessary if upgrade from version 0.3.0 due to issue [#30](https://github.com/goharbor/harbor-helm/issues/30). - -## Known issues - -- The job logs will be lost if you upgrade from version 0.3.0 as the logs are store in a `emptyDir` in 0.3.0. - - ----------- - -[Back to table of contents](../index.md) \ No newline at end of file