Доработки по удобству

2025-10-12 16:41:32 +03:00
parent 9341983f26
commit bf6b424a5e
5 changed files with 211 additions and 49 deletions
@@ -5,6 +5,11 @@
 Этот вариант повторяет логику Postgres-стенда, но в роли DWH — **Greenplum (single node в Docker)**.  
 Airflow по‑прежнему использует **Postgres** только как metadata DB (это стандартная и простая схема).

+## Требования
+- Docker Desktop (Windows/Mac) или Docker Engine 24+ (Linux) с `docker compose v2`.
+- Make (опционально). Если `make` нет — используйте приведённые ниже команды `docker compose` напрямую.
+- Windows: запускайте команды в Git Bash или WSL; PowerShell тоже подойдёт, но для `make` удобнее Git Bash/WSL.
+
 ## Что внутри
 - **Greenplum** (single node) — `woblerr/greenplum:6.27.1` (локальный стенд для разработки).
 - **Kafka (KRaft, без Zookeeper)** — генерация событий.
@@ -15,7 +20,7 @@ Airflow по‑прежнему использует **Postgres** только
 > Примечание по версиям и надёжности: используется образ `woblerr/greenplum:6.27.1` с поддержкой переменных окружения и fallback значениями. Для продакшен‑подобных тестов зафиксируй digest (SHA256) конкретного тега на Docker Hub.

 ## Быстрый старт
-Установим make под Вашу операционную систему
+Установим make (Linux/Mac)
 ```bash
 sudo apt install -y make
 ```
@@ -26,7 +31,7 @@ cp .env.example .env
 # При необходимости отредактируйте .env для ваших настроек
 ```

-Запустим приложение
+Запустим приложение (вариант с Make)
 ```bash
 make up && make airflow-init
 make logs   # ждем "Listening at: http://0.0.0.0:8080"
@@ -34,6 +39,48 @@ make logs   # ждем "Listening at: http://0.0.0.0:8080"
 Открой Airflow: http://localhost:8080 (логин/пароль см. `.env`, по умолчанию admin/admin).  
 Включи DAG **kafka_to_greenplum** и нажми **Trigger** — он создаст таблицу и загрузит ~1000 записей в `gpadmin.public.orders`.

+Альтернатива без Make (на всех ОС):
+```bash
+docker compose -f docker-compose.yml up -d
+docker compose -f docker-compose.yml run --rm airflow-init
+docker compose -f docker-compose.yml logs -f airflow-webserver airflow-scheduler
+```
+
+### Создаём Airflow Connection для Greenplum
+1. Открой Airflow UI → **Admin → Connections** → **Add a new record**.
+2. Заполни поля:
+   - `Conn Id`: `greenplum_conn` (или своё значение, тогда пропиши его в переменной `GP_CONN_ID`).
+   - `Conn Type`: `Postgres`.
+   - `Host`: `greenplum`.
+   - `Schema`: значение `GP_DB` (по умолчанию `gpadmin`).
+   - `Login`: `GP_USER` (по умолчанию `gpadmin`).
+   - `Password`: `GP_PASSWORD`.
+   - `Port`: `5432`.
+3. Сохрани соединение и перезапусти DAG (если он уже был активирован).
+
+CLI-альтернатива (выполняется внутри контейнера Airflow):
+```bash
+docker compose -f docker-compose.yml exec airflow-webserver bash -lc "
+airflow connections add 'greenplum_conn' \
+    --conn-type postgres \
+    --conn-host greenplum \
+    --conn-login ${GP_USER:-gpadmin} \
+    --conn-password ${GP_PASSWORD:-gpadmin} \
+    --conn-schema ${GP_DB:-gpadmin} \
+    --conn-port 5432"
+```
+
+### Интерфейсы и порты
+- Airflow UI: http://localhost:8080 (admin/admin по умолчанию)
+- Kafka UI: http://localhost:8082 (просмотр топиков/сообщений)
+- Greenplum: `localhost:${GP_PORT:-5432}` (внешний порт проброшен из контейнера)
+- Postgres (Airflow metadata): `localhost:5433`
+- Kafka (для клиентов на хосте): `localhost:9092`
+
+### Параметры чтения/загрузки
+- `KAFKA_BATCH_SIZE` — размер батча при вставке в Greenplum (по умолчанию 500).
+- `KAFKA_POLL_TIMEOUT` — таймаут ожидания сообщения в секундах (по умолчанию 10).
+
 ### Проверка загрузки
 ```bash
 # Подключение к Greenplum через внешний psql клиент
@@ -50,6 +97,10 @@ docker compose -f docker-compose.yml exec greenplum bash -c "su - gpadmin -c '/u
 SELECT count(*) FROM public.orders;
 ```

