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 Deployment scripts. |
|
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 |
spec > infra > configs > cns > git_ref |
string |
yes |
The git commit hash of NVIDIA Cloud Native Stack. Defaults to |
spec > infra > configs > cns > override_values |
map |
yes |
NVIDIA Cloud Native Stack values to override while setting up a kubernetes cluster. |
spec > infra > configs > cns > override_values > cns_nvidia_driver |
bool |
yes |
Set to yes if you want to install the NVIDIA driver using run file method otherwise no. Defaults to no. Set this flag to yes 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 > turn_server_provider |
string |
yes |
Either coturn or twilio. Defaults to coturn. |
spec > infra > configs > clusters |
map |
Definition of clusters 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 > api |
map |
Definitions of api port. |
|
spec > infra > configs > clusters > app > ports > api > port |
number |
Port number where the app is expected to be running. Set this as 30888 unless you change the actual port in the app. |
|
spec > infra > configs > clusters > app > ports > api > protocol |
string |
http or https. Set this as |
|
spec > infra > configs > clusters > app > ports > ui |
map |
Definitions of UI port. |
|
spec > infra > configs > clusters > app > ports > ui > port |
number |
Port number where the UI is expected to be running. Set this as 30111 unless you change the actual port in the app. |
|
spec > infra > configs > clusters > app > ports > ui > protocol |
string |
http or https. Set this as |
|
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. Set this as 32300 unless you change the actual port in the app. |
|
spec > infra > configs > clusters > app > ports > grafana > protocol |
string |
Defaults to |
|
spec > infra > configs > clusters > app > ports > ace_configurator |
map |
Definitions of ACE Configurator port. |
|
spec > infra > configs > clusters > app > ports > ace_configurator > port |
number |
Port number where ACE Configurator is expected to be running. Set this as 30180 unless you change the actual port in the app. |
|
spec > infra > configs > clusters > app > ports > ace_configurator > protocol |
string |
Defaults to |
|
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 foundational config to be used. |
|
spec > platform > configs |
map |
Foundational configuration. |
|
spec > platform > configs > foundational_chart_settings > k8s_namespace |
string |
yes |
Kubernetes namespace for foundational charts to be deployed. Defaults to platform. |
spec > platform > secrets > ngc_cli_api_key |
string |
NGC API KEY used to download helm charts to be used. |
|
spec > app > configs > app_settings |
map |
Configuration to change the default App settings. |
|
spec > app > configs > app_settings > k8s_namespace |
string |
yes |
Kubernetes namespace for app chart. Defaults to app. |
spec > app > configs > app_settings > helm_chart |
map |
yes |
Helm chart config for Tokkio App. |
spec > app > configs > app_settings > helm_chart > repo |
map |
yes |
Configuration of remote repo used for Tokkio app helm chart. |
spec > app > configs > app_settings > helm_chart > repo > enable |
bool |
yes |
Flag to use app helm chart from remote repo. Defaults to true. This flag is mutually exclusive to spec > app > configs > app_settings > helm_chart > local > enable. At a given time only one of them should be set to true. |
spec > app > configs > app_settings > helm_chart > repo > repo_url |
string |
yes |
repo_url for app 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 tokkio-1stream-with-ui. |
spec > app > configs > app_settings > helm_chart > repo > chart_version |
string |
yes |
App helm chart version to be fetched from remote repo,defaults to 5.0.0-beta. |
spec > app > configs > app_settings > helm_chart > repo > release_name |
string |
yes |
Release name for app helm chart. Defaults to tokkio-app. |
spec > app > configs > app_settings > helm_chart > repo > user_value_override_files |
list |
yes |
Absolute path of user helm 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 > 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. Defaults to false. This flag is mutually exclusive to spec > app > configs > app_settings > helm_chart > repo > enable. At a given time only one of them should be set to true. |
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 |
Configuration to change TURN server setup. |
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 when spec > infra > configs > turn_server_provider was set to twilio. |
spec > app > configs > turn_server_settings > twilio > account_sid |
string |
yes |
account_sid from twilio account. Defaults to empty string. Twilio subscription details can be found at www.twilio.com. |
spec > app > configs > turn_server_settings > twilio > auth_token |
string |
yes |
auth_token from twilio account. Defaults to empty string. |
spec > app > secrets > ngc_cli_api_key |
string |
NGC API key used for downloading the NGC UI resource and helm |