安装 Web 界面

选择文档版本： 18.4.0

• 18.3.0
• 18.1.0

本页面介绍了如何安装 AlloyDB Omni Web 用户界面，以便监控自行管理的数据库集群的运行状况和配置。Web 界面提供以下功能：

功能	说明	容器（独立）	Kubernetes	RPM (Linux)	RPM 编排器
集群选择	一个连接界面，可让您建立、注册和保存连接凭据，以便访问目标集群。	支持	支持	支持	支持
集群概览	显示所有活跃集群实例和遥测图表的观测信息中心。	部分支持。不支持遥测图。	支持	支持	支持
数据库	概览页面，显示集群上的目录表和数据库大小。	支持	支持	支持	支持
列式引擎	分析查询的配置设置和扫描执行统计信息。	支持	支持	支持	支持
数据库标志	观察板，显示与默认设置不同的有效标志和配置。	支持	支持	支持	支持
Query Insights	遥测和查询性能信息中心，显示结构化直方图和慢查询列表。	支持	支持	支持	支持
系统数据分析	显示 CPU 消耗、内存占用和磁盘 I/O 的遥测图表。	不支持	支持	支持	支持

准备工作

在安装 Web 界面之前，请完成以下前提条件：

1. 获取部署所需的映像，并下载和安装 AlloyDB Omni，以便使用 Web 界面： 使用 RPM 编排器安装 AlloyDB Omni。

2. 配置数据库用户。

   Web 界面依赖于一个受限用户账号，该账号具有用于访问数据库的 pg_monitor 角色。在 psql 会话中运行以下命令，在每个集群上配置此用户：

   CREATE ROLE alloydbui WITH LOGIN PASSWORD 'PASSWORD';
   GRANT pg_monitor TO alloydbui WITH INHERIT TRUE;
   

   将 PASSWORD 替换为 alloydbui 数据库角色的密码。

   注意 ：alloydbui 用户需要特定权限才能填充界面中的某些部分。例如，alloydbui 用户至少需要对表拥有 1 项权限才能查看“列式存储”部分中的数据，对表拥有 SELECT 权限才能查看“向量列”部分中的数据，对 pg_stat_ann_indexes 拥有 SELECT 权限才能查看向量索引。授予这些权限时，请考虑您的安全要求。

3. 配置 AlloyDB Omni 监控代理。

   使用 RPM 运行 AlloyDB Omni 时，alloydbomni_monitor 监控代理在同一代码库中作为单独的 RPM 软件包提供。如需了解详情，请参阅安装并启动 AlloyDB Omni 监控、配置 AlloyDB Omni 监控和验证 AlloyDB Omni 监控。

   如果您的安装使用自定义数据目录 (PG_DATA_DIR)，请配置 /etc/systemd/system/alloydbomni_monitor.service.d/override.conf 并重启监控服务：

   sudo mkdir -p /etc/systemd/system/alloydbomni_monitor.service.d
   sudo tee /etc/systemd/system/alloydbomni_monitor.service.d/override.conf <<'EOF'
   [Service]
   Environment="PG_DATA_DIR=PG_DATA_DIR"
   EOF
   sudo systemctl daemon-reload
   sudo systemctl restart alloydbomni_monitor
   

   将 PG_DATA_DIR 替换为数据库数据目录的路径，例如 /var/lib/postgresql/18/data 或 /data。

   如需验证监控代理是否处于活跃状态并正在导出指标，请运行 sudo systemctl status alloydbomni_monitor 和 curl http://localhost:9187/metrics。

   注意： 为了让 Web 界面显示最大 CPU 和内存统计信息（alloydb_omni_memory_limit_byte、alloydb_omni_memory_available_byte和 alloydb_omni_node_cpu_mcpu），请在 AlloyDB Omni 服务的 systemd 替换文件中配置 CPUQuota 和 MemoryMax。您可以将配额值设置为 100%（无限制），以便监控代理导出最大资源指标。如需了解详情，请参阅监控限制。如需配置这些限制，请运行以下命令：

   sudo mkdir -p /etc/systemd/system/alloydbomni18.service.d
   sudo tee /etc/systemd/system/alloydbomni18.service.d/override.conf <<'EOF'
   [Service]
   CPUQuota=100%
   MemoryMax=100%
   IOAccounting=yes
   EOF
   sudo systemctl daemon-reload
   sudo systemctl restart alloydbomni18
   

4. 配置 Prometheus。

   如需在概览和系统分析洞见页面上查看图表数据（包括 CPU 使用率），请安装并配置 Prometheus。 按照选择并安装监控工具中的安装和配置说明进行操作。

可选步骤

如需启用其他 Web 界面功能，请完成以下可选配置：

• Query Insights 设置

  如需使用 Query Insights 功能，请启用 pg_stat_statements 扩展程序。 在 psql 会话中，运行以下命令来配置库：

  ALTER SYSTEM SET shared_preload_libraries=google_columnar_engine,google_job_scheduler,google_storage,google_db_advisor,pg_stat_statements;
  ALTER SYSTEM SET pg_stat_statements.max = 10000;
  ALTER SYSTEM SET pg_stat_statements.track_utility = on;
  ALTER SYSTEM SET track_io_timing = on;
  

  然后，在每个数据库中分别运行以下命令以创建扩展程序：

  CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
  

  重启数据库，使这些更改生效。如果您打算启用列式引擎，请等到该设置完成后再重启。

