Справочник по установщику
Установщик install.sh устанавливает, обновляет, переустанавливает и удаляет Excubius на одном сервере. Он запускается от имени root из распакованного пакета установщика. В этом справочнике перечислены его параметры, предварительные проверки, вопросы, которые он задает, и то, что он оставляет на сервере. Порядок установки описан в статье Установка Excubius.
sudo ./install.sh [options]
Параметры
| Параметр | Действие |
|---|---|
| (нет) | Установка. На сервере, где Excubius уже установлен, предлагает Upgrade (по умолчанию: сохраняет данные и параметры и задает только вопросы, появившиеся в этой версии), Reinstall, Purge или Cancel |
--check-only | Выполнить только предварительные проверки. Ничего не меняет |
--images FILE | Установить из архива образов без доступа к реестру. Архив в каталоге images/ рядом со скриптом, как в автономном пакете, используется автоматически |
--answers FILE | Неинтерактивный режим: строки key=value, включая секреты. См. раздел Файл ответов |
--reconfigure | При обновлении заново задать все вопросы. Ответы по TLS, данные при этом, применяются к работающей платформе |
--reinstall | Удалить установленное программное обеспечение с сохранением базы данных, затем выполнить установку, задав все вопросы |
--purge | Удалить все, включая базу данных, затем выполнить установку с нуля |
--uninstall | Удалить программное обеспечение. Сначала записывает итоговый дамп базы данных в <dir>/backups/, затем удаляет пользовательские юниты, контейнеры, образы, <dir>/releases, <dir>/current, /etc/excubius и параметр портов для режима rootless. Сохраняет тома базы данных и сертификатов, <dir>/backups, <dir>/.env и служебную учетную запись, чтобы последующая установка нашла данные |
--uninstall --purge | Также удалить все тома, весь каталог установки с резервными копиями, служебную учетную запись, созданную установщиком, вместе с хранилищем ее контейнеров и службы брандмауэра, добавленные установкой. Просит ввести purge |
--no-backup | Не создавать итоговый дамп базы данных при --uninstall или --reinstall |
--yes, -y | Принять все имеющиеся значения по умолчанию; обязательные ответы по-прежнему должны поступать из --answers или с клавиатуры. На сервере с установленной платформой означает Upgrade и подтверждает полное удаление |
--dry-run | Вывести то, что будет сделано, ничего не меняя. При установке файлы конфигурации все равно записываются для проверки; рядом с существующим .env — как .env.dry-run |
--skip-checks | Продолжить, даже если предварительные проверки не пройдены, в неподдерживаемых системах, на ваш страх и риск |
--help, -h | Вывести список параметров |
Следующие сочетания отклоняются: --uninstall с --reinstall или --reconfigure; --purge с --reinstall; --check-only с --uninstall, --purge или --reinstall; --reconfigure с --purge или --reinstall.
Удаляется только записанный каталог установки — никогда системный путь или домашний каталог.
Предварительные проверки
| Проверка | Требование | Если не выполнено |
|---|---|---|
| Операционная система | Rocky Linux или другая система семейства RHEL | Ошибка |
| Основная версия | 9 или 10 | Предупреждение |
| Архитектура | x86-64 | Ошибка |
| Система инициализации | systemd | Ошибка |
| Диспетчер пакетов | dnf | Ошибка |
| Память | 4 ГиБ | Предупреждение |
| Процессоры | 2 vCPU | Предупреждение |
| Диск | 20 ГиБ свободно в /home, где служебная учетная запись хранит образы и базу данных | Предупреждение |
| Порты | 80 и 443 свободны при новой установке | Ошибка |
| SELinux | Сообщается состояние | — |
| Реестры | ghcr.io и docker.io доступны по HTTPS, или есть читаемый архив образов | Ошибка |
| Часы | Синхронизированы | Предупреждение; включается chrony |
Вопросы
Нажмите клавишу ВВОД, чтобы принять значение в квадратных скобках. При обновлении задаются только вопросы, появившиеся после версии, которая записала ваши ответы; столбец С версии показывает, в какой версии появился каждый вопрос.
| Ключ | Вопрос | По умолчанию | Когда задается | С версии |
|---|---|---|---|---|
install_dir | Каталог установки | /opt/excubius | Всегда; абсолютный путь | 0.2.0 |
service_user | Служебная учетная запись, от имени которой работает платформа | excubius | Всегда; создается при отсутствии, запускает контейнеры в режиме rootless | 0.2.0 |
public_url | Общедоступный URL-адрес, который будут открывать пользователи | https://monitoring.example.com | Всегда; его узел — основное имя сервера | 0.2.0 |
server_aliases | Другие имена этого сервера | нет | Всегда; через пробел, ВВОД — без имен | 0.3.0 |
tls_mode | Как предоставляется HTTPS | letsencrypt | Всегда: letsencrypt, letsencrypt-dns, selfsigned, custom, gateway или later | 0.2.0 |
tls_cert_names | Имена для сертификата | all | Есть псевдонимы, и режим создает сертификат | 0.3.0 |
tls_email | Адрес электронной почты для учетной записи Let's Encrypt | — | letsencrypt или letsencrypt-dns | 0.2.0 |
tls_dns_provider | Поставщик DNS для зоны имен | — | letsencrypt-dns; идентификатор dnsapi в acme.sh, например dns_cf, dns_dreamhost или dns_azure | 0.3.0 |
tls_dns_credentials | Учетные данные API DNS | — | letsencrypt-dns; вводятся по одному без отображения | 0.3.0 |
tls_cert_file | Файл цепочки сертификатов | — | custom; PEM, сертификат сервера первым | 0.3.0 |
tls_key_file | Файл закрытого ключа | — | custom; PEM без парольной фразы, соответствует сертификату | 0.3.0 |
default_preset | Базовая предустановка | enterprise | Всегда: enterprise, databases или core | 0.2.0 |
registry_user, registry_token | Пользователь реестра и токен только для чтения для образов | — | Без архива образов | 0.2.0 |
slack_bot_token | Токен бота Slack | — | Всегда; необязательно | 0.2.0 |
slack_default_channel | Канал Slack для оповещений | #alerts | Всегда | 0.2.0 |
entra_tenant_id | Идентификатор клиента Entra ID для входа | — | Всегда; необязательно | 0.2.0 |
entra_client_id, entra_client_secret | Идентификатор приложения и секрет клиента Entra ID | — | Указан идентификатор клиента | 0.2.0 |
Режимы TLS:
| Режим | Когда использовать |
|---|---|
letsencrypt | Все имена есть в общедоступной DNS и указывают на сервер, а порт 80 доступен из Интернета |
letsencrypt-dns | У вас есть учетные данные API для зоны DNS этих имен. Сервер не обязан быть доступен из Интернета |
selfsigned | Где угодно. Браузеры выводят предупреждение, пока пользователи не начнут доверять сертификату |
custom | Сертификат выпускает ваша организация |
gateway | TLS завершается на подсистеме балансировки нагрузки или обратном прокси-сервере перед сервером |
later | Пока обычный HTTP |
В режимах Let's Encrypt установщик проверяет имена в общедоступной DNS и по HTTP проверяет, что они указывают на этот сервер. Если это не так, он объясняет альтернативы, но никогда не останавливается из-за этого. Ответы по TLS только задают начальные параметры платформы; после этого они управляются в Settings › Server.
Создаваемые значения
Установщик создает следующие значения один раз и никогда их не перезаписывает: пароль базы данных (POSTGRES_PASSWORD), секрет подписи сеансов (JWT_SECRET), ключ шифрования хранимых секретов (EXCUBIUS_DATA_KEY) и токен сборщика (EXCUBIUS_COLLECTOR_TOKEN). См. статью Переменные среды.
Файл ответов
Для автоматической установки передайте --answers FILE с одной строкой key=value на каждый вопрос. Этот файл содержит секреты: защитите его и удалите после установки. Учетные данные DNS указываются в одной строке через ;. Для отсутствующего ответа берется значение по умолчанию; если обязательный ответ отсутствует или недопустим, установщик останавливается и называет ключ, чтобы вы могли дополнить файл и запустить установку снова.
Фрагмент:
install_dir=/opt/excubius
service_user=excubius
public_url=https://monitoring.areito.example
server_aliases=
tls_mode=letsencrypt-dns
tls_email=ops@areito.example
tls_dns_provider=dns_cf
tls_dns_credentials=CF_Token=<token>
default_preset=enterprise
registry_user=<registry user>
registry_token=<read-only token>
slack_bot_token=<bot token>
slack_default_channel=#areito-alerts
sudo ./install.sh --answers ./answers.conf --yes
Обновления и ответы с версиями
Установщик записывает ваши несекретные ответы в <dir>/install.answers вместе с версией установщика, которая их записала, и признаком того, завершился ли этот запуск. При обновлении он задает только вопросы, появившиеся после этой версии. Незавершенный запуск считается новой установкой: все вопросы задаются снова, а прежние ответы предлагаются как значения по умолчанию. Секреты никогда не записываются в install.answers.
На сервере
| Путь | Содержимое |
|---|---|
<dir>/.env | Конфигурация и секреты; режим 0600, владелец — служебная учетная запись |
<dir>/install.answers | Ваши несекретные ответы, версия, которая их записала, и признак завершения этого запуска |
<dir>/current | Установленный выпуск — ссылка в <dir>/releases/ |
<dir>/backups | Ежедневные дампы базы данных (хранятся последние 14) и итоговый дамп при удалении |
~<service account>/.config/systemd/user/ | excubius.service и таймер резервного копирования |
/var/log/excubius-install.log | Журнал установщика без секретов |
От имени служебной учетной записи:
sudo -iu excubius
export XDG_RUNTIME_DIR=/run/user/$(id -u) # once per shell, for systemctl --user
systemctl --user status excubius # the platform
<dir>/current/scripts/compose.sh ps # the containers
<dir>/current/scripts/compose.sh logs -f backend # the API's log
<dir>/current/scripts/backup-db.sh # a database backup now
<dir>/current/scripts/enable-tls.sh --status # TLS without the console
<dir>/current/scripts/rollback.sh # back to the previous release