> ## Documentation Index > Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Helm (v1.x) > Развертывание ClickStack с помощью inline-template Helm-чарта v1.x export const Image = ({img, alt, size}) => { return {alt} ; }; **Устарело — чарт v1.x** На этой странице описывается inline-template Helm-чарт **v1.x**, который поддерживается в режиме сопровождения и больше не будет получать новые возможности. Для новых развертываний используйте [чарт v2.x](/ru/clickstack/deployment/helm). Чтобы перенести существующее развертывание v1.x, см. [руководство по обновлению](/ru/clickstack/deployment/helm-upgrade). Helm-чарт для ClickStack доступен [здесь](https://github.com/ClickHouse/ClickStack-helm-charts) и является **рекомендуемым** способом развертывания в продакшн. По умолчанию Helm-чарт разворачивает все основные компоненты, включая: * **ClickHouse** * **HyperDX** * **коллектор OpenTelemetry (OTel)** * **MongoDB** (для постоянного хранения состояния приложения) Однако его можно легко настроить для интеграции с существующим развертыванием ClickHouse — например, размещённым в **ClickHouse Cloud**. Чарт поддерживает стандартные лучшие практики Kubernetes, включая: * Конфигурацию для конкретной среды через `values.yaml` * Ограничения ресурсов и масштабирование на уровне подов * Настройку TLS и входного шлюза * Управление секретами и настройку аутентификации
### Подходит для
* Пилотных проектов * Продакшн
## Этапы развертывания

