Установка — КАСКАД 360

Содержание

1. Системные требования
2. Установка и запуск
2.4. Управление сервисом (systemd)
3. Базовая конфигурация
3.1. Настройка портов
4. Мастер первичной настройки
5. Админ-панель: обзор разделов
6. Базы данных
7. Сервисы и маршрутизация
8. Обновления и маркет
9. Проверка установки

Версия 1.0.7. Релиз сфокусирован на стабильности первого запуска: мастер настройки ведёт по шагам, после завершения приложение запускается автоматически. Для установки API не нужен — все шаги выполняются через веб-интерфейс. Документация API для внешних интеграций — на странице Документация; полная интерактивная документация — в разделе API Explorer админ-панели.

1. Системные требования

Компонент	Требование
ОС	Linux x86_64 (Ubuntu 20.04+, CentOS 8+ и др.), Windows 10+, macOS 12+
ОЗУ	от 512 МБ (рекомендуется 2 ГБ)
Диск	от 500 МБ свободного места
СУБД	MySQL 8.0+ или PostgreSQL 14+ (можно поднять отдельно или в Docker)

2. Установка и запуск

Рекомендуемый способ для Linux — готовый дистрибутив ядра.

2.1. Скачивание

wget https://cascad360.ru/downloads/core/1.0.7/cascad360-1.0.7-linux-x86_64.tar.gz

# или
curl -LO https://cascad360.ru/downloads/core/1.0.7/cascad360-1.0.7-linux-x86_64.tar.gz

Прямая ссылка: cascad360-1.0.7-linux-x86_64.tar.gz

2.2. Распаковка

tar -xzf cascad360-1.0.7-linux-x86_64.tar.gz
cd cascad360

# опционально: установка в /opt
# sudo mv cascad360 /opt/cascad360
# cd /opt/cascad360

2.3. Запуск

Новая установка (рекомендуется в 1.0.7+): сначала мастер первичной настройки:

./cascad360 --setup

# Откройте в браузере (порт по умолчанию — 5050):
# http://localhost:5050/setup

После завершения мастера основное приложение запускается автоматически в фоне — как systemd-сервис cascad360 (при установке от root) или фоновый процесс. Дальнейшее управление — через systemctl (рекомендуется) или команды ./cascad360.

Уже настроенная система — запуск и остановка через systemd:

sudo systemctl start cascad360
sudo systemctl stop cascad360
sudo systemctl status cascad360

Если unit не настроен (локальная отладка без root):

./cascad360 start

# если исполняемый файл в bin/:
# ./bin/cascad360 start

2.4. Управление сервисом (systemd)

После установки и завершения мастера настройки КАСКАД 360 работает как фоновый сервис под управлением systemd. Unit — cascad360.service; при установке от администратора сервера мастер может создать его и включить автозапуск автоматически.

Основные команды (от root или через sudo):

systemctl status cascad360   # статус: running / stopped, последние строки лога
systemctl start cascad360    # запуск сервиса
systemctl stop cascad360     # остановка
systemctl enable cascad360   # автозапуск при загрузке ОС

Команда	Когда использовать
`status`	Проверить, что платформа запущена и нет ошибок unit
`start` / `stop`	Ручной запуск и остановка — перед обновлением, правкой `config.yml` или диагностикой
`enable`	Включить автозапуск после перезагрузки сервера (если ещё не включён)

После изменения config.yml перезапустите сервис:

sudo systemctl restart cascad360

Просмотр логов в реальном времени:

journalctl -u cascad360 -f

Без systemd: если unit не создан (например, установка без root), используйте ./cascad360 start и ./cascad360 status из каталога установки. Для production на Linux рекомендуется настроить systemd — мастер делает это при завершении настройки от root.

После запуска откройте в браузере:

Мастер настройки (первый запуск): http://localhost:5050/setup при ./cascad360 --setup
Шлюз и админ-панель (после настройки): http://localhost:5000, http://localhost:5000/admin
Страница входа: http://localhost:5000/login

3. Базовая конфигурация

Основной файл — config.yml в каталоге установки. При первой установке можно скопировать шаблон:

cp config.yml.example config.yml

Минимально полезные параметры перед первым запуском:

app:
  name: Контур
  version: 1.0.7
  setup_completed: false
  setup_app_configured: false   # true после шага 3 мастера (1.0.7+)

web:
  host: 0.0.0.0
  port: 5000
  public_port: 5001
  public_api_separate: false   # true — Public API на отдельном порту
  public_api_enabled: true

plugin_ports:
  enabled: false             # true — HTTP-listener'ы плагинов (см. 3.1)

database:
  driver: mysql
  host: localhost
  port: 3306
  database: cascad360
  username: cascad_user
  password: change-me

Параметры подключения к БД можно также указать в мастере настройки (/setup) — тогда правка config.yml не обязательна до первого входа.

Перед продакшеном измените пароль БД и секретные ключи приложения. Полный список параметров — в config.yml.example и документации API; детально про порты — в разделе 3.1.

3.1. Настройка портов

Порты задаются в config.yml. После изменения перезапустите сервис: sudo systemctl restart cascad360 (см. раздел 2.4).

