Advanced Configuration#
Config-template File Parameter Definitions#
While the config-template-examples folder provides minimalistic samples that work, you can customize the config-template.yml to a greater extent. Below table explains each and every attribute of this config-template.yml in detail.
Parameter name |
Type |
Optional |
Description |
|---|---|---|---|
schema_version |
string |
Config-Template schema version. |
|
name |
string |
A unique name to identify the infrastructure resources being created by. |
|
spec |
map |
Infrastructure and Application configuration. |
|
spec > infra |
string |
Infrastructure configuration. |
|
spec > infra > csp |
string |
cloud service provider name, in this case bm. |
|
spec > infra > backend |
map |
terraform back-end configuration to store state of infrastructure, for bm it is managed locally. |
|
spec > infra > configs |
map |
Additional infrastructure configuration. |
|
spec > infra > configs > cns |
map |
yes |
NVIDIA Cloud Native Stack configuration. More details on Cloud Native Stack can be found here NVIDIA/cloud-native-stack. |
spec > infra > configs > cns > version |
string |
yes |
The version of Nvidia Cloud Native Stack to install on the clusters. Defaults to 12.2. |
spec > infra > configs > cns > git_ref |
string |
yes |
The git commit hash of Nvidia Cloud Native Stack. By default it takes the master branch’s latest commit hash. |
spec > infra > configs > cns > override_values |
map |
yes |
Nvidia Cloud Native Stack values to override while setting up a cluster. |
spec > infra > configs > cns > override_values > cns_nvidia_driver |
bool |
yes |
Set to yes if you want to install nvidia driver using run file method otherwise no. Defaults to no. Use this flag to support the latest OS Kernels. |
spec > infra > configs > cns > override_values > gpu_driver_version |
string |
yes |
Config to change gpu_driver_version to a different version than what the selected Nvidia Cloud Native Stack version installs by default. |
spec > infra > configs > ssh_private_key_path |
string |
Absolute path of the Controller instance’s private key. |
|
spec > infra > configs > ssh_public_key |
string |
Absolute path of the Controller instance’s public key. |
|
spec > infra > configs > additional_ssh_public_keys |
list |
yes |
List of additional ssh public keys that will be added to ~/.ssh/authorized_keys on Application instance. |
spec > infra > configs > clusters |
map |
Definition of cluster to be created. |
|
spec > infra > configs > clusters > app |
map |
Definition of App cluster to be created. |
|
spec > infra > configs > clusters > app > master |
map |
Definitions of the master node of the app cluster. |
|
spec > infra > configs > clusters > app > master > user |
string |
ssh username of master node of app cluster. |
|
spec > infra > configs > clusters > app > master > host |
string |
IP Address of master node of app cluster. |
|
spec > infra > configs > clusters > app > ports |
map |
Definitions of ports to be exposed from the app. |
|
spec > infra > configs > clusters > app > ports > app |
map |
Definitions of app port. |
|
spec > infra > configs > clusters > app > ports > app > port |
number |
Port number where the app is expected to be running. |
|
spec > infra > configs > clusters > app > ports > grafana |
map |
Definitions of grafana port. |
|
spec > infra > configs > clusters > app > ports > grafana > port |
number |
Port number where grafana is expected to be running. |
|
spec > infra > configs > clusters > app > ports > grafana > path |
string |
Path of grafana for landing url. |
|
spec > infra > configs > clusters > app > ports > prometheus |
map |
Definitions of prometheus port. |
|
spec > infra > configs > clusters > app > ports > prometheus > port |
number |
Port number where prometheus is expected to be running. |
|
spec > infra > configs > clusters > app > ports > prometheus > path |
string |
Path of prometheus for landing url. |
|
spec > infra > configs > clusters > app > ports > kibana |
map |
Definitions of kibana port. |
|
spec > infra > configs > clusters > app > ports > kibana > port |
number |
Port number where kibana is running. |
|
spec > infra > configs > clusters > app > ports > kibana > path |
string |
Path of kibana for landing url. |
|
spec > infra > configs > clusters > app > features |
map |
Definitions of features flag of the app cluster. |
|
spec > infra > configs > clusters > app > features > cns |
bool |
cns feature flag is always true as used to install Nvidia Cloud Native Stack. |
|
spec > infra > configs > clusters > app > features > app |
bool |
app feature flag is always true as used to install tokkio app & other components. |
|
spec > infra > configs > clusters > turn |
map |
Definition of master node of turn cluster. |
|
spec > infra > configs > clusters > turn > master |
map |
Definitions of the master node of the turn cluster. |
|
spec > infra > configs > clusters > turn > master > user |
string |
ssh username of turn node. |
|
spec > infra > configs > clusters > turn > master > host |
string |
IP Address of turn node. |
|
spec > infra > configs > clusters > turn > features |
map |
Definitions of features flag of the turn cluster. |
|
spec > infra > configs > clusters > turn > features > coturn |
bool |
Always set to true. |
|
spec > platform |
map |
Configuration to change the default settings for foundational charts that will be deployed on the cluster. |
|
spec > platform > configs |
map |
Foundational charts configuration. |
|
spec > platform > configs > k8s_namespace |
string |
yes |
Kubernetes namespace for foundational charts to be deployed, defaults to platform |
spec > platform > configs > k8s_secrets |
list |
List of Kubernetes secrets needed for foundational charts. |
|
spec > platform > secrets > ngc_cli_api_key |
string |
NGC API Key used to download helm charts. |
|
spec > app > configs > app_settings |
map |
Configuration to change the default Application and its helm chart’s settings. |
|
spec > app > configs > app_settings > k8s_namespace |
string |
yes |
Kubernetes namespace for app chart to be deployed, defaults to app. Avoid using default for this. |
spec > app > configs > app_settings > helm_chart |
map |
yes |
Application Helm chart config. |
spec > app > configs > app_settings > helm_chart > repo |
map |
yes |
Configuration of remote repo used for application helm chart. |
spec > app > configs > app_settings > helm_chart > repo > enable |
bool |
yes |
Flag to represent if the application helm chart is from remote repo. Defaults to true. |
spec > app > configs > app_settings > helm_chart > repo > repo_url |
string |
yes |
Helm chart repository URL for the application helm chart. Defaults to https://helm.ngc.nvidia.com/nvidia/ace. |
spec > app > configs > app_settings > helm_chart > repo > chart_name |
string |
yes |
App helm chart name to be fetched from remote repo. Defaults to ucs-tokkio-app-base-3-stream-llm-rag-3d-ov. |
spec > app > configs > app_settings > helm_chart > repo > chart_version |
string |
yes |
App helm chart version to be fetched from remote repository. Defaults to 4.1.4. |
spec > app > configs > app_settings > helm_chart > repo > release_name |
string |
yes |
Release name for app to be deployed using helm chart. Defaults to tokkio-app. |
spec > app > configs > app_settings > helm_chart > repo > user_value_override_files |
list |
yes |
Absolute path of the user override values.yml for application helm chart. This is a list, so more than one can be supplied. |
spec > app > configs > app_settings > helm_chart > local |
map |
yes |
Configuration to change app helm chart deployment using locally present chart. |
spec > app > configs > app_settings > helm_chart > local > enable |
bool |
yes |
true if you want to use a locally present app helm chart. |
spec > app > configs > app_settings > helm_chart > local > path |
string |
yes |
Absolute path of helm chart present locally. |
spec > app > configs > app_settings > helm_chart > local > release_name |
string |
yes |
Release name for app to be deployed using helm chart. Defaults to tokkio-app. |
spec > app > configs > app_settings > helm_chart > local > user_value_override_files |
list |
yes |
Absolute path of user override values.yml to be used for app chart deployment. This is a list, so more than one can be supplied. |
spec > app > configs > app_settings > k8s_secrets |
list |
List of Kubernetes secrets to be deployed. |
|
spec > app > configs > turn_server_settings |
map |
yes |
Section for TURN server settings. |
spec > app > configs > turn_server_settings > coturn |
map |
yes |
Configuration details of Coturn as a TURN server. |
spec > app > configs > turn_server_settings > coturn > username |
string |
yes |
Coturn server username used while setting up Coturn Defaults to foo. |
spec > app > configs > turn_server_settings > coturn > password |
string |
yes |
Coturn server password used while setting up Coturn. Defaults to bar. |
spec > app > configs > turn_server_settings > coturn > realm |
string |
yes |
Realm name for Coturn server. Defaults to mydummyt.org |
spec > app > configs > turn_server_settings > twilio |
map |
yes |
Configuration details of twilio as a TURN server. |
spec > app > configs > turn_server_settings > twilio > account_sid |
string |
yes |
account_sid from twilio account. Defaults to empty string. |
spec > app > configs > turn_server_settings > twilio > auth_token |
string |
yes |
auth_token from twilio account,defaults to empty string |
spec > app > configs > ui_settings |
map |
yes |
Configuration section for Tokkio UI. |
spec > app > configs > ui_settings > resource |
map |
yes |
Configuration section for Tokkio UI NGC resource to be used. |
spec > app > configs > ui_settings > resource > ngc |
map |
yes |
Configuration of NGC to download the UI resource from. |
spec > app > configs > ui_settings > resource > ngc > org |
string |
yes |
NGC Organization of the UI resource. Defaults to nvidia |
spec > app > configs > ui_settings > resource > ngc > team |
string |
yes |
NGC Team of the UI resource. Defaults to ace |
spec > app > configs > ui_settings > resource > ngc > name |
string |
yes |
NGC Resource Name of the UI resource. Defaults to tokkio_ui |
spec > app > configs > ui_settings > resource > ngc > version |
string |
yes |
NGC Resource Version of the UI resource. Defaults to 5.0.0 |
spec > app > configs > ui_settings > resource > ngc > file |
string |
yes |
NGC Resource File Name of the UI. Defaults to ui.tar.gz |
spec > app > configs > ui_settings > user_env_vars |
map |
yes |
Configuration to override default UI settings. |
spec > app > secrets > ngc_cli_api_key |
string |
NGC API key used for downloading the NGC UI resource and helm chart. |