高级配置#
Config-template 文件参数定义#
虽然 config-template-examples 文件夹提供了可用的最简示例，但您可以更大程度地自定义 config-template.yml。下表详细解释了 config-template.yml 的每个属性。
参数名称 |
类型 |
可选 |
描述 |
|---|---|---|---|
schema_version |
字符串 |
Config-template schema 版本 |
|
名称 |
字符串 |
用于标识部署脚本正在创建的基础设施资源的唯一名称。 |
|
spec |
映射 |
基础设施和应用程序配置。 |
|
spec > infra |
字符串 |
基础设施配置。 |
|
spec > infra > csp |
字符串 |
云服务提供商名称，在本例中为 gcp |
|
spec > infra > backend |
映射 |
Terraform 后端配置，用于存储基础设施状态。 |
|
spec > infra > backend > bucket |
字符串 |
GCS 存储桶的名称，其中将存储已配置资源的状态。 |
|
spec > infra > backend > credentials |
字符串 |
GCP 服务帐户密钥文件的绝对路径，该文件具有访问状态存储桶的权限。 |
|
spec > infra > provider |
映射 |
GCP 提供商配置。 |
|
spec > infra > provider > project |
字符串 |
将在其中配置资源的 GCP 项目 ID。 |
|
spec > infra > provider > credentials |
字符串 |
GCP 服务帐户密钥文件的绝对路径，该文件具有配置资源的权限。 |
|
spec > infra > configs |
映射 |
附加基础设施配置。 |
|
spec > infra > configs > cns |
映射 |
是 |
Nvidia Cloud Native Stack 配置。有关 Cloud Native Stack 的更多详细信息，请访问：NVIDIA/cloud-native-stack。 |
spec > infra > configs > cns > version |
字符串 |
是 |
要在集群上安装的 Nvidia Cloud Native Stack 版本。默认为 12.2。 |
spec > infra > configs > cns > git_ref |
字符串 |
是 |
Nvidia Cloud Native Stack 的 git 提交哈希值。默认为 [NVIDIA/cloud-native-stack](NVIDIA/cloud-native-stack) 的 master 分支的最新提交哈希值。 |
spec > infra > configs > cns > override_values |
映射 |
是 |
在设置 Kubernetes 集群时要覆盖的 Nvidia Cloud Native Stack 值。 |
spec > infra > configs > cns > override_values > cns_nvidia_driver |
布尔值 |
是 |
如果您想使用 runfile 方法安装 Nvidia 驱动程序，请设置为“是”，否则设置为 否。将此标志设置为 是 以支持最新的 OS 内核。 |
spec > infra > configs > cns > override_values > gpu_driver_version |
字符串 |
是 |
在安装 Nvidia Cloud Native Stack 时覆盖 gpu_driver_version 的配置。 |
spec > infra > configs > user_access_cidrs |
列表 |
指定一个 CIDR 块，该块包含将访问 Tokkio UI 的所有客户端计算机的 IP 地址。 |
|
spec > infra > configs > dev_access_cidrs |
列表 |
指定一个 CIDR 块，该块包含需要 SSH 访问 Tokkio GCP 实例的所有开发人员计算机的 IP 地址。 |
|
spec > infra > configs > region |
字符串 |
将在其中部署应用程序资源的 GCP 区域。 |
|
spec > infra > configs > ui_bucket_location |
映射 |
使用存储桶托管静态 UI 的位置和区域详细信息。 |
|
spec > infra > configs > ui_bucket_location > location |
字符串 |
用于选择区域的 GCP 位置代码。 |
|
spec > infra > configs > ui_bucket_location > region |
字符串 |
双区域中的主区域，用于存储桶托管静态 UI。 |
|
spec > infra > configs > ui_bucket_location > alternate_region |
字符串 |
双区域中的辅助区域，用于存储桶托管静态 UI。 |
|
spec > infra > configs > ssh_private_key_path |
字符串 |
Controller 实例的私钥的绝对路径。 |
|
spec > infra > configs > ssh_public_key |
字符串 |
Controller 实例的公钥的绝对路径。 |
|
spec > infra > configs > additional_ssh_public_keys |
列表 |
是 |
将添加到应用程序实例上 ~/.ssh/authorized_keys 的附加 ssh 公钥列表。 |
spec > infra > configs > dns_zone_name |
字符串 |
将在其下注册应用程序的 DNS 区域名称。 |
|
spec > infra > configs > api_sub_domain |
字符串 |
是 |
应用程序 API 端点的子域名。 |
spec > infra > configs > ui_sub_domain |
字符串 |
是 |
应用程序 UI 端点的子域名。 |
spec > infra > configs > elastic_sub_domain |
字符串 |
是 |
Elastic 端点的子域名。 |
spec > infra > configs > kibana_sub_domain |
字符串 |
是 |
Kibana 端点的子域名。 |
spec > infra > configs > grafana_sub_domain |
字符串 |
是 |
Grafana 端点的子域名。 |
spec > infra > configs > cdn_cache_enabled |
布尔值 |
是 |
如果需要通过 CDN 缓存提供 UI，则为 true。如果不需要从 CDN 缓存提供 UI，则为 false。 |
spec > infra > configs > turn_server_provider |
字符串 |
是 |
rp、coturn 或 twilio。默认为 coturn。 |
spec > infra > configs > clusters |
映射 |
要创建的集群的定义。 |
|
spec > infra > configs > clusters > app |
映射 |
要创建的 App 集群的定义。 |
|
spec > infra > configs > clusters > app > private_instance |
布尔值 |
始终为 true，因为要创建的应用程序实例是私有的。 |
|
spec > infra > configs > clusters > app > master |
映射 |
应用程序集群的主节点的定义。 |
|
spec > infra > configs > clusters > app > master > type |
字符串 |
应用程序主节点的 GCP 计算引擎实例类型。 |
|
spec > infra > configs > clusters > app > master > guest_accelerators |
列表 |
用于指定 GPU 和 GPU 数量的配置。 |
|
spec > infra > configs > clusters > app > master > guest_accelerators > type |
字符串 |
用于更改以添加 guest_accelerators 类型的配置 |
|
spec > infra > configs > clusters > app > master > guest_accelerators > count |
数字 |
用于更改以添加 guest_accelerators gpu 数量的配置 |
|
spec > infra > configs > clusters > app > features |
映射 |
应用程序集群的功能标志的定义。 |
|
spec > infra > configs > clusters > app > features > cns |
布尔值 |
cns 功能标志始终为 true，因为它用于安装 Nvidia Cloud Native Stack。 |
|
spec > infra > configs > clusters > app > features > app |
布尔值 |
app 功能标志始终为 true，因为它用于安装 tokkio 应用程序和其他组件。 |
|
spec > infra > configs > clusters > turn |
映射 |
turn 集群的主节点的定义。 |
|
spec > infra > configs > clusters > turn > private_instance |
布尔值 |
始终为 false，因为要创建的 TURN 服务器实例是公共的。 |
|
spec > infra > configs > clusters > turn > master |
映射 |
turn 集群的主节点的定义。 |
|
spec > infra > configs > clusters > turn > master > type |
字符串 |
turn 主节点的 GCP 计算引擎实例类型。 |
|
spec > infra > configs > clusters > turn > master > guest_accelerators |
列表 |
设置为空列表，因为 turn 服务器不是基于 GPU 的。 |
|
spec > infra > configs > clusters > turn > features |
映射 |
turn 集群的功能标志的定义。 |
|
spec > infra > configs > clusters > turn > features > cns |
布尔值 |
当 turn_server_provider = rp 时为 true，否则为 false。 |
|
spec > infra > configs > clusters > turn > features > rp |
布尔值 |
当 turn_server_provider = rp 时为 true，否则为 false。 |
|
spec > infra > configs > clusters > turn > features > coturn |
布尔值 |
当 turn_server_provider = coturn 时为 true，否则为 false。 |
|
spec > platform |
映射 |
用于更改要使用的默认基础配置的配置。 |
|
spec > platform > configs |
映射 |
基础配置。 |
|
spec > platform > configs > k8s_namespace |
字符串 |
是 |
要部署的基础图表的 Kubernetes 命名空间。默认为 platform。 |
spec > platform > configs > k8s_secrets |
列表 |
基础 helm 图表所需的 Kubernetes 密钥列表。 |
|
spec > platform > secrets > ngc_cli_api_key |
字符串 |
用于下载要使用的 helm 图表的 NGC API 密钥。 |
|
spec > app > configs > app_settings |
映射 |
用于更改默认应用程序设置的配置。 |
|
spec > app > configs > app_settings > k8s_namespace |
字符串 |
是 |
要部署的应用程序图表的 Kubernetes 命名空间。默认为 app。 |
spec > app > configs > app_settings > helm_chart |
映射 |
是 |
应用程序图表的 Helm 图表配置。 |
spec > app > configs > app_settings > helm_chart > repo |
映射 |
是 |
用于部署应用程序 helm 图表的远程仓库的配置。 |
spec > app > configs > app_settings > helm_chart > repo > enable |
布尔值 |
是 |
从远程仓库使用应用程序 helm 图表的标志，默认为 true。此标志与 spec > app > configs > app_settings > helm_chart > local > enable 互斥。在给定时间，只能将其中一个设置为 true。 |
spec > app > configs > app_settings > helm_chart > repo > repo_url |
字符串 |
是 |
要部署的应用程序 helm 图表的 Repo_url。默认为 [https://helm.ngc.nvidia.com/nvidia/ace](https://helm.ngc.nvidia.com/nvidia/ace)。 |
spec > app > configs > app_settings > helm_chart > repo > chart_name |
字符串 |
是 |
要从远程仓库获取的应用程序 helm 图表名称，默认为 ucs-tokkio-app-base-3-stream-llm-rag-3d-ov。 |
spec > app > configs > app_settings > helm_chart > repo > chart_version |
字符串 |
是 |
要从远程仓库获取的应用程序 helm 图表版本，默认为 4.1.4。 |
spec > app > configs > app_settings > helm_chart > repo > release_name |
字符串 |
是 |
使用 helm 图表部署的应用程序的发布名称，默认为 tokkio-app。 |
spec > app > configs > app_settings > helm_chart > repo > user_value_override_files |
列表 |
是 |
用于应用程序图表部署的用户覆盖值 override_values.yml 的绝对路径。这是一个列表，因此可以提供多个。 |
spec > app > configs > app_settings > helm_chart > local |
映射 |
是 |
用于更改使用本地存在的图表进行应用程序 helm 图表部署的配置。 |
spec > app > configs > app_settings > helm_chart > local > enable |
布尔值 |
是 |
如果您想使用本地存在的应用程序 helm 图表，则为 true。默认为 false。此标志与 spec > app > configs > app_settings > helm_chart > repo > enable 互斥。在给定时间，只能将其中一个设置为 true。 |
spec > app > configs > app_settings > helm_chart > local > path |
字符串 |
是 |
本地存在的 helm 图表的绝对路径。 |
spec > app > configs > app_settings > helm_chart > local > release_name |
字符串 |
是 |
使用 helm 图表部署的应用程序的发布名称，默认为 tokkio-app。 |
spec > app > configs > app_settings > helm_chart > local > user_value_override_files |
列表 |
是 |
用于应用程序图表部署的用户覆盖值 override_values.yml 的绝对路径。这是一个列表，因此可以提供多个。 |
spec > app > configs > app_settings > k8s_secrets |
列表 |
要部署的 Kubernetes 密钥列表。 |
|
spec > app > configs > turn_server_settings |
映射 |
是 |
用于更改以设置要用于应用程序的 turn 服务器的配置。 |
spec > app > configs > turn_server_settings > rp |
映射 |
是 |
如果 rp 是在 spec > infra > configs > turn_server_provider 中设置的选择，则 rp 作为 turn 服务器的配置。 |
spec > app > configs > turn_server_settings > rp > k8s_namespace |
字符串 |
是 |
用于 rp 图表部署的 Kubernetes 命名空间。默认为 rp |
spec > app > configs > turn_server_settings > rp > helm_chart |
映射 |
是 |
要部署的 rp 图表的 Helm 图表配置。 |
spec > app > configs > turn_server_settings > rp > helm_chart > repo |
映射 |
是 |
用于部署 rp helm 图表的远程仓库的配置。 |
spec > app > configs > turn_server_settings > rp > helm_chart > repo_url |
字符串 |
是 |
要部署的 rp helm 图表的 Repo_url，默认为 [https://helm.ngc.nvidia.com/nvidia/ace](https://helm.ngc.nvidia.com/nvidia/ace)。 |
spec > app > configs > turn_server_settings > rp > helm_chart > chart_name |
字符串 |
是 |
要从远程仓库获取的 RP helm 图表名称。默认为 rproxy。 |
spec > app > configs > turn_server_settings > rp > helm_chart > chart_version |
字符串 |
是 |
要从远程仓库获取的 RP helm 图表版本。默认为 0.0.8。 |
spec > app > configs > turn_server_settings > rp > helm_chart > release_name |
字符串 |
是 |
使用 helm 图表部署的 rp 的发布名称，默认为 rp。 |
spec > app > configs > turn_server_settings > rp > k8s_secrets |
列表 |
要部署的 Kubernetes 密钥列表。 |
|
spec > app > configs > turn_server_settings > coturn |
映射 |
是 |
当 spec > infra > configs > turn_server_provider 设置为 coturn 时，coturn 作为 turn 服务器的配置详细信息。 |
spec > app > configs > turn_server_settings > coturn > username |
字符串 |
是 |
设置 coturn 时使用的 Coturn 服务器用户名。默认为 foo |
spec > app > configs > turn_server_settings > coturn > password |
字符串 |
是 |
设置 coturn 时使用的 Coturn 服务器密码。默认为 bar |
spec > app > configs > turn_server_settings > coturn > realm |
字符串 |
是 |
coturn 服务器的 Realm 名称。默认为 mydummyt.org |
spec > app > configs > turn_server_settings > twilio |
映射 |
是 |
当 spec > infra > configs > turn_server_provider 设置为 twilio 时，twilio 作为 turn 服务器的配置详细信息。 |
spec > app > configs > turn_server_settings > twilio > account_sid |
字符串 |
是 |
来自 twilio 帐户的 account_sid。默认为空字符串。有关 Twilio 订阅详细信息，请访问 [www.twilio.com](http://www.twilio.com/)。 |
spec > app > configs > turn_server_settings > twilio > auth_token |
字符串 |
是 |
来自 twilio 帐户的 auth_token。默认为空字符串 |
spec > app > configs > ui_settings |
映射 |
是 |
用于更改以覆盖默认 UI 的配置。 |
spec > app > configs > ui_settings > resource |
映射 |
是 |
要使用的 UI 资源的配置。 |
spec > app > configs > ui_settings > resource > ngc |
映射 |
是 |
用于从 NGC 下载 UI NGC 资源的 NGC 配置。 |
spec > app > configs > ui_settings > resource > ngc > org |
字符串 |
是 |
UI 资源的 NGC 组织。默认为 nvidia |
spec > app > configs > ui_settings > resource > ngc > team |
字符串 |
是 |
UI 资源的 NGC 团队。默认为 ace |
spec > app > configs > ui_settings > resource > ngc > name |
字符串 |
是 |
UI 资源的 NGC 资源名称。默认为 tokkio_ui |
spec > app > configs > ui_settings > resource > ngc > version |
字符串 |
是 |
UI 资源的 NGC 资源版本。默认为 5.0.0 |
spec > app > configs > ui_settings > resource > ngc > file |
字符串 |
是 |
UI 的 NGC 资源文件名。默认为 ui.tar.gz |
spec > app > configs > ui_settings > user_env_vars |
映射 |
是 |
用于覆盖默认 UI 设置的配置 |
spec > app > secrets > ngc_cli_api_key |
字符串 |
用于下载要使用的 UI 资源和 helm 图表的 NGC cli_api_key。 |