Установка Excubius
Excubius работает на одном сервере Linux, которым управляете вы, в вашей облачной подписке или в вашем центре обработки данных. Интерактивная программа установки проверяет сервер, задает несколько вопросов, устанавливает контейнеры и получает сертификат. В этой статье описано, что вам потребуется, что программа установки спрашивает и делает и куда перейти для каждой следующей задачи.
Перед началом работы
| Элемент | Требование |
|---|---|
| Сервер | Rocky Linux 9 или 10 (или другая система семейства RHEL), x86-64, systemd. Не менее 2 vCPU, 4 ГиБ памяти и 20 ГиБ свободного места на диске; в Azure для начала подойдет Standard_B2ms (2 vCPU, 8 ГиБ), размер которого можно изменить позже. Если серверы создает ваша облачная команда, см. статью Запрос сервера в Azure |
| Доступ | Учетная запись с правами sudo на сервере, доступном по SSH с вашей рабочей станции |
| Сеть для пользователей | Порты 80 и 443 свободны на сервере и открыты из тех мест, откуда пользователи будут работать с Excubius |
| Исходящий трафик | HTTPS к ghcr.io и docker.io для загрузки образов, если вы не используете автономный пакет |
| Сеть к отслеживаемым системам | С сервера: SQL-порт каждого экземпляра, реплики и IP-адреса прослушивателя (и UDP 1434 для именованных экземпляров без фиксированного порта), а также HTTPS к проверяемым веб-адресам. К сборщику никто не подключается |
| Пакет программы установки | excubius-installer-<version>.tar.gz или автономный пакет с образами внутри. Пользователи, выполнившие вход, получают оба пакета на странице Загрузки |
| Вход | Регистрация приложения в Microsoft Entra ID, клиент OAuth в Google или и то и другое. См. статью Настройка поставщиков входа |
| Имена входа для мониторинга | Имена входа только для чтения для отслеживаемых систем, например имя входа SQL Server из статьи Предварительные требования для групп доступности |
| Сертификат | Для Let's Encrypt: публичное DNS-имя, указывающее на сервер, или доступ к его зоне DNS через API. Не требуется для собственного сертификата, самозаверяющего сертификата или шлюза, который завершает TLS |
Как выполняется установка
Предварительные проверки охватывают операционную систему и ее версию, архитектуру, systemd и dnf, память, процессоры, диск, свободные порты 80 и 443, SELinux, доступ к реестрам или к архиву образов и синхронизацию часов.
На сервер поступают пакет выпуска, файл конфигурации и образы контейнеров. Исходный код на сервер никогда не попадает, и сервер никогда не обращается к репозиторию кода.
Установка
-
Скопируйте пакет программы установки на сервер и распакуйте его:
tar -xzf excubius-installer-0.4.0.tar.gzcd excubius-installer-0.4.0 -
При необходимости запустите только предварительные проверки. Они ничего не изменяют:
sudo ./install.sh --check-only -
Запустите программу установки и ответьте на ее вопросы. Нажмите клавишу ВВОД, чтобы принять значение в квадратных скобках:
sudo ./install.shПрограмма установки сохраняет ваши ответы с указанием версии, поэтому при обновлении она задает только вопросы, появившиеся в новом выпуске.
-
Когда установка завершится, откройте публичный адрес, который выведет программа, и войдите от имени администратора, указанного во время установки. Затем настройте вход и пригласите пользователей, которые будут работать с Excubius.
Все действия программы установки записываются в журнал /var/log/excubius-install.log без секретов.
Вопросы программы установки
| Вопрос | Значение по умолчанию | Примечания |
|---|---|---|
| Каталог установки | /opt/excubius | Любой абсолютный путь |
| Учетная запись службы | excubius | Создается, если отсутствует. Запускает контейнеры без прав root |
| Публичный URL-адрес | https://monitoring.example.com | Адрес, который будут открывать пользователи. Его узел становится основным именем сервера |
| Псевдонимы | Нет | Другие имена, которые могут открывать пользователи, через пробел, например псевдоним в домене, которым вы управляете |
| TLS | letsencrypt | letsencrypt (по HTTP), letsencrypt-dns (по DNS), selfsigned, custom (ваши PEM-файлы), gateway (TLS завершается перед сервером) или later (пока обычный HTTP) |
| Имена в сертификате | all | Спрашивается при наличии псевдонимов: исключите имена, которые сертификат не может охватить |
| Адрес электронной почты для Let's Encrypt | — | Оба режима Let's Encrypt |
| Поставщик DNS и учетные данные | — | Только letsencrypt-dns: идентификатор dnsapi в acme.sh, например dns_cf, dns_dreamhost или dns_azure, и его переменные, которые вводятся по одной без отображения на экране |
| Файлы сертификата и ключа | — | Только custom: цепочка PEM, начиная с сертификата сервера, и незашифрованный ключ |
| Имя пользователя и пароль администратора | Предлагаемое имя пользователя | Учетная запись для первого входа по адресу, который программа установки выводит по завершении. Пароль должен содержать не менее 12 символов и вводится дважды |
| Базовая предустановка | enterprise | enterprise, databases или core; см. статью Настройка экземпляра |
| Пользователь и токен реестра | — | Предоставляются вместе с лицензией. Не запрашиваются для автономного пакета |
| Токен бота Slack и канал | — и #alerts | Необязательно; их можно задать позже. См. статью Настройка уведомлений Slack |
| Идентификатор клиента Entra ID (tenant ID), идентификатор приложения (client ID) и секрет | — | Необязательно; их можно задать позже |
В режиме Let's Encrypt программа установки затем проверяет имена в публичной системе DNS и по HTTP убеждается, что они указывают на этот сервер. Если это не так, она объясняет альтернативы, но установку из-за этого не прерывает.
Программа установки один раз создает пароль базы данных, секрет для подписи сеансов, ключ шифрования хранимых секретов и токен сборщика и никогда не запрашивает их. Как только платформа сохранит пароль администратора, учетные данные DNS и закрытый ключ, программа установки удаляет их из файла конфигурации.
Чтобы выполнить установку без вопросов, передайте ответы в файле с помощью параметра --answers; см. справочник по программе установки.
Имена и TLS
| Режим | Когда использовать |
|---|---|
| Let's Encrypt, проверка по HTTP | Имя публично разрешается в адрес сервера, и порт 80 доступен из Интернета |
| Let's Encrypt, проверка по DNS | Сервер находится в частной сети, но вы можете создавать записи DNS через API |
| Собственный сертификат | Ваша организация выпускает сертификаты |
| Самозаверяющий | Лаборатория или первый тест |
| Шлюз | TLS завершает подсистема балансировки нагрузки или обратный прокси-сервер перед сервером |
| Обычный HTTP | Первый тест или сеть, которой вы полностью доверяете |
Имена и сертификат можно изменить позже в разделе Settings без переустановки, а продление выполняется автоматически. См. статью Настройка имен и TLS.
Обновление, переустановка и удаление
| Команда | Что она делает |
|---|---|
sudo ./install.sh на сервере с установленным продуктом | Предлагает Upgrade (сохраняет данные и задает только новые вопросы), Reinstall, Purge and install fresh или Cancel |
sudo ./install.sh --uninstall | Создает последнюю резервную копию базы данных, затем удаляет службы и образы. Сохраняет данные, резервные копии и конфигурацию |
sudo ./install.sh --uninstall --purge | Также удаляет данные, резервные копии и учетную запись службы. Просит ввести purge |
Выполняйте обновление в окне изменений. Службы перезапускаются на несколько секунд, и выполняются миграции базы данных. Перед началом прочитайте известные проблемы этой версии.
Параметр --dry-run работает с каждой командой и только выводит, что произойдет. Порядок обновления, отката, резервного копирования и восстановления описан в статье Обновление, резервное копирование и восстановление для пользователей, выполнивших вход.
Внешнее наблюдение за Excubius
Excubius не должен быть единственным, кто наблюдает за самим собой. Зарегистрируйте https://<your server>/heartbeat во внешней системе наблюдения, например в тесте доступности Azure Monitor, в экземпляре Uptime Kuma, работающем в другом месте, или в службе наподобие healthchecks, и настройте ее так, чтобы она оповещала вас, когда адрес перестает отвечать ok. Если сервер остановится, именно эта система сообщит вам об этом.
/heartbeat и /healthz отвечают по обычному HTTP в любом режиме TLS. /healthz также возвращает работающую версию.