Инструкция по установке программного обеспечения CShark

Идентификация предоставляемого экземпляра

1. Назначение документа

Документ устанавливает порядок развертывания программного обеспечения CShark. Инструкция позволяет пользователю самостоятельно:

1. проверить соответствие вычислительной среды системным требованиям;
2. получить идентифицированный комплект поставки;
3. проверить его целостность;
4. выполнить автоматизированную установку;
5. получить первичные реквизиты доступа;
6. подтвердить работоспособность экземпляра по контрольным признакам.

Инструкция относится к предоставляемому экземпляру в варианте demo для Ubuntu Server 24.04 LTS AMD64. После установки автоматически создаётся вымышленный объект Демо-паркинг «Северный» без реального адреса и реквизитов юридического лица: один уровень, две зоны и 50 парковочных мест. Штатный Device Gateway, mock APS и остальные необходимые эмуляторы входят в комплект.

2. Идентификация комплекта поставки

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

4. Предварительная проверка стенда

Выполните:

uname -m
grep -E '^(NAME|VERSION_ID)=' /etc/os-release
free -h
df -h /opt
timedatectl status

Ожидаемые признаки:

uname -m: x86_64
VERSION_ID="24.04"
RAM: не менее 8 ГБ
свободное место: не менее 30 ГБ

5. Получение комплекта поставки и установка

Комплект поставки — подписанный архив, открытый ключ проверки подписи и установочная программа — предоставляется правообладателем по запросу: ООО «КОМПЕТЕНЦИЯ», телефон +7 495 532-61-18, адрес: 115280, Москва, ул. Ленинская Слобода, д. 21, к. 1. Установка выполняется из полученного архива в порядке раздела 9. Базовая команда установки (из каталога распакованного комплекта):

sudo ./install.sh --variant demo

Установщик не запрашивает публичный адрес интерактивно. Если параметр --public-host не указан, установщик автоматически выбирает первый IPv4-адрес сервера из результата hostname -I, исключая адреса 127.x.x.x. Если адрес определить не удалось, установка останавливается и предлагает повторить команду с параметром --public-host.

Если сервер имеет несколько сетевых интерфейсов, явно укажите IP или DNS-имя, по которому Web-интерфейс будет доступен пользователям:

sudo ./install.sh --variant demo --public-host 10.20.30.40

Вместо IP можно передать DNS-имя, например --public-host cshark.example.ru. Значение должно быть доступно с рабочих мест пользователей; оно не обязано быть адресом, опубликованным в Интернете.

Канал stable принимает только подписанный комплект. Флаг --allow-unsigned-testing в штатной установке не используется. Параметр --variant demo выбран явно, поскольку демонстрационный вариант содержит вымышленную парковку на 50 мест. Для установки без демонстрационных данных используется та же команда с --variant clean; комплект эмуляторов при этом сохраняется.

Во время выполнения установщик:

1. проверяет ОС и AMD64-архитектуру;
2. сверяет SHA-256 до распаковки;
3. устанавливает Docker Engine, Docker Compose v2 и системные зависимости;
4. повторно проверяет внутренние контрольные суммы;
5. загружает локальные Docker-образы без обращения к внешнему registry;
6. генерирует уникальные секреты экземпляра;
7. создаёт раздельные роли базы данных;
8. применяет миграции;
9. запускает прикладные сервисы и средства наблюдаемости;
10. применяет версионированный demo seed 2026.07.2;
11. запускает mock APS;
12. выполняет автоматический smoke-test с обязательной проверкой мест.

6. Критерии успешной установки

Установка считается завершённой, если одновременно выполнены условия:

• установщик завершился с кодом 0;
• выведено сообщение УСТАНОВКА УСПЕШНА;
• автоматический smoke-test выдал СМОУК ПРОЙДЕН;
• создан файл /opt/cshark-stand/INITIAL-CREDENTIALS.txt;
• контейнеры основного профиля имеют состояние running или healthy;
• API возвращает признак готовности;
• Web-интерфейс открывается с рабочего места пользователя;
• smoke-test обнаруживает 50 парковочных мест;
• mock APS имеет состояние running или healthy.