+### Проверка Kafka
+- Открой Kafka UI: http://localhost:8082 — проверь, что существует топик `orders` и в нём появляются сообщения после запуска DAG.
+- Если автосоздание топиков в брокере отключено, создай топик вручную через UI перед запуском DAG.
+
 ## Файлы
 - `docker-compose.yml` — сервисы Greenplum + Kafka + Airflow + Postgres (metadata).
 - `.env.example` — шаблон переменных окружения.
@@ -65,12 +116,16 @@ SELECT count(*) FROM public.orders;
 - `GP_PASSWORD` — пароль пользователя (по умолчанию: gpadmin)
 - `GP_DB` — база данных (по умолчанию: gpadmin)
 - `GP_PORT` — порт для подключения (по умолчанию: 5432)
+- `GP_CONN_ID` — ID Airflow Connection (по умолчанию: `greenplum_conn`)
+- `GP_USE_AIRFLOW_CONN` — использовать ли Airflow Connection (`true`/`false`). Если `false`, DAG подключается к БД напрямую по ENV.

 Образ `woblerr/greenplum:6.27.1` использует переменные:
 - `GREENPLUM_USER` (маппится на `GP_USER`)
 - `GREENPLUM_PASSWORD` (маппится на `GP_PASSWORD`)
 - `GREENPLUM_DATABASE_NAME` (маппится на `GP_DB`)

+Внутри контейнеров Airflow хост для подключения к БД — `greenplum` (см. `GP_HOST`), а с вашей машины — `localhost:${GP_PORT}`. Созданный в Airflow Connection реиспользует те же значения, что и `.env`.
+
 ## Пинning и альтернативы
 - Зафиксируй digest образа `woblerr/greenplum:6.27.1` (Docker Hub → Tag → «Copy digest») и замени тег на `@sha256:...` в `docker-compose.yml`.
 - Альтернативы: можно использовать другие образы Greenplum или собрать собственный образ для GPDB 6/7.
@@ -79,3 +134,22 @@ SELECT count(*) FROM public.orders;
 ## Ограничения и заметки
 - Этот стенд — учебный. Для высокой надёжности и производительности Greenplum обычно разворачивают кластерами на нескольких узлах, на裸‑железе/VM с отдельными дисками под сегменты.
 - Для GP7 (основан на новее PostgreSQL) можно упростить загрузку, включая `ON CONFLICT`. В учебных целях мы остались на широко доступном GP6 образе.
+
+## Поток данных (DAG)
+Последовательность задач в `kafka_to_greenplum`:
+- `create_table` — создаёт таблицу `public.orders` в Greenplum (колоночная, AO/CO, распределение по `order_id`).
+- `produce_messages` — генерирует ~1000 сообщений и пишет их в Kafka-топик `orders`.
+- `consume_and_load` — читает сообщения из Kafka и вставляет в `public.orders` батчами (по `KAFKA_BATCH_SIZE`) с защитой от дублей для GP6 через anti-join. По умолчанию использует Airflow Connection `greenplum_conn`, но при `GP_USE_AIRFLOW_CONN=false` подключается по ENV (`GP_HOST`, `GP_PORT`, `GP_DB`, `GP_USER`, `GP_PASSWORD`).
+
+Повторный запуск DAG безопасен: при вставке используется проверка на существование `order_id`.
+
+## Типичные проблемы и решения
+- Airflow UI не открывается: проверь `make logs` и дождись строки `Listening at: http://0.0.0.0:8080`.
+- Ошибка подключения к Greenplum: дождись, пока контейнер `greenplum` станет `healthy`; проверь, что порт `GP_PORT` не занят локальными сервисами.
+- Нет топика `orders`: создай его через Kafka UI (или перезапусти DAG после включения авто‑создания топиков).
+- `make` отсутствует на Windows: используй команды `docker compose` из раздела «Альтернатива без Make» или установи Git Bash/WSL.
+
+## Что дальше (опциональные расширения)
+- Добавить пример загрузки через внешние таблицы/`gpfdist` для демонстрации быстрых батчей в Greenplum.
+- Показать альтернативу с GPDB 7 и `ON CONFLICT` (отдельная ветка/вариант DAG).
+- Добавить пример использования Airflow Variables/Secrets Backend для передачи порогов и секретов.