Skip to content

update docs for odm-ops #111

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.

Sign up for GitHub

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

Merged
tropnikovvl merged 1 commit into from
Mar 10, 2025
Merged

update docs for odm-ops #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 20 additions & 2 deletions docs/home/helm/how-to-deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,30 @@

- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) for getting permissions to download Helm chart

## Deployment Requirements

- To deploy ODM `StorageClass` and `IngressClass` have to be configured in Kubernetes Cluster.

- To deploy an `ODM-OPS` helm chart, you must have administrator rights in the Kubernetes cluster.

- `ODM-OPS` must be installed before starting ODM updates every time.

- `ODM-OPS` must be 1 per Kubernetes cluster.

- To deploy ODM, you need administrator rights in the `ODM` namespace; in addition to standard entities, these will be used:

- `clickhouseinstallations` API group `clickhouse.altinity.com`

- `clickhouseinstallationtemplates` API group `clickhouse.altinity.com`

- `clickhousekeeperinstallations` API group `clickhouse-keeper.altinity.com`

- `clickhouseoperatorconfigurations` API group `clickhouse.altinity.com`

## Deployment Information

- All main ODM settings are presented in the Deployment Helm Chart.

- To deploy ODM `StorageClass` and `IngressClass` have to be configured in Kubernetes Cluster.

- To enable automatic metrics collection when using Prometheus Operator, configure the `serviceMonitor` parameter in the Helm Chart.

- We provide a tool that automates the process of updating credentials for [ECR](https://aws.amazon.com/ecr/), where our container images are hosted.
Expand Down
4 changes: 3 additions & 1 deletion docs/home/requirements/hardware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Hardware

- We recommend allocating 16 cores 128GB of memory for production environments.
- We recommend allocating 16 cores 96GB of memory for production environments.
- It is necessary to provide multiple disks for databases and internal services. You can use any solution that works with Kubernetes (AWS EBS, Azure Disks, etc.). An important note: for optimal performance, we strongly recommend using SSDs.
- It is strongly recommended **not to use** NFS as a database storage.
- The operating system can be any distribution of Linux (Ubuntu, CentOS, RedHat, Amazon Linux, etc). Preferably, use the latest versions.
- Linux kernel must be newer than version 3.15.
- The container runtime processor architecture must be [x86-64](https://en.wikipedia.org/wiki/X86-64).