安装 Excubius
Excubius 运行在你自己控制的一台 Linux 服务器上,可以位于你的云订阅中,也可以位于你的数据中心。交互式安装程序会检查服务器、提出几个简短的问题、安装容器并获取证书。本文列出你需要准备的内容、安装程序提出的问题和执行的操作,以及后续每项任务该去哪里查看。
开始之前
| 项目 | 要求 |
|---|---|
| 服务器 | Rocky Linux 9 或 10(或其他 RHEL 系列系统),x86-64,systemd。至少 2 个 vCPU、4 GiB 内存和 20 GiB 可用磁盘空间;在 Azure 中,Standard_B2ms(2 个 vCPU,8 GiB)是一个不错的起点,之后可以调整大小。如果由你的云团队创建服务器,请参阅申请 Azure 服务器 |
| 访问权限 | 服务器上具有 sudo 权限的账户,可从你的工作站通过 SSH 访问 |
| 面向用户的网络 | 服务器上的 80 和 443 端口空闲,并且从用户使用 Excubius 的位置开放 |
| 出站 | 通过 HTTPS 访问 ghcr.io 和 docker.io 以拉取映像,除非你使用离线包 |
| 面向受监视系统的网络 | 从服务器出发,能访问每个实例、副本和侦听器 IP 的 SQL 端口(对于没有固定端口的命名实例,还需要 UDP 1434),以及你要测试的 Web 终结点的 HTTPS。没有任何连接指向采集器 |
| 安装包 | excubius-installer-<version>.tar.gz,或包含映像的离线包。已登录的用户可以在下载中获取这两个包 |
| 登录 | 一个 Microsoft Entra ID 应用注册、一个 Google OAuth 客户端,或两者都有。请参阅设置登录提供商 |
| 监视登录名 | 针对你要监视的系统的只读登录名,例如可用性组的先决条件中的 SQL Server 登录名 |
| 证书 | 若使用 Let's Encrypt,需要一个指向服务器的公共 DNS 名称,或对其 DNS 区域的 API 访问权限。如果使用你自己的证书、自签名证书,或由网关终止 TLS,则不需要 |
安装的工作方式
预检查涵盖操作系统及其版本、体系结构、systemd 和 dnf、内存、CPU、磁盘、空闲的 80 和 443 端口、SELinux、对注册表或映像存档的访问,以及时钟同步。
服务器接收发布包、一个配置文件和容器映像。它从不接收源代码,也从不连接代码存储库。
安装
-
将安装包复制到服务器并解压:
tar -xzf excubius-installer-0.4.0.tar.gzcd excubius-installer-0.4.0 -
也可以只运行预检查。预检查不会更改任何内容:
sudo ./install.sh --check-only -
运行安装程序并回答它的问题。按 Enter 接受括号中的值:
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:acme.sh 的 dnsapi 标识符,例如 dns_cf、dns_dreamhost 或 dns_azure,以及它的变量,逐个键入且不回显 |
| 证书和密钥文件 | — | 仅限 custom:PEM 证书链(服务器证书在前)和未加密的密钥 |
| 管理员用户名和密码 | 建议的用户名 | 用于首次登录的账户,登录地址是安装程序完成时打印的地址。密码至少 12 个字符,需要输入两次 |
| 基础预设 | enterprise | enterprise、databases 或 core;请参阅配置实例 |
| 注册表用户和令牌 | — | 随许可证一起提供。使用离线包时不会询问 |
| Slack 机器人令牌和频道 | — 和 #alerts | 可选;以后也可以设置。请参阅配置 Slack 通知 |
| Entra ID 租户 ID、客户端 ID 和客户端密码 | — | 可选;以后也可以设置 |
使用 Let's Encrypt 模式时,安装程序随后会在公共 DNS 中检查这些名称,并通过 HTTP 检查它们是否指向这台服务器。如果没有指向,它会说明可选的替代方案,但不会因此停止。
安装程序会一次性生成数据库密码、会话签名机密、加密所存储机密的密钥以及采集器令牌,之后不会再询问。平台存储管理员密码、DNS 凭据和私钥之后,会将它们从配置文件中删除。
若要免提问安装,请使用 --answers 通过文件传入回答;请参阅安装程序参考。
名称和 TLS
| 模式 | 适用情形 |
|---|---|
| Let's Encrypt,HTTP 验证 | 名称在公共 DNS 中解析到该服务器,并且 80 端口可从 Internet 访问 |
| Let's Encrypt,DNS 验证 | 服务器是私有的,但你可以通过 API 创建 DNS 记录 |
| 你自己的证书 | 你的组织自行颁发证书 |
| 自签名 | 实验环境或首次测试 |
| 网关 | 前端的负载均衡器或反向代理终止 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 在所有 TLS 模式下都通过纯 HTTP 响应。/healthz 还会返回正在运行的版本。