7. Получение доступа

Покажите первичные реквизиты:

sudo cat /opt/cshark-stand/INITIAL-CREDENTIALS.txt

Откройте в браузере:

http://<IP-ИЛИ-DNS-СТЕНДА>:8088

Войдите под первичной учётной записью администратора. Файл INITIAL-CREDENTIALS.txt содержит пароль администратора и реквизиты Grafana. Рабочий файл /opt/cshark-stand/.env содержит сгенерированные секреты сервисов и создаётся с ограниченными правами доступа.

8. Контроль работоспособности

Проверьте контейнеры:

sudo docker compose \
  --env-file /opt/cshark-stand/.env \
  -f /opt/cshark-stand/compose.yml \
  --profile obs ps

Проверьте API:

curl -fsS http://127.0.0.1:8088/api/health

Проверьте доступ с рабочего места пользователя:

Web-интерфейс: http://<IP-ИЛИ-DNS-СТЕНДА>:8088
Grafana:       http://<IP-ИЛИ-DNS-СТЕНДА>:13000

В Web-интерфейсе должны быть доступны окно входа, схема, инциденты, журнал, аналитика, живой статус, оборудование, табло и административные функции в соответствии с правами вошедшего пользователя.

9. Установка из предоставленного комплекта

Перенесите на целевой сервер предоставленные правообладателем файлы: выбранный подписанный архив: cshark-2.0.3-demo-ubuntu-24.04-amd64-offline.tar либо cshark-2.0.3-clean-ubuntu-24.04-amd64-offline.tar, а также доверенный открытый ключ проверки подписи.

До распаковки проверьте SHA-256 выбранного архива:

echo 'ccb36a121bf8e1b756f1190f9369e490585082417829458b9bc62108620850c6 cshark-2.0.3-demo-ubuntu-24.04-amd64-offline.tar' | sha256sum -c -
echo 'c6e008d2e97bc8421b6b5e66abca6c861b182f4f19f7e12b3e1dd0db9f80f26b cshark-2.0.3-clean-ubuntu-24.04-amd64-offline.tar' | sha256sum -c -

После успешной проверки распакуйте выбранный вариант:

mkdir -p /srv/cshark-install
tar -xf cshark-2.0.3-demo-ubuntu-24.04-amd64-offline.tar -C /srv/cshark-install
cd /srv/cshark-install/cshark-2.0.3-demo-ubuntu-24.04-amd64-offline
sudo ./install.sh \
  --public-host <IP-ИЛИ-DNS-СТЕНДА> \
  --trusted-public-key /путь/cshark-release.public.pem

10. Диагностика

Журнал установки:

sudo cat /opt/cshark-stand/install.log

Последние журналы контейнеров:

sudo docker compose \
  --env-file /opt/cshark-stand/.env \
  -f /opt/cshark-stand/compose.yml \
  --profile obs logs --no-color --tail 200

При неуспешной установке контейнеры останавливаются, а volumes сохраняются для диагностики. Повторную установку поверх существующего каталога не выполняют до анализа причины.

11. Остановка системы

Остановить экземпляр без удаления данных:

sudo docker compose \
  --env-file /opt/cshark-stand/.env \
  -f /opt/cshark-stand/compose.yml \
  --profile obs down

12. Контрольный лист установки

• ОС Ubuntu Server 24.04 LTS и архитектура x86_64 подтверждены.
• Объём RAM и свободного диска соответствует требованиям.
• SHA-256 предоставленного комплекта совпадает с инструкцией.
• Установщик завершился с кодом 0.
• Smoke-test пройден.
• Первичные реквизиты получены.
• API /api/health отвечает.
• Web-интерфейс доступен с рабочего места пользователя.
• Создан Демо-паркинг «Северный», две зоны и ровно 50 мест.
• Mock APS работает и изменение состояния места отображается в системе.
• Подтверждено отсутствие реальных кадров до подключения медиапакета.
• Журналы установки сохранены при наличии замечаний.