• 列式引擎设置

  如需在 Web 界面中访问列式引擎数据，请按照列式引擎概览中的说明配置引擎。

  注意 ：如需在 Web 界面中的列式查询页面中查看数据，您必须按照Query Insights 设置部分中的说明安装和配置 pg_stat_statements 扩展程序。

• AlloyDB AI 设置

  如需在 Web 界面中使用 AlloyDB AI 功能，请授予以下权限：

  • 如需填充向量索引，请向 alloydbui 用户授予对 pg_stat_ann_indexes 的 SELECT 权限。
  • 如需显示向量列，请向 alloydbui 用户授予对表的 SELECT 权限。

如需了解详情，请参阅使用 AlloyDB AI 构建生成式 AI 应用。

安装 Web 界面

您可以在任何节点上安装和运行 Web 界面。Web 界面不需要专用节点。完整安装需要大约 250 MB 的磁盘可用空间。获取部署所需的映像并下载 AlloyDB Omni 后，您就可以安装并运行 Web 界面。

使用 RPM 安装

Google 使用 Linux 软件包签名密钥对 AlloyDB Omni RPM 软件包进行签名。如需使用 GPG 签名验证配置 YUM 代码库并安装 Web 界面 RPM 软件包，请完成以下步骤：

1. 在本地目录中配置 YUM 代码库：

   sudo tee -a /etc/yum.repos.d/alloydbomni_ui.repo << EOF
   [alloydbomni_ui]
   name=alloydbomni_ui
   baseurl=ALLOYDB_OMNI_COMMON_REPOSITORY_URL
   enabled=1
   repo_gpgcheck=1
   gpgcheck=1
   gpgkey=https://dl.google.com/linux/linux_signing_key.pub
   EOF
   

   sudo yum makecache
   

   将 ALLOYDB_OMNI_COMMON_REPOSITORY_URL 替换为 AlloyDB Omni 通用代码库的网址。

   注意： 如果您已在此主机上配置 AlloyDB Omni 通用代码库（例如，为了安装 alloydbomni_monitor 软件包），则此步骤是可选的。

2. 安装 Web 界面 RPM 软件包：

   sudo dnf install alloydbomni_ui
   

启动 Web 界面

Web 界面使用 Java 密钥库来保护用于加密连接数据的 256 位 AES 密钥。启动 Web 界面时，请指定包含密码的环境变量。

注意 ：默认情况下，Web 界面在端口 9080 上提供 HTTP 流量，不提供内置 TLS (HTTPS) 终止。如需使用 HTTPS 保护流向 Web 界面的流量，请将 Web 界面托管在配置了 TLS 证书的反向代理后面。

在 Linux 上启动 Web 界面

export ALLOYDB_OMNI_UI_KEYSTORE="PASSWORD"
/opt/alloydbomni/app/alloydb-ui/app/bin/alloydb

将 PASSWORD 替换为 ALLOYDB_OMNI_UI_KEYSTORE 的密钥库密码。

打开 Web 界面

如需查看 Web 界面，请在浏览器中打开 http://HOST:9080。

将 HOST 替换为安装了 Web 界面的节点的主机名或 IP 地址。

• 如果您使用可选的 ALLOYDB_OMNI_BASE_PATH 环境变量配置了自定义基本路径（例如在现有反向代理后面托管时），则必须将该路径附加到网址：http://HOST:9080/BASE_PATH。

  将 BASE_PATH 替换为您的自定义基本路径。

• 您可以配置不带前导斜杠的基本路径，例如 ALLOYDB_OMNI_BASE_PATH=BASE_PATH。以下所有选项都是有效的替代方案：

  • /test/
  • test/
  • test
  • /test

限制

Web 界面具有以下限制：

• 连接到 AlloyDB Omni 独立容器部署时，概览图表和系统数据分析不可用，因为独立容器部署不提供容器化监控代理。所有其他非图表功能和指标仍可正常使用。

• 如需查看给定表的列式引擎数据，alloydbui 用户需要对该表至少拥有一项权限，例如 SELECT。

• 如需查看向量索引数据，alloydbui 用户需要对 pg_stat_ann_indexes 拥有 SELECT 权限。

• 如需查看给定表的向量列数据，alloydbui 用户需要对该表拥有 SELECT 权限。

最佳实践和注意事项

在安装和配置 Web 界面时，请遵循以下最佳实践和注意事项：

• 密钥库密码保护：Web 界面会生成 Java 密钥库，以保护 256 位 AES 数据库加密密钥。为 ALLOYDB_OMNI_UI_KEYSTORE 使用安全系数高的口令。如果您转移配置文件并使用不匹配的密钥库密码进行连接，则会发生解密错误。
• Prometheus 指标抓取：将抓取工具配置为以标准时间间隔（15 秒到 30 秒）轮询目标实例，以便在不使数据库节点过载的情况下查询统计信息。

注意： 在 RPM 虚拟机安装中，连接文件会保存到活跃系统用户的主目录 (~/.config/) 中。请为此目录配置适当的文件权限，以防止其他系统账号读取凭据。

后续步骤

• 连接到 Web 界面。