Пошаговая установка Core (Frontend, API, PostgreSQL, MinIO, Keycloak
площадки) в стороннем Kubernetes. Образы API и Frontend поставляются
из реестра GitLab IT4BIM. Seq у заказчика не ставится.
Если у площадки нет своей команды platform и нет готового кластера —
часто проще Docker Compose на одной Linux-VM (тот же набор сервисов).
Этот документ — путь «у нас уже есть K8s».
Перед стартом прочитайте обзор внедрения и
согласуйте с IT4BIM: DNS/TLS, исходящий доступ, лицензионную учётку,
доступ к реестру образов.
| Что | Зачем |
|---|---|
| Учётка / Deploy Token в GitLab Container Registry | docker pull / imagePullSecret |
| Имена образов и рекомендуемый тег релиза | Какую версию ставить |
| Пакет манифестов YAML | Манифесты Kubernetes + clashflow-k8s-core.zip |
Учётка лицензии сайта (license.site.*) |
Проверка подписки Frontend / Worker |
| При пилоте — временные учётки для входа | Пока не настроен Keycloak площадки |
| Контакты исходящих URL | Лицензии, SoftInstaller, Seq (логи), реестр |
Без доступа к реестру образы Core не скачать. Без исходящего доступа к
серверу лицензий Frontend и Worker не пройдут проверку подписки.
| Назначение | Пример имени |
|---|---|
| Веб + API (один host) | collisions.example.com |
| Keycloak площадки | auth.example.com (или общий корпоративный IdP) |
| MinIO API (если снаружи) | minio.example.com |
API и Frontend обычно публикуют на одном host: / → Frontend,
/api, /hubs, /scalar, /health → ApiService.
| Куда | Зачем |
|---|---|
registry.gitlab.it4bim.ru |
Первичный pull и обновления образов |
| Сервер лицензий IT4BIM (Keycloak realm лицензий) | Проверка подписки |
| Seq IT4BIM | Централизованные логи (как согласовано) |
| SoftInstaller | Не обязателен с Core; нужен с Windows Worker |
Внутренний трафик: Core → Windows Worker (порты Worker во внутренней сети)
и Worker → HTTPS API Core.
Ориентир по ресурсам — Железо и контур.
registry.gitlab.it4bim.ru;it4bim/it4bim.collisions.Права нужны только на read (pull). Push заказчику не выдаётся.
| Сервис | Образ (шаблон) |
|---|---|
| API | registry.gitlab.it4bim.ru/it4bim/it4bim.collisions/backend:<тег> |
| Frontend | registry.gitlab.it4bim.ru/it4bim/it4bim.collisions/frontend:<тег> |
Теги: фиксированный релизный (1.0.0 / git SHA) или согласованный
latest. На проде ставьте конкретный тег из паспорта релиза IT4BIM,
не «что попало в latest».
PostgreSQL и MinIO — публичные образы (postgres:16, minio/minio и т.п.)
из Docker Hub / вашего зеркала; их IT4BIM в свой registry не обязан
класть.
docker login registry.gitlab.it4bim.ru
# логин и пароль / token от IT4BIM
docker pull registry.gitlab.it4bim.ru/it4bim/it4bim.collisions/backend:<ТЕГ>
docker pull registry.gitlab.it4bim.ru/it4bim/it4bim.collisions/frontend:<ТЕГ>
Если login или pull падают — сначала сеть/firewall до реестра, потом
права токена. Дальше в кластер не идите, пока docker pull не проходит.
kubectl create namespace collisions # имя на ваше усмотрение
kubectl -n collisions create secret docker-registry gitlab-it4bim-registry \
--docker-server=registry.gitlab.it4bim.ru \
--docker-username='<логин от IT4BIM>' \
--docker-password='<токен или пароль>' \
--docker-email='deploy@example.com'
В Deployment / Pod template у API и Frontend укажите:
spec:
template:
spec:
imagePullSecrets:
- name: gitlab-it4bim-registry
Без этого kubelet получит ImagePullBackOff.
docker pull обоих образов.docker save … -o collisions-core-images.tar (+ checksum от IT4BIM).docker load -i collisions-core-images.tar и загрузкаimagePullPolicy: Never / IfNotPresentСоздайте Secret (или External Secrets) с паролями вашей площадки —
не копируйте демо-значения из чужих стендов.
Минимум для API:
| Ключ / параметр | Назначение |
|---|---|
| Connection string PostgreSQL | БД коллизий, job, настройки |
| MinIO / S3 endpoint, ключи, bucket | Картинки коллизий |
Authentication__Authority |
URL realm Keycloak площадки |
Authentication__PublicAuthority |
Необязательно: адрес того же realm для ПК пользователей, если API ходит в Keycloak по внутреннему адресу |
Authentication__Audience |
Обычно collisions-api |
Параметры лицензии (License__*) |
Authority лицензий IT4BIM + учётка сайта |
| URL служб Worker | Base URL Model Inventory / Navis Report / NWC export |
Frontend (env на этапе сборки или runtime-конфиг — как в пакете IT4BIM):
Плагины Revit, Tekla и Navisworks узнают адрес Keycloak площадки у API
(GET /api/v0.1/configuration/auth). При смене Keycloak достаточно поменять
настройку API — переустанавливать плагины на ПК не нужно. Адрес должен быть
HTTPS и открываться с ПК пользователей.
Keycloak площадки (сотрудники) и realm лицензий IT4BIM — разные
системы. Лицензионную учётку выдаёт IT4BIM; сотрудников заводите вы.
Готовый набор файлов, таблицы параметров и команды kubectl —
на странице Манифесты Kubernetes
(скачать ZIP).
Краткий порядок:
imagePullSecret + Secret (01-secret.yaml).keycloak/ из архива (kubectl apply -k keycloak)08-windows-worker-endpoints.yaml.На том же host, что и веб:
| Path | Куда |
|---|---|
/api |
ApiService |
/hubs |
ApiService (SignalR) |
/scalar, /openapi |
ApiService |
/health, /alive |
ApiService |
/ |
Frontend |
Для больших импортов коллизий и длинных операций увеличьте
proxy-body-size и proxy-read-timeout / proxy-send-timeout на Ingress
(ориентир: без жёсткого лимита размера тела, таймауты порядка часов —
как в паспорте поставки).
После установки Windows Worker пропишите во env API внутренние URL
служб Worker (или Ingress к ним), например:
Пока Worker нет — веб откроется, но дерево моделей / отчёты не заработают.
kubectl -n collisions get pods
kubectl -n collisions rollout status deployment/collisions-api
kubectl -n collisions rollout status deployment/collisions-frontend
# с машины с доступом к Ingress:
curl -fsS https://collisions.example.com/health
curl -fsS https://collisions.example.com/alive
Откройте в браузере Frontend и {API_BASE}/scalar.
Нужны realm и клиенты под веб / API / desktop-плагины и роли:
AdministratorBim-engineerChief-engineerEngineerПроще всего поднять Keycloak из пакета keycloak/ в архиве манифестов:
он создаёт realm collisions с этими ролями и клиентами, выдаёт каждому
пользователю роль Engineer и подключает вход через Yandex ID / VK ID /
Mail.ru / OK (порядок — в README.md архива). Для корпоративного IdP IT4BIM
передаёт готовый чеклист клиентов и ролей либо помогает импортировать
realm. Роли в UI — Вход и роли.
Пока корпоративный IdP не готов, для пилота можно временно использовать
учётки, выданные IT4BIM — это не замена боевому Keycloak заказчика.
license.site.*) и срок.AdministratorПроверку лицензии отключить нельзя: нужен исходящий доступ к серверу
лицензий IT4BIM.
docker save / загрузка во внутренний registry.kubectl -n collisions set image deployment/collisions-api \
api=registry.gitlab.it4bim.ru/it4bim/it4bim.collisions/backend:<НОВЫЙ_ТЕГ>
kubectl -n collisions set image deployment/collisions-frontend \
frontend=registry.gitlab.it4bim.ru/it4bim/it4bim.collisions/frontend:<НОВЫЙ_ТЕГ>
kubectl -n collisions rollout status deployment/collisions-api
kubectl -n collisions rollout status deployment/collisions-frontend
kubectl set image.| Симптом | Что проверить |
|---|---|
ImagePullBackOff |
imagePullSecrets, срок токена, firewall до registry.gitlab.it4bim.ru |
| 502 / пустой веб | Ingress path / vs /api, readiness API, DNS/TLS |
| Вход не открывается | URL Keycloak площадки, client SPA, redirect URI |
| «Лицензия неактивна» | Исходящий доступ, учётка сайта, часы/NTP на нодах |
| Картинки коллизий 404 | MinIO bucket, ключи, endpoint из пода API |
| SignalR / чаты не работают | Path /hubs на API, WebSocket на Ingress |