安裝程式參考
安裝程式 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/,然後移除 systemd 用戶單元、容器、映像、<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 GiB | 警告 |
| CPU | 2 vCPU | 警告 |
| 磁碟 | /home 下有 20 GiB 可用空間,服務帳戶的映像和數據庫都存放在此 | 警告 |
| 連接埠 | 全新安裝時,80 和 443 須為空閒 | 失敗 |
| SELinux | 僅回報 | — |
| 登錄庫 | 可透過 HTTPS 連線到 ghcr.io 和 docker.io,或有可讀取的映像封存檔 | 失敗 |
| 時鐘 | 已同步 | 警告;會啟用 chrony |
問題
按 Enter 即可接受方括號中的值。升級時,只會詢問在寫入你答案的版本之後新增的問題;引入版本欄指出每個問題是哪個版本引入的。
| 鍵 | 問題 | 預設值 | 詢問時機 | 引入版本 |
|---|---|---|---|---|
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 | 此伺服器的其他名稱 | 無 | 一律詢問;以空格分隔,無則按 Enter | 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;acme.sh dnsapi ID,例如 dns_cf、dns_dreamhost 或 dns_azure | 0.3.0 |
tls_dns_credentials | DNS API 憑證 | — | 模式為 letsencrypt-dns;逐項輸入,不會回顯 | 0.3.0 |
tls_cert_file | 證書鏈檔案 | — | 模式為 custom;PEM 格式,伺服器證書在最前 | 0.3.0 |
tls_key_file | 私密金鑰檔案 | — | 模式為 custom;PEM 格式,無密碼短語,且須與證書相符 | 0.3.0 |
default_preset | 基礎預設(preset) | enterprise | 一律詢問:enterprise、databases 或 core | 0.2.0 |
registry_user、registry_token | 映像的登錄庫用戶和唯讀權杖 | — | 沒有映像封存檔時 | 0.2.0 |
slack_bot_token | Slack bot 權杖 | — | 一律詢問;可選 | 0.2.0 |
slack_default_channel | 警報的 Slack 頻道 | #alerts | 一律詢問 | 0.2.0 |
entra_tenant_id | 用於登入的 Entra ID 租戶 ID | — | 一律詢問;可選 | 0.2.0 |
entra_client_id、entra_client_secret | Entra ID 應用程式 ID 和用戶端機密 | — | 已提供租戶 ID 時 | 0.2.0 |
TLS 模式:
| 模式 | 適用情況 |
|---|---|
letsencrypt | 每個名稱都在公共 DNS 中並指向該伺服器,而且可從互聯網連線到連接埠 80 |
letsencrypt-dns | 你有這些名稱所屬 DNS 區域的 API 憑證。伺服器無需可從互聯網連線 |
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