Olares

简体中文

English

简体中文

English

Appearance

声明式环境变量 ​

在 OlaresManifest.yaml 中使用 envs 字段来声明配置参数，例如密码、API 端点或功能开关。在部署过程中，app-service 会解析这些变量，并将其注入到 values.yaml 的 .Values.olaresEnv 中。你可以在 Helm 模板中通过 {{ .Values.olaresEnv.<envName> }} 引用。

变量来源 ​

声明式变量可以从应用外部管理的配置中获取值：

  • 系统变量：Olares 集群实例级别的环境变量，在系统安装时设置，或由管理员统一管理。集群中的所有用户共享。
  • 用户变量：Olares 用户级别的环境变量，由用户自行管理。在同一集群中，不同用户的变量彼此独立。

应用本身无法直接修改这些变量。如需使用，需通过 valueFrom 字段映射。

映射环境变量 ​

系统环境变量和用户环境变量都通过 valueFrom 使用相同的映射机制。

以下示例演示了如何将系统变量 OLARES_SYSTEM_CDN_SERVICE 映射为应用变量 APP_CDN_ENDPOINT：

  1. 在 OlaresManifest.yaml 中，在 envs 下声明一个应用变量，并将 valueFrom.envName 设置为系统变量名。

    yaml
    # 将系统变量 OLARES_SYSTEM_CDN_SERVICE 映射为应用变量 APP_CDN_ENDPOINT
olaresManifest.version: '0.10.0'
olaresManifest.type: app

envs:
  - envName: APP_CDN_ENDPOINT
    required: true
    applyOnChange: true
    valueFrom:
      envName: OLARES_SYSTEM_CDN_SERVICE

  2. 在 Helm 模板中，通过 .Values.olaresEnv.<envName> 引用该应用变量。

    yaml
    # 在容器环境变量中使用 APP_CDN_ENDPOINT
env:
  - name: CDN_ENDPOINT
    value: "{{ .Values.olaresEnv.APP_CDN_ENDPOINT }}"

部署时，app-service 会解析引用的变量，并将值注入到 values.yaml 中：

yaml
# 由 app-service 在部署时注入
olaresEnv:
  APP_CDN_ENDPOINT: "https://cdn.olares.com"

可用环境变量的完整列表，请参阅变量参考。

声明字段 ​

envs 列表中的每个条目支持以下字段。

envName ​

注入到 values.yaml 中的变量名。在模板中通过 {{ .Values.olaresEnv.<envName> }} 引用。

default ​

变量的默认值。由开发者在编写应用时提供。用户不可修改。当用户未提供值或未通过 valueFrom 引用时使用。

valueFrom ​

将当前变量映射到系统或用户环境变量。设置后，当前变量将继承所引用变量的所有字段（如 type、editable、regex 等）。当前变量本地定义的同名字段将被忽略。使用 valueFrom 时，default 和 options 不生效。

示例： 将应用变量 APP_CDN_ENDPOINT 映射到系统变量 OLARES_SYSTEM_CDN_SERVICE。

yaml
envs:
  - envName: APP_CDN_ENDPOINT
    required: true
    applyOnChange: true
    valueFrom:
      envName: OLARES_SYSTEM_CDN_SERVICE

required ​

布尔值。为 true 时，安装必须提供该变量值。如果未设置 default，系统会提示用户输入。安装后该值不能设为空。

editable ​

布尔值。为 true 时，该变量在安装后允许修改。

applyOnChange ​

布尔值。为 true 时，修改该变量会自动重启使用该变量的应用或组件。为 false 时，修改仅在应用升级或重装后生效。手动停止和启动应用不会使其生效。

type ​

值的预期类型。用于在接受输入前进行校验。支持的类型包括：int、bool、url、ip、domain、email、string、password。

regex ​

值必须匹配的正则表达式。如果校验失败，则无法设置该值，且安装或升级可能失败。

options ​

