Files
tf_provider/docs/30_registry/resources/akhq_man.md
T
2026-06-30 15:45:24 +04:00

3.7 KiB

MAN: akhq

Инструкция по развертыванию Apache Kafka через платформу

---
## 1. Общая информация
AKHQ — это веб-интерфейс для работы с кластерами Apache Kafka.
Позволяет просматривать топики, consumer group'ы, сообщения, ACL, схему безопасности, состояние брокеров и метаданные.
Поддерживает работу с несколькими кластерами Kafka одновременно, включая внутренние и внешние (TLS) подключения.

## Доступные операции
- create — Создание ресурса AKHQ
- suspend — Остановка ресурса
- resume — Возобновление работы ресурса
- modify — Модификация настроек
- delete — Удаление ресурса

---
## 2. Параметры развертывания кластера
Ниже перечислены параметры, которые необходимо указать при создании ресурса Kafka:

* Кластер Kafka к которому нужно настроить подключение
Для использования AKHQ необходимо предварительно развернуть сервис Kafka. Пример: kafka-external.

* Платформа для развертывания:
Платформа для развертывания (среда, в которой будет развернут кластер). Пример: k8s-3.ext.nubes.ru.

* Количество узлов в сети:
Количество узлов для работы Akhq. Пример 2

* Квота (megabyte) памяти пода:
Квота памяти пода в мегабайтах. Пример: 512

* Квота (millicore ) ядра пода:
Квота CPU пода в миликорах (1000 mCPU = 1 vCPU). Пример: 500

* Имя домена:
Dns Имя по которому будет происходить обращение к сервису. Указать необходимо уникальное имя до . ( то есть если необходимо получить dns ui) Пример: kafka-external

---
## 4. Выходные параметры
После успешного развертывания ресурса Kafka платформа возвращает ряд параметров.
Ключевым из них является:

connectionUrl
Это полное доменное имя (FQDN), по которому будет доступен интерфейс AKHQ. После развёртывания подождите несколько минут — UI станет доступен по HTTPS, как только все сервисы полностью запустятся.

Учетные данные
Здесь представлены поля для ввода логина и пароля, с помощью которых вы сможете авторизоваться в сервисе.

---
## 5. Дополнительная информация
Учётные записи, созданные для работы с AKHQ, предоставляют доступ только для просмотра данных. Для управления Kafka, пожалуйста, используйте возможности личного кабинета.
---