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

feat/ODM-11788 Update deployment documentation #52

Merged
Merged
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
26 changes: 25 additions & 1 deletion docs/home/release-notes/v1.50-v1.59.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -24,6 +24,30 @@ 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. Proceed with the [odm](../helm/how-to-deploy.md#deployment-process) installation, take itnto account:

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.

c. Resources path in values for old clickhouse is `clickhouse.resources` for the new one `altinity.clickhouse.installation.spec.templates.podTemplate.spec.mainContainer.resources`

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`

2. A job named `odm-clickhouse-helper` will appear in Kubernetes, and it will handle the migration.

a. It's an expected behaviour to have some failed pods during this job running.

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`.

4. Update ODM one last time with `helm upgrade ...`. This will disable the old ClickHouse.

### 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.
Expand Down