### Предварительные требования * [Helm](https://helm.sh/) v3+ * Кластер Kubernetes (рекомендуется версия v1.20+) * `kubectl`, настроенный для работы с вашим кластером ### Добавьте репозиторий Helm ClickStack Добавьте репозиторий Helm ClickStack: ```shell theme={null} helm repo add clickstack https://clickhouse.github.io/ClickStack-helm-charts helm repo update ``` ### Установка ClickStack Чтобы установить чарт ClickStack со значениями по умолчанию: ```shell theme={null} helm install my-clickstack clickstack/clickstack ``` ### Проверьте установку Проверьте установку: ```shell theme={null} kubectl get pods -l "app.kubernetes.io/name=clickstack" ``` Когда все поды будут готовы, продолжайте. ### Проброс портов Проброс портов позволяет получить доступ к HyperDX и настроить его. Если вы разворачиваете систему в продакшн, вместо этого следует открыть доступ к сервису через входной шлюз или балансировщик нагрузки, чтобы обеспечить корректный сетевой доступ, терминацию TLS и масштабируемость. Проброс портов лучше всего подходит для локальной разработки или разовых административных задач, но не для долгосрочного использования или сред с высокой доступностью. ```shell theme={null} kubectl port-forward \ pod/$(kubectl get pod -l app.kubernetes.io/name=clickstack -o jsonpath='{.items[0].metadata.name}') \ 8080:3000 ``` **Настройка входного шлюза для продакшна** Для развертываний в продакшне настройте входной шлюз с использованием TLS вместо проброса портов. Подробные инструкции см. в [руководстве по настройке входного шлюза](/ru/clickstack/deployment/helm-configuration-v1#ingress-setup). ### Перейдите в интерфейс Перейдите по адресу [http://localhost:8080](http://localhost:8080), чтобы открыть интерфейс HyperDX. Создайте пользователя, указав имя пользователя и пароль, соответствующие требованиям. Интерфейс HyperDX После нажатия `Create` будут созданы источники данных для экземпляра ClickHouse, развернутого с помощью Helm-чарта. **Переопределение подключения по умолчанию** Вы можете переопределить подключение по умолчанию к интегрированному экземпляру ClickHouse. Подробнее см. в разделе ["Using ClickHouse Cloud"](#using-clickhouse-cloud). ### Настройка values (необязательно) Вы можете изменить параметры с помощью флагов `--set`. Например: ```shell theme={null} helm install my-clickstack clickstack/clickstack --set key=value ``` Либо измените `values.yaml`. Чтобы получить значения по умолчанию: ```shell theme={null} helm show values clickstack/clickstack > values.yaml ``` Пример конфигурации: ```yaml theme={null} replicaCount: 2 resources: limits: cpu: 500m memory: 512Mi requests: cpu: 250m memory: 256Mi ingress: enabled: true annotations: kubernetes.io/ingress.class: nginx hosts: - host: hyperdx.example.com paths: - path: / pathType: ImplementationSpecific ``` ```shell theme={null} helm install my-clickstack clickstack/clickstack -f values.yaml ``` ### Использование секретов (необязательно) Для работы с конфиденциальными данными, такими как ключ API или учетные данные базы данных, используйте секреты Kubernetes. Helm-чарты HyperDX содержат стандартные файлы секретов, которые можно изменить и применить в вашем кластере. #### Использование предварительно настроенных секретов Helm-чарт включает стандартный шаблон секрета, расположенный в [`charts/clickstack/templates/secrets.yaml`](https://github.com/ClickHouse/ClickStack-helm-charts/blob/main/charts/clickstack/templates/secrets.yaml). Этот файл служит базовой структурой для управления секретами. Если вам нужно применить секрет вручную, измените и примените предоставленный шаблон `secrets.yaml`: ```yaml theme={null} apiVersion: v1 kind: Secret metadata: name: hyperdx-secret annotations: "helm.sh/resource-policy": keep type: Opaque data: API_KEY: ``` Примените секрет к кластеру: ```shell theme={null} kubectl apply -f secrets.yaml ``` #### Создание пользовательского секрета При необходимости вы можете вручную создать пользовательский секрет Kubernetes: ```shell theme={null} kubectl create secret generic hyperdx-secret \ --from-literal=API_KEY=my-secret-api-key ``` #### Ссылка на секрет Чтобы сослаться на секрет в `values.yaml`: ```yaml theme={null} hyperdx: apiKey: valueFrom: secretKeyRef: name: hyperdx-secret key: API_KEY ``` **Управление API-ключами** Подробные инструкции по настройке API-ключей, включая несколько способов конфигурирования и процедуры перезапуска подов, см. в [руководстве по настройке API-ключей](/ru/clickstack/deployment/helm-configuration-v1#api-key-setup).
## Использование ClickHouse Cloud
Если вы используете ClickHouse Cloud, отключите экземпляр ClickHouse, развернутый с помощью Helm-чарта, и укажите учетные данные Cloud: ```shell theme={null} # указать учётные данные ClickHouse Cloud export CLICKHOUSE_URL= # полный https url export CLICKHOUSE_USER= export CLICKHOUSE_PASSWORD= # как переопределить подключение по умолчанию helm install my-clickstack clickstack/clickstack \ --set clickhouse.enabled=false \ --set clickhouse.persistence.enabled=false \ --set otel.clickhouseEndpoint=${CLICKHOUSE_URL} \ --set clickhouse.config.users.otelUser=${CLICKHOUSE_USER} \ --set clickhouse.config.users.otelUserPassword=${CLICKHOUSE_PASSWORD} ``` Либо используйте файл `values.yaml`: ```yaml theme={null} clickhouse: enabled: false persistence: enabled: false config: users: otelUser: ${CLICKHOUSE_USER} otelUserPassword: ${CLICKHOUSE_PASSWORD} otel: clickhouseEndpoint: ${CLICKHOUSE_URL} hyperdx: defaultConnections: | [ { "name": "External ClickHouse", "host": "http://your-clickhouse-server:8123", "port": 8123, "username": "your-username", "password": "your-password" } ] ``` ```shell theme={null} helm install my-clickstack clickstack/clickstack -f values.yaml # или если уже установлен... # helm upgrade my-clickstack clickstack/clickstack -f values.yaml ``` **Расширенные варианты внешней конфигурации** Для развертываний в продакшне с конфигурацией на основе secret, внешними коллекторами OTel или минимальными настройками см. [руководство по вариантам развертывания](/ru/clickstack/deployment/helm-deployment-options-v1).
## Примечания для продакшна
По умолчанию этот чарт также устанавливает ClickHouse и OTel collector. Однако для продакшна рекомендуется управлять ClickHouse и OTel collector отдельно. Чтобы отключить ClickHouse и OTel collector, задайте следующие значения: ```shell theme={null} helm install my-clickstack clickstack/clickstack \ --set clickhouse.enabled=false \ --set clickhouse.persistence.enabled=false \ --set otel.enabled=false ``` **Рекомендации для продакшна** Сведения о развертываниях для продакшна, включая настройку высокой доступности, управление ресурсами, настройку входного шлюза/TLS и параметры для Cloud-сред (GKE, EKS, AKS), см. в следующих разделах: * [Руководство по настройке](/ru/clickstack/deployment/helm-configuration-v1) - Входной шлюз, TLS и управление секретами * [Cloud-развертывания](/ru/clickstack/deployment/helm-cloud-v1) - Настройки для Cloud-сред и контрольный список для продакшна
## Конфигурация задач
По умолчанию в конфигурации chart предусмотрена одна задача в виде cronjob, которая проверяет, должны ли срабатывать оповещения. Ниже приведены её параметры конфигурации: | Параметр | Описание | По умолчанию | | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | `tasks.enabled` | Включить/отключить cron-задачи в кластере. По умолчанию образ HyperDX будет выполнять cron-задачи в этом процессе. Измените значение на true, если предпочитаете использовать отдельную cron-задачу в кластере. | `false` | | `tasks.checkAlerts.schedule` | Cron-расписание для задачи check-alerts | `*/1 * * * *` | | `tasks.checkAlerts.resources` | Запросы и лимиты ресурсов для задачи check-alerts | См. `values.yaml` |
## Обновление чарта
Чтобы обновить чарт до новой версии: ```shell theme={null} helm upgrade my-clickstack clickstack/clickstack -f values.yaml ``` Чтобы узнать доступные версии чарта: ```shell theme={null} helm search repo clickstack ``` **Обновление до v2.x** Если вы хотите перейти на чарт v2.x на базе субчартов, инструкции по миграции см. в [руководстве по обновлению](/ru/clickstack/deployment/helm-upgrade). Это несовместимое изменение — обновление `helm upgrade` на месте не поддерживается.
## Удаление ClickStack
Чтобы удалить развертывание: ```shell theme={null} helm uninstall my-clickstack ``` Это удалит все ресурсы, связанные с этим релизом, но постоянные данные (если они есть) могут остаться.
## Устранение неполадок
### Просмотр журналов
```shell theme={null} kubectl logs -l app.kubernetes.io/name=clickstack ```
### Диагностика сбоя при установке
```shell theme={null} helm install my-clickstack clickstack/clickstack --debug --dry-run ```
### Проверка развертывания
```shell theme={null} kubectl get pods -l app.kubernetes.io/name=clickstack ``` **Дополнительные материалы по устранению неполадок** Если у вас возникли проблемы, связанные с входным шлюзом, TLS или развертыванием в Cloud, см.: * [Устранение неполадок входного шлюза](/ru/clickstack/deployment/helm-configuration-v1#troubleshooting-ingress) - Отдача статических ресурсов, перезапись путей, проблемы в браузере * [Развертывания в Cloud](/ru/clickstack/deployment/helm-cloud-v1#loadbalancer-dns-resolution-issue) - Проблемы с GKE OpAMP и другие проблемы, связанные с Cloud
## Выбор схемы: Map или JSON
По умолчанию ClickStack хранит атрибуты в столбцах `Map(LowCardinality(String), String)`. Это рекомендуемая схема для рабочих нагрузок обсервабилити. В сочетании с [сериализацией Map по бакетам](/ru/reference/data-types/map#bucketed-map-serialization) и текстовыми индексами по ключам и значениям в Map она обеспечивает точечные lookup-операции без накладных расходов на приём для каждого ключа, характерных для динамических подстолбцов JSON. Схема с типом `JSON` доступна в статусе бета для оценки на рабочих нагрузках с небольшим стабильным набором ключей атрибутов. Использовать её **по умолчанию не рекомендуется**. Полное сравнение и переменные окружения, необходимые для включения поддержки JSON, см. в разделе [Map vs JSON type](/ru/clickstack/ingesting-data/schema/map-vs-json).
### Руководства по развертыванию v1.x
* [Варианты развертывания (v1.x)](/ru/clickstack/deployment/helm-deployment-options-v1) - внешний ClickHouse, OTel collector и минимальные развертывания * [Руководство по настройке (v1.x)](/ru/clickstack/deployment/helm-configuration-v1) - ключи API, секреты и настройка входного шлюза * [Развертывания в Cloud (v1.x)](/ru/clickstack/deployment/helm-cloud-v1) - конфигурации GKE, EKS, AKS и рекомендации для продакшна
### Документация по v2.x
* [Helm (v2.x)](/ru/clickstack/deployment/helm) - руководство по развертыванию v2.x * [Руководство по обновлению](/ru/clickstack/deployment/helm-upgrade) - переход с v1.x на v2.x
### Дополнительные ресурсы
* [Руководство «Начало работы» для ClickStack](/ru/clickstack/getting-started) - Введение в ClickStack * [Репозиторий Helm-чартов ClickStack](https://github.com/ClickHouse/ClickStack-helm-charts) - Исходный код чартов и справочник по values * [Документация Kubernetes](https://kubernetes.io/docs/) - Справочник по Kubernetes * [Документация Helm](https://helm.sh/docs/) - Справочник по Helm