{"queryDurationMs":46,"svc":{"svcId":116,"svc":"ApacheKafka","svcShort":"kafka","code":null,"version":"0.0.2","orchestratorName":"Kafka","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/create/view/tags/job/0.0.2/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Сервис создания кластера Apache Kafka","man":"# Инструкция по развертыванию Организация в Cloud Director через платформу
## 1. Общая информация
Сервис **Организация в Cloud Director** предназначен для управления изолированными организационными единицами (тенантами) внутри инфраструктуры Cloud Director. Он обеспечивает создание, модификацию и администрирование организаций, предоставление им облачных ресурсов, а также контроль уровня доступа. Сервис используется для организации рабочих окружений потребителей, управления жизненным циклом организаций и их сетевой инфраструктурой.
### Доступные операции
**create** — Создание новой организации с заданными характеристиками и типом доступа.
**delete** — Удаление организации после перехода в состояние suspend; приводит к удалению всех связанных сущностей.
**modify** — Изменение параметров внутри организации (на текущий момент поддерживается изменение ipSpaces).
**suspend** — Заморозка организации, ограничение возможности изменения и добавления сущностей.
**resume** — Разморозка организации, восстановление функций управления.
---
## 2. Параметры развертывания
Параметры входных данных операции **create**:
### Платформа для развертывания
Описание: платформа, на которой будет создана организация.
Пример значения: `ngcloud.ru`.
### Тип организации
Описание: тип создаваемой организации.
Варианты:
- `iaas` — организация с прямым доступом к облаку и авторизацией через Keycloak.
- `saas` — организация под управлением Nubes, без прямого доступа к облаку.
---
## 3. Рекомендованные характеристики
### Тестовое окружение
- Тип организации: `iaas` для обеспечения полного доступа к облачным ресурсам и самостоятельного управления.
### Промышленное окружение
- Тип организации: `saas` (упрощённая модель использования).
---
## 4. Выходные параметры
Услуга предоставляет следующие выходные параметры (формируются в процессе операций):
### Идентификатор организации
Уникальный идентификатор созданной организации. Используется для всех дальнейших API-операций.
### Статус организации
Отражает текущее состояние: active, suspended, modifying, deleting.
### Параметры сети
Выходные данные при наличии ipSpaces: список выделенных внешних IP, имя ip_space, количество IP.
---
## 5. Дополнительная информация
- Для конфигурации внешних IP внутри организации необходимо предварительно создать:
-- хотя бы один **Виртуальный датацентр (VDC)**;
-- хотя бы один **Сетевой шлюз периметра (Edge Gateway)**, привязанный к этой организации.
- Удаление организации возможно только через 14 дней после перевода в состояние suspend.
- Удаление организации приводит к удалению всех связанных сущностей: VDC, Edge Gateway, пулов IP, сетей, ВМок и иных объектов.
- Операция suspend не останавливает виртуальные машины, но блокирует любые изменения инфраструктуры внутри организации.
- Для iaas-организаций доступ осуществляется через Keycloak.
","operations":[{"svcOperationId":149,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/delete/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":null},{"svcOperationId":167,"operation":"delete_topic","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/delete_topic/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":null},{"svcOperationId":161,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/resume/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":null},{"svcOperationId":168,"operation":"create_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/create_user/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":"# Инструкция по управлению пользователями Apache Kafka.
---
## 1. Общая информация
Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру.
Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам.
Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka.
---
## Доступные операции
- **create_user** — Создание пользователя
- **modify_user** — Модификация пользователя
- **delete_user** — Удаление пользователя
---
## 2. Параметры создания пользователя
Ниже перечислены параметры, которые необходимо указать при создании нового пользователя:
* **Имя пользователя**
Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.
Пример: `username-admin`
* **Топик**
Название топика, к которому будут назначены права для данного пользователя.
Пример: `orders-events`.
Использовать маску нельзя (`orders*`), только полное название или `*`.
* **Операции**
Список разрешённых операций на указанном топике.
Пример: `Describe, Read, Write`
* **Группа**
Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.
Пример: `order-consumers`.
* **Разрешённые хосты**
Список хостов или подсетей, с которых разрешено подключение пользователя.
Пример: `192.168.1.0/24` или `*`.
---
## 3. Параметры модификации пользователя
Ниже перечислены параметры, которые необходимо указать при модификации пользователя:
* **Имя пользователя**
Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.
Пример: `username-admin`
* **Топик**
Название топика, к которому будут назначены права для данного пользователя.
Пример: `orders-events`.
Использовать маску нельзя (`orders*`), только полное название или `*`.
* **Операции**
Список разрешённых операций на указанном топике.
Пример: `Describe, Read, Write`
* **Группа**
Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.
Пример: `order-consumers`.
* **Разрешённые хосты**
Список хостов или подсетей, с которых разрешено подключение пользователя.
Пример: `192.168.1.0/24` или `*`.
---
## 4. Параметры удалении пользователя
Ниже перечислены параметры, которые необходимо указать при удалении пользователя:
* **Имя пользователя**
Имя удаляемого пользователя.
Пример: `username-admin`
## 5. Выходные параметры
После успешного создания пользователя платформа возвращает параметры, необходимые для подключения:
* **ca.crt**
Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении.
Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.crt
```
* **ca.p12**
PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.p12
```
* **ca.password**
Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно.
* **user.crt**
Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka.
Используется совместно с приватным ключом `user.key` для аутентификации.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.crt
```
* **user.key**
Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.key
```
* **user.p12**
PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo "<содержание поля>" | base64 -d > <название>.p12
```
* **user.password**
Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно.
Эти параметры используются для настройки TLS-подключения.
---
## 6. Пример конфигурации клиента внутри кластера
Пример пода:
```yaml
apiVersion: v1
kind: Pod
metadata:
name: kafka-4
spec:
volumes:
- name: work
emptyDir: {}
containers:
- name: kcat
image: quay.io/strimzi/kafka:latest-kafka-4.0.0
command: ["sleep", "5600"]
volumeMounts:
- name: work
mountPath: /work
restartPolicy: Never
```
Создаём под и сохраняем сертификаты:
```bash
kubectl cp user.p12 kafka-4:/work/
kubectl cp ca.p12 kafka-4:/work/
```
Создаём файлы конфигурации:
```bash
cat > /work/user-read.properties <<'EOF'
security.protocol=SSL
ssl.keystore.type=PKCS12
ssl.keystore.location=/work/user.p12
ssl.keystore.password=<user.password>
ssl.truststore.type=PKCS12
ssl.truststore.location=/work/ca.p12
ssl.truststore.password=<ca.password>
EOF
```
```bash
cat > /work/user-write.properties <<'EOF'
security.protocol=SSL
ssl.keystore.type=PKCS12
ssl.keystore.location=/work/user-write.p12
ssl.keystore.password=<user.password>
ssl.truststore.type=PKCS12
ssl.truststore.location=/work/ca.p12
ssl.truststore.password=<ca.password>
EOF
```
Листинг доступных топиков:
```bash
/opt/kafka/bin/kafka-topics.sh \\
--bootstrap-server kafkak8s-bootstrap-external:9093 \\
--command-config /work/user-read.properties \\
--list
```
Запись сообщений:
```bash
/opt/kafka/bin/kafka-console-producer.sh \\
--bootstrap-server <адрес сервис брокера>:9093 \\
--topic <topic> \\
--producer.config /work/user-write.properties
```
Чтение сообщений:
```bash
/opt/kafka/bin/kafka-console-consumer.sh \\
--bootstrap-server <адрес сервис брокера>:9093 \\
--topic <topic> \\
--from-beginning \\
--group <group> \\
--consumer.config /work/user-read.properties \\
--max-messages 50
```
---
## 7. Пример внешнего подключения с использованием **kcat**
**Листинг топиков**
```bash
kcat -b <externalConnect.bootstrap.fqdn>:9093 \\
-L \\
-X security.protocol=SSL \\
-X ssl.ca.location=./ca.crt \\
-X ssl.certificate.location=./user-read.crt \\
-X ssl.key.location=./user-read.key \\
-X ssl.endpoint.identification.algorithm=none
```
**Запись сообщения**
```bash
echo "hello from kcat" | kcat -P \\
-b <externalConnect.bootstrap.fqdn>:9093 \\
-t write-test \\
-X security.protocol=SSL \\
-X ssl.ca.location=./ca.crt \\
-X ssl.certificate.location=./user-write.crt \\
-X ssl.key.location=./user-write.key \\
-X ssl.endpoint.identification.algorithm=none
```
**Чтение сообщений**
```bash
kcat -C \\
-b <externalConnect.bootstrap.fqdn>:9093 \\
-t write-test \\
-o beginning \\
-q \\
-X security.protocol=SSL \\
-X ssl.ca.location=./ca.crt \\
-X ssl.certificate.location=./user-read.crt \\
-X ssl.key.location=./user-read.key \\
-X ssl.endpoint.identification.algorithm=none
```
---
## 9. Рекомендации
* Минимизируйте набор разрешённых операций для повышения безопасности.
* Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов.
* Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**.
* После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам.
---"},{"svcOperationId":170,"operation":"delete_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/delete_user/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":"# Инструкция по управлению пользователями Apache Kafka.
---
## 1. Общая информация
Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру.
Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам.
Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka.
---
## Доступные операции
- **create_user** — Создание пользователя
- **modify_user** — Модификация пользователя
- **delete_user** — Удаление пользователя
---
## 2. Параметры создания пользователя
Ниже перечислены параметры, которые необходимо указать при создании нового пользователя:
* **Имя пользователя**
Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.
Пример: `username-admin`
* **Топик**
Название топика, к которому будут назначены права для данного пользователя.
Пример: `orders-events`.
Использовать маску нельзя (`orders*`), только полное название или `*`.
* **Операции**
Список разрешённых операций на указанном топике.
Пример: `Describe, Read, Write`
* **Группа**
Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.
Пример: `order-consumers`.
* **Разрешённые хосты**
Список хостов или подсетей, с которых разрешено подключение пользователя.
Пример: `192.168.1.0/24` или `*`.
---
## 3. Параметры модификации пользователя
Ниже перечислены параметры, которые необходимо указать при модификации пользователя:
* **Имя пользователя**
Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.
Пример: `username-admin`
* **Топик**
Название топика, к которому будут назначены права для данного пользователя.
Пример: `orders-events`.
Использовать маску нельзя (`orders*`), только полное название или `*`.
* **Операции**
Список разрешённых операций на указанном топике.
Пример: `Describe, Read, Write`
* **Группа**
Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.
Пример: `order-consumers`.
* **Разрешённые хосты**
Список хостов или подсетей, с которых разрешено подключение пользователя.
Пример: `192.168.1.0/24` или `*`.
---
## 4. Параметры удалении пользователя
Ниже перечислены параметры, которые необходимо указать при удалении пользователя:
* **Имя пользователя**
Имя удаляемого пользователя.
Пример: `username-admin`
## 5. Выходные параметры
После успешного создания пользователя платформа возвращает параметры, необходимые для подключения:
* **ca.crt**
Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении.
Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.crt
```
* **ca.p12**
PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.p12
```
* **ca.password**
Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно.
* **user.crt**
Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka.
Используется совместно с приватным ключом `user.key` для аутентификации.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.crt
```
* **user.key**
Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.key
```
* **user.p12**
PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo "<содержание поля>" | base64 -d > <название>.p12
```
* **user.password**
Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно.
Эти параметры используются для настройки TLS-подключения.
---
## 6. Пример конфигурации клиента внутри кластера
Пример пода:
```yaml
apiVersion: v1
kind: Pod
metadata:
name: kafka-4
spec:
volumes:
- name: work
emptyDir: {}
containers:
- name: kcat
image: quay.io/strimzi/kafka:latest-kafka-4.0.0
command: ["sleep", "5600"]
volumeMounts:
- name: work
mountPath: /work
restartPolicy: Never
```
Создаём под и сохраняем сертификаты:
```bash
kubectl cp user.p12 kafka-4:/work/
kubectl cp ca.p12 kafka-4:/work/
```
Создаём файлы конфигурации:
```bash
cat > /work/user-read.properties <<'EOF'
security.protocol=SSL
ssl.keystore.type=PKCS12
ssl.keystore.location=/work/user.p12
ssl.keystore.password=<user.password>
ssl.truststore.type=PKCS12
ssl.truststore.location=/work/ca.p12
ssl.truststore.password=<ca.password>
EOF
```
```bash
cat > /work/user-write.properties <<'EOF'
security.protocol=SSL
ssl.keystore.type=PKCS12
ssl.keystore.location=/work/user-write.p12
ssl.keystore.password=<user.password>
ssl.truststore.type=PKCS12
ssl.truststore.location=/work/ca.p12
ssl.truststore.password=<ca.password>
EOF
```
Листинг доступных топиков:
```bash
/opt/kafka/bin/kafka-topics.sh \\
--bootstrap-server kafkak8s-bootstrap-external:9093 \\
--command-config /work/user-read.properties \\
--list
```
Запись сообщений:
```bash
/opt/kafka/bin/kafka-console-producer.sh \\
--bootstrap-server <адрес сервис брокера>:9093 \\
--topic <topic> \\
--producer.config /work/user-write.properties
```
Чтение сообщений:
```bash
/opt/kafka/bin/kafka-console-consumer.sh \\
--bootstrap-server <адрес сервис брокера>:9093 \\
--topic <topic> \\
--from-beginning \\
--group <group> \\
--consumer.config /work/user-read.properties \\
--max-messages 50
```
---
## 7. Пример внешнего подключения с использованием **kcat**
**Листинг топиков**
```bash
kcat -b <externalConnect.bootstrap.fqdn>:9093 \\
-L \\
-X security.protocol=SSL \\
-X ssl.ca.location=./ca.crt \\
-X ssl.certificate.location=./user-read.crt \\
-X ssl.key.location=./user-read.key \\
-X ssl.endpoint.identification.algorithm=none
```
**Запись сообщения**
```bash
echo "hello from kcat" | kcat -P \\
-b <externalConnect.bootstrap.fqdn>:9093 \\
-t write-test \\
-X security.protocol=SSL \\
-X ssl.ca.location=./ca.crt \\
-X ssl.certificate.location=./user-write.crt \\
-X ssl.key.location=./user-write.key \\
-X ssl.endpoint.identification.algorithm=none
```
**Чтение сообщений**
```bash
kcat -C \\
-b <externalConnect.bootstrap.fqdn>:9093 \\
-t write-test \\
-o beginning \\
-q \\
-X security.protocol=SSL \\
-X ssl.ca.location=./ca.crt \\
-X ssl.certificate.location=./user-read.crt \\
-X ssl.key.location=./user-read.key \\
-X ssl.endpoint.identification.algorithm=none
```
---
## 9. Рекомендации
* Минимизируйте набор разрешённых операций для повышения безопасности.
* Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов.
* Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**.
* После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам.
---"},{"svcOperationId":160,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/suspend/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":null},{"svcOperationId":162,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/modify/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":null},{"svcOperationId":169,"operation":"modify_user","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/modify_user/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":"# Инструкция по управлению пользователями Apache Kafka.
---
## 1. Общая информация
Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру.
Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам.
Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka.
---
## Доступные операции
- **create_user** — Создание пользователя
- **modify_user** — Модификация пользователя
- **delete_user** — Удаление пользователя
---
## 2. Параметры создания пользователя
Ниже перечислены параметры, которые необходимо указать при создании нового пользователя:
* **Имя пользователя**
Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.
Пример: `username-admin`
* **Топик**
Название топика, к которому будут назначены права для данного пользователя.
Пример: `orders-events`.
Использовать маску нельзя (`orders*`), только полное название или `*`.
* **Операции**
Список разрешённых операций на указанном топике.
Пример: `Describe, Read, Write`
* **Группа**
Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.
Пример: `order-consumers`.
* **Разрешённые хосты**
Список хостов или подсетей, с которых разрешено подключение пользователя.
Пример: `192.168.1.0/24` или `*`.
---
## 3. Параметры модификации пользователя
Ниже перечислены параметры, которые необходимо указать при модификации пользователя:
* **Имя пользователя**
Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.
Пример: `username-admin`
* **Топик**
Название топика, к которому будут назначены права для данного пользователя.
Пример: `orders-events`.
Использовать маску нельзя (`orders*`), только полное название или `*`.
* **Операции**
Список разрешённых операций на указанном топике.
Пример: `Describe, Read, Write`
* **Группа**
Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.
Пример: `order-consumers`.
* **Разрешённые хосты**
Список хостов или подсетей, с которых разрешено подключение пользователя.
Пример: `192.168.1.0/24` или `*`.
---
## 4. Параметры удалении пользователя
Ниже перечислены параметры, которые необходимо указать при удалении пользователя:
* **Имя пользователя**
Имя удаляемого пользователя.
Пример: `username-admin`
## 5. Выходные параметры
После успешного создания пользователя платформа возвращает параметры, необходимые для подключения:
* **ca.crt**
Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении.
Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.crt
```
* **ca.p12**
PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.p12
```
* **ca.password**
Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно.
* **user.crt**
Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka.
Используется совместно с приватным ключом `user.key` для аутентификации.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.crt
```
* **user.key**
Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo '<содержание поля>' | base64 -d > <название>.key
```
* **user.p12**
PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka.
Выдаеться в формате base64 для получения файла сертификата использовать команду
```bash
echo "<содержание поля>" | base64 -d > <название>.p12
```
* **user.password**
Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно.
Эти параметры используются для настройки TLS-подключения.
---
## 6. Пример конфигурации клиента внутри кластера
Пример пода:
```yaml
apiVersion: v1
kind: Pod
metadata:
name: kafka-4
spec:
volumes:
- name: work
emptyDir: {}
containers:
- name: kcat
image: quay.io/strimzi/kafka:latest-kafka-4.0.0
command: ["sleep", "5600"]
volumeMounts:
- name: work
mountPath: /work
restartPolicy: Never
```
Создаём под и сохраняем сертификаты:
```bash
kubectl cp user.p12 kafka-4:/work/
kubectl cp ca.p12 kafka-4:/work/
```
Создаём файлы конфигурации:
```bash
cat > /work/user-read.properties <<'EOF'
security.protocol=SSL
ssl.keystore.type=PKCS12
ssl.keystore.location=/work/user.p12
ssl.keystore.password=<user.password>
ssl.truststore.type=PKCS12
ssl.truststore.location=/work/ca.p12
ssl.truststore.password=<ca.password>
EOF
```
```bash
cat > /work/user-write.properties <<'EOF'
security.protocol=SSL
ssl.keystore.type=PKCS12
ssl.keystore.location=/work/user-write.p12
ssl.keystore.password=<user.password>
ssl.truststore.type=PKCS12
ssl.truststore.location=/work/ca.p12
ssl.truststore.password=<ca.password>
EOF
```
Листинг доступных топиков:
```bash
/opt/kafka/bin/kafka-topics.sh \\
--bootstrap-server kafkak8s-bootstrap-external:9093 \\
--command-config /work/user-read.properties \\
--list
```
Запись сообщений:
```bash
/opt/kafka/bin/kafka-console-producer.sh \\
--bootstrap-server <адрес сервис брокера>:9093 \\
--topic <topic> \\
--producer.config /work/user-write.properties
```
Чтение сообщений:
```bash
/opt/kafka/bin/kafka-console-consumer.sh \\
--bootstrap-server <адрес сервис брокера>:9093 \\
--topic <topic> \\
--from-beginning \\
--group <group> \\
--consumer.config /work/user-read.properties \\
--max-messages 50
```
---
## 7. Пример внешнего подключения с использованием **kcat**
**Листинг топиков**
```bash
kcat -b <externalConnect.bootstrap.fqdn>:9093 \\
-L \\
-X security.protocol=SSL \\
-X ssl.ca.location=./ca.crt \\
-X ssl.certificate.location=./user-read.crt \\
-X ssl.key.location=./user-read.key \\
-X ssl.endpoint.identification.algorithm=none
```
**Запись сообщения**
```bash
echo "hello from kcat" | kcat -P \\
-b <externalConnect.bootstrap.fqdn>:9093 \\
-t write-test \\
-X security.protocol=SSL \\
-X ssl.ca.location=./ca.crt \\
-X ssl.certificate.location=./user-write.crt \\
-X ssl.key.location=./user-write.key \\
-X ssl.endpoint.identification.algorithm=none
```
**Чтение сообщений**
```bash
kcat -C \\
-b <externalConnect.bootstrap.fqdn>:9093 \\
-t write-test \\
-o beginning \\
-q \\
-X security.protocol=SSL \\
-X ssl.ca.location=./ca.crt \\
-X ssl.certificate.location=./user-read.crt \\
-X ssl.key.location=./user-read.key \\
-X ssl.endpoint.identification.algorithm=none
```
---
## 9. Рекомендации
* Минимизируйте набор разрешённых операций для повышения безопасности.
* Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов.
* Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**.
* После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам.
---"},{"svcOperationId":166,"operation":"modify_topic","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/modify_topic/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":"# Инструкция по управлению топиками Apache Kafka через платформу
## 1. Общая информация
---
Топик — это основная сущность в Apache Kafka, предназначенная для приёма сообщений от продюсеров и передачи их консюмерам.
Платформа позволяет создавать, удалять и изменять параметры топиков без прямого доступа к брокерам, обеспечивая удобное управление через интерфейс или API.
---
## Доступные операции
- **create_topic** — Создание топика
- **modify_topic** — Модификация топика
- **delete_topic** — Удаление топика
---
## 2. Параметры создания топика
Ниже перечислены параметры, которые необходимо указать при создании нового топика:
* **Имя топика**
Название топика.
Должно быть уникальным в пределах кластера.
Пример: `orders-events`.
* **Партиции**
Количество партиций топика.
Рекомендуется выбирать с учётом уровня параллелизма потребителей и предполагаемой нагрузки.
Пример: `6`. Здесь важно рассказать о том как происходит расчет оптимального количества
Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.
* **Реплики**
Количество реплик для каждой партиции.
Обычно равно количеству доступных брокеров или меньше.
Пример: `3`.
---
## 4. Параметры модификации топика
Для уже существующих топиков можно изменять параметры. Все параметры являются опциональными:
* **Имя топика**
Название топика.
Пример: `orders-events`.
* **Партиции**
Новое количество партиций.
Пример: `12`.
* **Реплики**
Новое количество реплик.
Пример: `2`.
---
## 5. Рекомендации
* Планируйте количество партиций с запасом — уменьшение их числа невозможно.
* Количество реплик должно соответствовать требуемому уровню отказоустойчивости, но не превышать количество брокеров.
* Изменение параметров топика в рабочем окружении может временно влиять на производительность. Рекомендуется проводить крупные изменения в периоды минимальной нагрузки.
---"},{"svcOperationId":148,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/create/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":null},{"svcOperationId":165,"operation":"create_topic","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicestest/job/k8s/job/Kafka/job/create_topic/view/tags/job/0.0.2/buildWithParameters","descr":null,"man":"# Инструкция по управлению топиками Apache Kafka через платформу
## 1. Общая информация
---
Топик — это основная сущность в Apache Kafka, предназначенная для приёма сообщений от продюсеров и передачи их консюмерам.
Платформа позволяет создавать, удалять и изменять параметры топиков без прямого доступа к брокерам, обеспечивая удобное управление через интерфейс или API.
---
## Доступные операции
- **create_topic** — Создание топика
- **modify_topic** — Модификация топика
- **delete_topic** — Удаление топика
---
## 2. Параметры создания топика
Ниже перечислены параметры, которые необходимо указать при создании нового топика:
* **Имя топика**
Название топика.
Должно быть уникальным в пределах кластера.
Пример: `orders-events`.
* **Партиции**
Количество партиций топика.
Рекомендуется выбирать с учётом уровня параллелизма потребителей и предполагаемой нагрузки.
Пример: `6`. Здесь важно рассказать о том как происходит расчет оптимального количества
Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.
* **Реплики**
Количество реплик для каждой партиции.
Обычно равно количеству доступных брокеров или меньше.
Пример: `3`.
---
## 4. Параметры модификации топика
Для уже существующих топиков можно изменять параметры. Все параметры являются опциональными:
* **Имя топика**
Название топика.
Пример: `orders-events`.
* **Партиции**
Новое количество партиций.
Пример: `12`.
* **Реплики**
Новое количество реплик.
Пример: `2`.
---
## 5. Рекомендации
* Планируйте количество партиций с запасом — уменьшение их числа невозможно.
* Количество реплик должно соответствовать требуемому уровню отказоустойчивости, но не превышать количество брокеров.
* Изменение параметров топика в рабочем окружении может временно влиять на производительность. Рекомендуется проводить крупные изменения в периоды минимальной нагрузки.
---"}]},"runDurationMs":46}