将变量限制为固定的可选值列表。系统会在界面中提供选择界面。

示例：显示可安装的 Windows 版本的下拉列表。

yaml
envs:
  - envName: VERSION
    options:
      - title: "Windows 11 Pro"
        value: "iso/Win11_24H2_English_x64.iso"
      - title: "Windows 7 Ultimate"
        value: "iso/win7_sp1_x64_1.iso"

remoteOptions ​

从 URL 加载选项列表，而不是在行内定义。响应体必须是与 options 格式相同的 JSON 编码数组。

示例：在安装时从远程端点获取选项列表。

yaml
envs:
  - envName: VERSION
    remoteOptions: https://app.cdn.olares.com/appstore/windows/version_options.json

description ​

变量用途及有效取值范围的说明。显示在 Olares 界面中。

变量参考 ​

系统环境变量 ​

下表列出了可通过 valueFrom 引用的系统级环境变量。

变量类型默认值可编辑必填描述
OLARES_SYSTEM_REMOTE_SERVICEurlhttps://api.olares.com是是Olares 远程服务端点，例如应用商店与 Olares Space。
OLARES_SYSTEM_CDN_SERVICEurlhttps://cdn.olares.com是是系统资源 CDN 端点。
OLARES_SYSTEM_DOCKERHUB_SERVICEurl无是否Docker Hub 镜像或加速端点。
OLARES_SYSTEM_ROOT_PATHstring/olares否是Olares 根目录路径。
OLARES_SYSTEM_ROOTFS_TYPEstringfs否是Olares 文件系统类型。
OLARES_SYSTEM_CUDA_VERSIONstring无否否主机 CUDA 版本。

用户环境变量 ​

所有用户环境变量均可由用户编辑。

用户信息 ​

变量类型默认值描述
OLARES_USER_EMAILstring无用户邮箱地址。
OLARES_USER_USERNAMEstring无用户名。
OLARES_USER_PASSWORDpassword无用户密码。
OLARES_USER_TIMEZONEstring无用户时区，例如 Asia/Shanghai。

SMTP 设置 ​

变量类型默认值描述
OLARES_USER_SMTP_ENABLEDbool无是否启用 SMTP。
OLARES_USER_SMTP_SERVERdomain无SMTP 服务器域名。
OLARES_USER_SMTP_PORTint无SMTP 服务端口，通常为 465 或 587。
OLARES_USER_SMTP_USERNAMEstring无SMTP 用户名。
OLARES_USER_SMTP_PASSWORDpassword无SMTP 密码或授权码。
OLARES_USER_SMTP_FROM_ADDRESSemail无发件人邮箱地址。
OLARES_USER_SMTP_SECUREbool"true"是否使用安全协议。
OLARES_USER_SMTP_USE_TLSbool无是否使用 TLS。
OLARES_USER_SMTP_USE_SSLbool无是否使用 SSL。
OLARES_USER_SMTP_SECURITY_PROTOCOLSstring无安全协议类型，可选值包括：tls、ssl、starttls、none。

镜像与代理端点 ​

变量类型默认值描述
OLARES_USER_HUGGINGFACE_SERVICEurlhttps://huggingface.co/Hugging Face 服务地址。
OLARES_USER_HUGGINGFACE_TOKENstring无Hugging Face 访问令牌。
OLARES_USER_PYPI_SERVICEurlhttps://pypi.org/simple/PyPI 镜像地址。
OLARES_USER_GITHUB_SERVICEurlhttps://github.com/GitHub 镜像地址。
OLARES_USER_GITHUB_TOKENstring无GitHub 个人访问令牌。

API keys ​

变量类型默认值描述
OLARES_USER_OPENAI_APIKEYpassword无OpenAI API key。
OLARES_USER_CUSTOM_OPENAI_SERVICEurl无自定义 OpenAI 兼容服务地址。
OLARES_USER_CUSTOM_OPENAI_APIKEYpassword无自定义 OpenAI 兼容服务的 API key。