From d0d77faf6eada4e6856fbbf472c9dbc23b94f014 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Mon, 12 Aug 2024 17:54:27 +0200 Subject: [PATCH 1/5] feat/ODM-11788 Update deployment documentation --- docs/home/release-notes/v1.50-v1.59.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/home/release-notes/v1.50-v1.59.md b/docs/home/release-notes/v1.50-v1.59.md index af49533..ad8f8a3 100644 --- a/docs/home/release-notes/v1.50-v1.59.md +++ b/docs/home/release-notes/v1.50-v1.59.md @@ -7,7 +7,7 @@ This version must be installed before proceeding with the next update. !!! tip "" - Helm chart version 1.x.x + Helm chart version 1.58.0 ### Clickhouse migration @@ -24,6 +24,26 @@ Things that you have keep in mind before upgrading process: - Optional: We've developed [a tool that checks consistency of data](../troubleshooting/sanity-check.md), you could use it before and after the upgrading process and compare results of those checks just to be sure that everything went as expected +#### Following steps + + 1. Install the [odm-ops](../helm/how-to-deploy.md#deployment-process) helm chart, it will install the Altinity ClickHouse operator with pre-configured settings. + + 2. Copy the parameters **you use** from ClickHouse to Altinity ClickHouse (requests, limits, disk size +25%, etc.). You can refer to the example `migrate-clickhouse-to-clickhouse-cluster.yaml`. + + 3. Start the ODM update with `helm upgrade ...`. + + 4. A job named `odm-clickhouse-helper` will appear in Kubernetes, and it will handle the migration. + + 5. During the ClickHouse migration, ODM will continue to operate, but all writes to ClickHouse will be blocked. + + 6. Wait until the `odm-clickhouse-helper` job completes, indicating that the migration is done. + + 7. Verify the data in ODM. + + 8. Disable `clickhouse` and `clickhouseMigration` in Helm values. You can refer to the example `disable-old-clickhouse-after-upgrade.yaml`. + + 9. Update ODM one last time with `helm upgrade ...`. + ### Helm examples changes - New examples for different ODM configuration options have been added to the `examples` helm chart directory, and all old ones have been updated. From 1c7fac488758b3ca57315b5be50c41e2f57c88ac Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Mon, 12 Aug 2024 17:56:02 +0200 Subject: [PATCH 2/5] upd --- docs/home/release-notes/v1.50-v1.59.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/release-notes/v1.50-v1.59.md b/docs/home/release-notes/v1.50-v1.59.md index ad8f8a3..1599911 100644 --- a/docs/home/release-notes/v1.50-v1.59.md +++ b/docs/home/release-notes/v1.50-v1.59.md @@ -42,7 +42,7 @@ Things that you have keep in mind before upgrading process: 8. Disable `clickhouse` and `clickhouseMigration` in Helm values. You can refer to the example `disable-old-clickhouse-after-upgrade.yaml`. - 9. Update ODM one last time with `helm upgrade ...`. + 9. Update ODM one last time with `helm upgrade ...`. This will disable the old ClickHouse. ### Helm examples changes From 408fcf68cdf077e77dfc1adf61f0075250f5e75d Mon Sep 17 00:00:00 2001 From: Oleg Kunitsyn Date: Wed, 14 Aug 2024 15:51:09 +0200 Subject: [PATCH 3/5] [ODM-11788] Update doc --- docs/home/release-notes/v1.50-v1.59.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/home/release-notes/v1.50-v1.59.md b/docs/home/release-notes/v1.50-v1.59.md index 1599911..feee8a2 100644 --- a/docs/home/release-notes/v1.50-v1.59.md +++ b/docs/home/release-notes/v1.50-v1.59.md @@ -26,23 +26,25 @@ Things that you have keep in mind before upgrading process: #### Following steps - 1. Install the [odm-ops](../helm/how-to-deploy.md#deployment-process) helm chart, it will install the Altinity ClickHouse operator with pre-configured settings. + 1. Proceed with the [odm](../helm/how-to-deploy.md#deployment-process) installation, take itnto account: - 2. Copy the parameters **you use** from ClickHouse to Altinity ClickHouse (requests, limits, disk size +25%, etc.). You can refer to the example `migrate-clickhouse-to-clickhouse-cluster.yaml`. + a. `odm-ops` chart will install the Altinity ClickHouse operator with pre-configured settings, - 3. Start the ODM update with `helm upgrade ...`. + b. In your custom values for `odm` chart adjust parameters for ClickHouse and Altinity ClickHouse (requests, limits, disk size +25%, etc.). We suggest to temporary increase resources for both of Clickhouses since it will reduce timing for migration. - 4. A job named `odm-clickhouse-helper` will appear in Kubernetes, and it will handle the migration. + c. Resources path in values for old clickhouse is `clickhouse.resources` for the new one `altinity.clickhouse.installation.spec.templates.podTemplate.spec.mainContainer.resources` - 5. During the ClickHouse migration, ODM will continue to operate, but all writes to ClickHouse will be blocked. + d. Persistance size path for old clickhouse is `clickhouse.persistence.size` for the new one `altinity.clickhouse.installation.spec.templates.volumeClaimTemplate.spec.resources.requests.storage` - 6. Wait until the `odm-clickhouse-helper` job completes, indicating that the migration is done. + 2. A job named `odm-clickhouse-helper` will appear in Kubernetes, and it will handle the migration. - 7. Verify the data in ODM. + a. During the ClickHouse migration, ODM will continue to operate, but all writes to ClickHouse will be queued. + + b. Wait until the `odm-clickhouse-helper` job completes, indicating that the migration is done. - 8. Disable `clickhouse` and `clickhouseMigration` in Helm values. You can refer to the example `disable-old-clickhouse-after-upgrade.yaml`. + 3. Disable `clickhouse` and `clickhouseHelper` in Helm values. You can refer to the example `disable-old-clickhouse-after-upgrade.yaml`. - 9. Update ODM one last time with `helm upgrade ...`. This will disable the old ClickHouse. + 4. Update ODM one last time with `helm upgrade ...`. This will disable the old ClickHouse. ### Helm examples changes From a9e720fbb1ee6de20f34064d7f78ead103a54650 Mon Sep 17 00:00:00 2001 From: Oleg Kunitsyn Date: Wed, 14 Aug 2024 15:56:54 +0200 Subject: [PATCH 4/5] [ODM-11788] Update doc again --- docs/home/release-notes/v1.50-v1.59.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/home/release-notes/v1.50-v1.59.md b/docs/home/release-notes/v1.50-v1.59.md index feee8a2..003c983 100644 --- a/docs/home/release-notes/v1.50-v1.59.md +++ b/docs/home/release-notes/v1.50-v1.59.md @@ -38,9 +38,11 @@ Things that you have keep in mind before upgrading process: 2. A job named `odm-clickhouse-helper` will appear in Kubernetes, and it will handle the migration. - a. During the ClickHouse migration, ODM will continue to operate, but all writes to ClickHouse will be queued. + a. It's an expected behaviour to have some failed pods during this job running. - b. Wait until the `odm-clickhouse-helper` job completes, indicating that the migration is done. + b. During the ClickHouse migration, ODM will continue to operate, but all writes to ClickHouse will be queued. + + c. Wait until the `odm-clickhouse-helper` job completes, indicating that the migration is done. 3. Disable `clickhouse` and `clickhouseHelper` in Helm values. You can refer to the example `disable-old-clickhouse-after-upgrade.yaml`. From 4d045c4751dc89021b0e018549d91e6b41b90221 Mon Sep 17 00:00:00 2001 From: Oleg Kunitsyn Date: Wed, 14 Aug 2024 16:30:16 +0200 Subject: [PATCH 5/5] [ODM-11788] Pre-commit --- docs/home/release-notes/v1.50-v1.59.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/release-notes/v1.50-v1.59.md b/docs/home/release-notes/v1.50-v1.59.md index 003c983..58d1b10 100644 --- a/docs/home/release-notes/v1.50-v1.59.md +++ b/docs/home/release-notes/v1.50-v1.59.md @@ -30,7 +30,7 @@ Things that you have keep in mind before upgrading process: a. `odm-ops` chart will install the Altinity ClickHouse operator with pre-configured settings, - b. In your custom values for `odm` chart adjust parameters for ClickHouse and Altinity ClickHouse (requests, limits, disk size +25%, etc.). We suggest to temporary increase resources for both of Clickhouses since it will reduce timing for migration. + b. In your custom values for `odm` chart adjust parameters for ClickHouse and Altinity ClickHouse (requests, limits, disk size +25%, etc.). We suggest to temporary increase resources for both of Clickhouses since it will reduce timing for migration. c. Resources path in values for old clickhouse is `clickhouse.resources` for the new one `altinity.clickhouse.installation.spec.templates.podTemplate.spec.mainContainer.resources`