Порт / диапазон	Параметр	Назначение
`5000`	`web.port`	Основной HTTP: админ-панель, Admin API, шлюз, маршрутизация
`5001`	`web.public_port`	Public API — только при `public_api_separate: true`
`8000–8999`	`plugin_ports`	Диапазон HTTP-listener'ов плагинов (при `enabled: true`)

Основной порт платформы (`web`)

port — порт админки и Admin API (по умолчанию 5000).
public_api_separate: false — Public API на том же порту (режим по умолчанию, как в 1.0.5).
public_api_separate: true — Admin API на port, Public API на public_port; удобно для сетевого разделения контуров.
public_api_enabled: false — отключить Public API полностью.

# Раздельные порты Admin и Public API
web:
  port: 5000
  public_port: 5001
  public_api_separate: true
  public_api_enabled: true

Порты расширений (`plugin_ports`, 1.0.6)

Для плагинов с собственным веб-интерфейсом. По умолчанию выключено — ядро остаётся компактным.

plugin_ports:
  enabled: true
  port_range_min: 8000
  port_range_max: 8999
  max_listeners: 10
  reserved_ports: [5000, 5001, 5050]  # порты, которые плагины не могут занять
  auto_start_on_boot: false
  default_host: 0.0.0.0
  hook_timeout_seconds: 30

Управление listener'ами — в админ-панели (раздел плагинов) с правами plugin_ports_view, plugin_ports_manage, plugin_ports_operate.

Firewall: откройте только нужные порты — обычно web.port и при необходимости public_port или конкретные порты из диапазона plugin_ports. Порт СУБД не должен быть доступен извне.

4. Мастер первичной настройки

При первой установке запустите ./cascad360 --setup и откройте http://localhost:5050/setup. Альтернатива: при setup_completed: false мастер доступен на основном порту — http://localhost:5000/setup.

Мастер выполняется в браузере. В версии 1.0.7 переход между шагами возможен только после реальной готовности предыдущего этапа — индикаторы прогресса отражают фактическое состояние, а не дефолты конфигурации.

Подключение к БД — тип (MySQL / PostgreSQL), хост, порт, имя базы, учётные данные. Кнопка «Проверить соединение» обязательна перед переходом к следующему шагу.
Администратор — создание первой учётной записи (логин, пароль, email). Жёсткого дефолтного пароля нет.
Параметры приложения — название контура и базовые настройки. После сохранения выставляется app.setup_app_configured: true.

Когда все три шага выполнены, становится активной кнопка «Завершить настройку». После нажатия:

конфигурация сохраняется (app.setup_completed: true);
система пытается запустить основное приложение — через systemctl start cascad360 (при root + systemd), установку unit с enable --now или фоновый процесс ./cascad360;
при недоступном автозапуске вы получите чёткую команду для ручного запуска — без перехода на страницу, которая ещё не работает;
после успешного запуска откроется страница входа на основном порту: http://localhost:5000/login.

Systemd: после завершения мастера сервис работает в фоне как cascad360.service. Управление — командами из раздела 2.4; при установке от root мастер может сразу выполнить systemctl enable --now cascad360.

После завершения войдите в админ-панель: http://localhost:5000/admin с учётной записью, созданной на шаге 2.

5. Админ-панель: обзор разделов

Все дальнейшие настройки — через боковое меню админ-панели. Доступ к разделам зависит от роли и прав пользователя.

Раздел	Путь	Что настраивается
Главная	`/admin/`	Дашборд, сводка состояния
Сервисы	`/admin/services`	Список сервисов, статус, запуск и остановка
Маршрутизация	`/admin/routing`	Правила проксирования запросов к сервисам
Балансировка	`/admin/load-balancing`	Алгоритмы распределения нагрузки
Контейнеры	`/admin/containers`	Управление контейнерами (Docker)
Пользователи	`/admin/users`	Учётные записи, роли и права
Модули	`/admin/modules`	Установленные модули ядра
Плагины	`/admin/plugins`	Включение и конфигурация плагинов
Обновления	`/admin/updates`	Обновление ядра, модулей и плагинов
Маркет	`/admin/market`	Каталог и установка артефактов
Журналы	`/admin/logs`	Логи системы
Мониторинг	`/admin/monitoring`	Метрики, алерты, дашборды
Файлы	`/admin/files`	Загрузка и управление файлами
БД ядра	`/admin/database`	Структура таблиц основной БД
БД сервисов	`/admin/service-databases`	Привязка БД к сервисам
Студия БД	`/admin/db-studio`	Работа с таблицами, SQL-консоль, аудит
API Explorer	`/admin/api-explorer`	Документация Admin/Public API, Try it out, экспорт OpenAPI
Настройки	`/admin/settings`	Системные параметры, API-ключи для интеграций

6. Базы данных

Работа с данными выполняется в трёх связанных разделах админ-панели.

6.1. БД ядра (`/admin/database`)

Просмотр структуры основной базы данных платформы: список таблиц, проверка схемы. Используется для диагностики после установки.

6.2. БД сервисов (`/admin/service-databases`)

Привязка отдельных баз данных к подключённым сервисам:

выбор источника данных (datasource) и создание новой БД для сервиса;
выполнение install SQL при первичной настройке сервиса;
переход в Студию БД по кнопке «Открыть в студии».

6.3. Студия БД (`/admin/db-studio`)

Единый интерфейс для любой привязанной базы (ядро или сервис):

просмотр основной БД ядра и сервисных баз — служебные каталоги СУБД скрыты;
список таблиц и представлений, структура (колонки, индексы, FK);
просмотр данных с пагинацией, сортировкой и фильтрами — при переключении контекста данные на экране обновляются без «чужих» строк;
добавление, редактирование и удаление строк через формы;
SQL-консоль (read-only или с правом на изменение — по роли);
журнал изменяющих операций (аудит);
проверка схемы — полный актуальный набор таблиц ядра.

В верхней части студии выберите источник данных и базу — контекст сохраняется в URL, ссылку можно передать коллеге.

Доступ к студии и операциям с данными регулируется правами роли: db_view, db_edit, db_schema, db_sql_execute, db_audit. Назначение прав — в разделе «Пользователи».

6.4. API Explorer (`/admin/api-explorer`)

Единый раздел для просмотра и проверки API без внешних инструментов:

вкладки Admin API и Public API;
фильтры по источнику: ядро, модуль, плагин, сервис — стабильное переключение с первого выбора;
Try it out для администраторов с учётом RBAC (api_docs_view, api_docs_execute);
экспорт OpenAPI в JSON или YAML.

Публичная страница Swagger для внешнего API: /api/docs/public. Старый адрес /api/v1/admin/docs перенаправляет в API Explorer.

6.5. Веб-контур расширений (опционально, 1.0.6)

Если плагин предоставляет собственный HTTP-интерфейс, включите plugin_ports.enabled: true в config.yml — параметры и диапазоны портов описаны в разделе 3.1. Регистрация и запуск listener'ов — в админ-панели (раздел плагинов) с учётом RBAC.

7. Сервисы и маршрутизация

7.1. Сервисы (`/admin/services`)

На странице сервисов отображаются подключённые бэкенды: статус, health-check, метрики. Доступны действия запуска, остановки, перезапуска и масштабирования — через кнопки в интерфейсе.

7.2. Маршрутизация (`/admin/routing`)

Настройка правил, по которым запросы /api/module/<модуль>/… проксируются к целевым сервисам:

создание и редактирование правил (шаблон пути, целевой сервис, метод);
предпросмотр маршрута перед сохранением;
горячая перезагрузка правил без рестарта ядра.

7.3. Балансировка (`/admin/load-balancing`)

Выбор алгоритма распределения запросов между репликами сервиса (round-robin, least connections и др.).

7.4. Контейнеры (`/admin/containers`)

Обзор и управление Docker-контейнерами, если Service Discovery работает через Docker.

8. Обновления и маркет

8.1. Центр обновлений (`/admin/updates`)

Управление версиями ядра, модулей и плагинов:

проверка доступных обновлений по каналу (stable, beta);
запуск задачи обновления или отката из интерфейса;
readiness-проверка перед обновлением в production.

Канал и URL реестра задаются в config.yml (секция updates), остальное — в панели.

8.2. Маркет (`/admin/market`)

Витрина модулей и плагинов поверх центра обновлений:

каталог с поиском и фильтрами по типу артефакта;
карточка продукта с описанием и совместимостью;
установка, обновление и откат версии через интерфейс;
история операций и журнал security-событий.

Установка и обновление из маркета требуют активной подписки или лицензии. На dev/staging просмотр каталога может быть доступен без подписки (параметр market.subscription_gate_mode: browse в config.yml).

8.3. API-ключи для внешних интеграций

Если нужно подключить внешнее приложение к данным или файлам платформы, создайте API-ключ в разделе Настройки (/admin/settings) и назначьте нужные разрешения. Подробности — в документации публичного API.

9. Проверка установки

Убедитесь, что платформа работает:

Убедитесь, что сервис запущен: systemctl status cascad360 — состояние active (running) (см. раздел 2.4).
Убедитесь, что в config.yml установлено app.setup_completed: true.
Откройте http://localhost:5000/login и войдите с учётной записью администратора.
На главной странице панели проверьте, что статус системы отображается без ошибок.
Откройте БД ядра — должны отображаться таблицы основной базы.
Откройте Студия БД — выберите основную базу ядра, переключите таблицу и убедитесь, что данные обновляются корректно.
Откройте API Explorer — проверьте вкладки Admin/Public API и переключение фильтров (Все / Ядро / Модуль / Плагин / Сервис).
Опционально: проверка health-check с командной строки:

curl http://localhost:5000/api/health
# Ожидаемый ответ: {"status":"ok","version":"1.0.7"}

Если шлюз не отвечает после мастера — проверьте systemctl status cascad360 и логи journalctl -u cascad360 -n 50, что порт 5000 не занят и параметры БД в config.yml верны. В логах должно быть Loaded N builtin plugin(s), N ≥ 3. При необходимости перезапуск: sudo systemctl restart cascad360.

Документация API для интеграций Отправить обратную связь

Установка КАСКАД 360