From 1025ee099935dbd045583ab5590a3be1740c196f Mon Sep 17 00:00:00 2001 From: Keyvan Date: Tue, 5 Nov 2024 14:38:15 +0100 Subject: [PATCH] Updated upgrade doc headers --- docs/upgrade.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/upgrade.md b/docs/upgrade.md index 1593270d..29968e39 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -1,4 +1,4 @@ -## Upgrade instructions +# Upgrade instructions Run the following instructions to upgrade an existing RADAR-Kubernetes cluster. @@ -6,9 +6,9 @@ Run the following instructions to upgrade an existing RADAR-Kubernetes cluster. | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Upgrading the major version of a PostgreSQL image is not supported. If necessary, we propose to use a `pg_dump` to dump the current data and a `pg_restore` to restore that data on a newer version. Please find instructions for this elsewhere. | -### Upgrade to RADAR-Kubernetes version 1.2 +## Upgrade to RADAR-Kubernetes version 1.2 -#### KSQL S erver and JDBC Connector service configuration +### KSQL Server and JDBC Connector service configuration In `production.yaml` rename sections: | Old Name | New Name | @@ -16,21 +16,21 @@ In `production.yaml` rename sections: | radar_jdbc_connector | radar_jdbc_connector_grafana | | radar_jdbc_connector_agg | radar_jdbc_connector_realtime_dashboard | -#### Data dashboard backend secret +### Data dashboard backend secret You need to manually create this field in your secrets file: `management_portal.oauth_clients.radar_data_dashboard_backend.client_secret`. If you're not using data dashboard backend you can put `null` in the value, otherwise make sure to generate a random secret and put it in that field. -#### MongoDB +### MongoDB MongoDB has been updated to a new version and it's not compatible with the current version that has been installed in the cluster. There are two pathes forward: - Deleting the MongoDB and its volumes and then installing it and configuring Graylog again. This is the recommeneded approach since usually there is no important data is stored in MongoDB and the Graylog stack will be replaced in the next release. - Upgrading MongoDB cluster. If you have configured Graylog significantly, then it might be better to upgrade the MongoDB instead of reinstalling it. Options are: - Manually exporting the databases and doing a clean reinstall as stated in the last step and the importing the data again. - Following official MongoDB upgrade instructions for version [5.0](https://www.mongodb.com/docs/manual/release-notes/5.0-upgrade-replica-set/), [6.0](https://www.mongodb.com/docs/manual/release-notes/6.0-upgrade-replica-set/) and [7.0](https://www.mongodb.com/docs/manual/release-notes/7.0-upgrade-replica-set/). -### Upgrade to RADAR-Kubernetes version 1.1.x +## Upgrade to RADAR-Kubernetes version 1.1.x Before running the upgrade make sure to copy `environments.yaml.tmpl` to `environments.yaml` and if you've previously changed `environments.yaml` apply the changes again. This is necessary due to addition of `helmDefaults` and `repositories` configurations to this file. -### Upgrade to RADAR-Kubernetes version 1.0.0 +## Upgrade to RADAR-Kubernetes version 1.0.0 Before running the upgrade, compare `etc/base.yaml` and `etc/base.yaml.gotmpl` with their `production.yaml` counterparts. Please ensure that all properties in `etc/base.yaml` are overridden in your `production.yaml` or that the `base.yaml` default value is fine, in which case no value needs to be provided in `production.yaml`.