如何配置环境变量

Katib 组件接受的环境变量列表

本指南介绍了每个 Katib 组件的环境变量。如果您想更改 Katib 安装,可以修改其中一些变量。

在下面的表格中,您可以找到每个 Katib 组件中所有环境变量的描述、默认值和强制属性。如果某个变量是强制的,则需要在相应的 Katib 组件清单文件中设置相关的环境变量。

Katib Controller

以下是 Katib Controller 部署的环境变量

变量描述默认值强制
KATIB_CORE_NAMESPACE所有 Katib 组件和默认实验的基础命名空间metadata.namespace
KATIB_SUGGESTION_COMPOSER用于 Katib 建议的Composer。您可以使用自己的 Composergeneral
KATIB_DB_MANAGER_SERVICE_NAMESPACEKatib DB Manager 命名空间KATIB_CORE_NAMESPACE 环境变量
KATIB_DB_MANAGER_SERVICE_IPKatib DB Manager IPkatib-db-manager
KATIB_DB_MANAGER_SERVICE_PORTKatib DB Manager 端口6789

Katib Controller 使用此地址表达式调用 Katib DB Manager

KATIB_DB_MANAGER_SERVICE_IP.KATIB_DB_MANAGER_SERVICE_NAMESPACE:KATIB_DB_MANAGER_SERVICE_PORT

如果您设置 KATIB_DB_MANAGER_SERVICE_NAMESPACE="",Katib Controller 将使用此地址调用 Katib DB Manager

KATIB_DB_MANAGER_SERVICE_IP:KATIB_DB_MANAGER_SERVICE_PORT

如果您想使用自己的 DB Manager 报告 Katib 指标,可以更改 KATIB_DB_MANAGER_SERVICE_NAMESPACEKATIB_DB_MANAGER_SERVICE_IPKATIB_DB_MANAGER_SERVICE_PORT 变量。

Katib UI

以下是 Katib UI 部署的环境变量

变量描述默认值强制
KATIB_CORE_NAMESPACE所有 Katib 组件和默认实验的基础命名空间metadata.namespace
KATIB_DB_MANAGER_SERVICE_NAMESPACEKatib DB Manager 命名空间KATIB_CORE_NAMESPACE 环境变量
KATIB_DB_MANAGER_SERVICE_IPKatib DB Manager IPkatib-db-manager
KATIB_DB_MANAGER_SERVICE_PORTKatib DB Manager 端口6789

Katib UI 使用与 Katib Controller 相同的地址表达式调用 Katib DB Manager。

Katib DB Manager

以下是 Katib DB Manager 部署的环境变量

变量描述默认值强制
DB_NAMEKatib 数据库名称:'mysql' 或 'postgres'
DB_PASSWORDKatib 数据库密码test (MySQL)
katib (Postgres)
DB_USERKatib 数据库用户root (MySQL)
katib (Postgres)
KATIB_MYSQL_DB_HOSTKatib MySQL 主机katib-mysql
KATIB_MYSQL_DB_PORTKatib MySQL 端口3306
KATIB_MYSQL_DB_DATABASEKatib MySQL 数据库名称katib
KATIB_POSTGRESQL_DB_HOSTKatib Postgres 主机katib-postgres
KATIB_POSTGRESQL_DB_PORTKatib Postgres 端口5432
KATIB_POSTGRESQL_DB_DATABASEKatib Postgres 数据库名称katib
KATIB_POSTGRESQL_SSL_MODEKatib Postgres SSL 模式disable
SKIP_DB_INITIALIZATION跳过数据库表初始化的选项false

目前,Katib DB Manager 仅支持 MySQLPostgres 数据库。(DB_NAME 环境变量必须填写 mysqlpostgres 之一)。但是,您可以通过实现 katib db 接口 来使用自己的 DB Manager 和数据库报告指标。

对于 Katib DB Manager,您可以将 DB_PASSWORD 更改为您自己的数据库密码。

Katib DB Manager 根据数据库类型创建数据库连接。
如果 DB_NAME=mysql,它使用 mysql 驱动程序和此数据源名称
DB_USER:DB_PASSWORD@tcp(KATIB_MYSQL_DB_HOST:KATIB_MYSQL_DB_PORT)/KATIB_MYSQL_DB_DATABASE?timeout=5s

如果 DB_NAME=postgres,它使用 pq 驱动程序和此数据源名称
postgresql://[DB_USER[:DB_PASSWORD]@][KATIB_POSTGRESQL_DB_HOST][:KATIB_POSTGRESQL_DB_PORT][/KATIB_POSTGRESQL_DB_DATABASE]

Katib DB

Katib DB 组件支持 MySQL 和 Postgres。

Katib MySQL

对于 Katib MySQL,您需要设置这些环境变量

  • MYSQL_ROOT_PASSWORD 设置为 katib-mysql-secrets 中的值,该值等于 “test”。
  • MYSQL_ALLOW_EMPTY_PASSWORD 设置为 true
  • MYSQL_DATABASE 设置为 katib

您可以参考 MySQL Docker 镜像的所有环境变量列表。

Katib MySQL 环境变量必须与 Katib DB Manager 环境变量匹配,这意味着

  1. MYSQL_ROOT_PASSWORD = DB_PASSWORD
  2. MYSQL_DATABASE = KATIB_MYSQL_DB_DATABASE

Katib Postgres

对于 Katib Postgres,您需要设置这些环境变量

  • POSTGRES_USERPOSTGRES_PASSWORDPOSTGRES_DB 设置为 katib-postgres-secrets 中的值,这些值等于 “katib”。

您可以参考 Postgres Docker 镜像的所有环境变量列表。

Katib Postgres 环境变量必须与 Katib DB Manager 环境变量匹配,这意味着

  1. POSTGRES_USER = DB_USER
  2. POSTGRES_PASSWORD = DB_PASSWORD
  3. POSTGRES_DB = KATIB_POSTGRESQL_DB_DATABASE

后续步骤

  • 了解安装 Katib 的不同选项

反馈

此页面有帮助吗?


上次修改时间:2025年2月10日:Katib: 更新 env-variables.md (#3987) (39839ca)