From 4bc819aeba163941a4b68f71d2c06c951338b106 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Mon, 10 Mar 2025 11:14:10 +0100 Subject: [PATCH] update docs for odm-ops --- docs/home/helm/how-to-deploy.md | 22 ++++++++++++++++++++-- docs/home/requirements/hardware.md | 4 +++- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/docs/home/helm/how-to-deploy.md b/docs/home/helm/how-to-deploy.md index 7ef07493..e214299d 100644 --- a/docs/home/helm/how-to-deploy.md +++ b/docs/home/helm/how-to-deploy.md @@ -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. diff --git a/docs/home/requirements/hardware.md b/docs/home/requirements/hardware.md index d04517ae..00bb53ea 100644 --- a/docs/home/requirements/hardware.md +++ b/docs/home/requirements/hardware.md @@ -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).