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 |
map |
Infrastructure configuration. |
|
spec > infra > csp |
string |
Cloud service provider name, in this case aws. |
|
spec > infra > backend |
map |
Terraform back-end configuration to store infrastructure state. |
|
spec > infra > backend > access_key |
string |
AWS access key ID used to access the back-end bucket and table. |
|
spec > infra > backend > secret_key |
string |
AWS secret access key used to access the back-end bucket and table. |
|
spec > infra > backend > dynamodb_table |
string |
Name of the AWS Dynamo DB table used to manage concurrent access to the state. |
|
spec > infra > backend > bucket |
string |
Name of the AWS S3 bucket in which state of the resources provisioned is stored. |
|
spec > infra > backend > region |
string |
AWS region where state S3 bucket and Dynamo DB table are created. |
|
spec > infra > backend > encrypt |
bool |
Whether or not to encrypt the state while stored in S3 bucket. |
|
spec > infra > provider |
map |
AWS provider configuration. |
|
spec > infra > provider > access_key |
string |
AWS access key ID used for resource provision. |
|
spec > infra > provider > secret_key |
string |
AWS secret access key used for resource provision. |
|
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 |
string |
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 > user_access_cidrs |
list |
List of CIDR blocks that encompasses the IP addresses of all client machines that will access the Tokkio UI and API. |
|
spec > infra > configs > dev_access_cidrs |
list |
List of CIDR blocks that encompasses the IP addresses of all developer machines requiring SSH access to Tokkio AWS instances. |
|
spec > infra > configs > region |
string |
AWS region where resources of the application will be deployed. |
|
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 clusters to be created. |
|
spec > infra > configs > clusters > app |
map |
Definition of App cluster to be created. |
|
spec > infra > configs > clusters > app > private_instance |
bool |
Set to false for public instance since intend to use this as public instance. |
|
spec > infra > configs > clusters > app > master |
map |
Definitions of the master node of the app cluster. |
|
spec > infra > configs > clusters > app > master > type |
string |
AWS GPU instance type for the app master node. |
|
spec > infra > configs > clusters > app > ports |
map |
Port configurations for various services. |
|
spec > infra > configs > clusters > app > ports > api |
map |
API port configuration. |
|
spec > infra > configs > clusters > app > ports > api > port |
integer |
Port number for API access. Must be set to 30443 to match the default application configuration. |
|
spec > infra > configs > clusters > app > ports > api > protocol |
string |
Protocol for API access. Defaults to ‘https’. |
|
spec > infra > configs > clusters > app > ports > grafana |
map |
Grafana port configuration. |
|
spec > infra > configs > clusters > app > ports > grafana > port |
integer |
Port number for Grafana access. Must be set to 32300 to match the default application configuration. |
|
spec > infra > configs > clusters > app > ports > grafana > protocol |
string |
Protocol for Grafana access. Defaults to ‘http’. |
|
spec > infra > configs > clusters > app > ports > ace_configurator |
map |
ACE Configurator port configuration. |
|
spec > infra > configs > clusters > app > ports > ace_configurator > port |
integer |
Port number for ACE Configurator access. Must be set to 30180 to match the default application configuration. |
|
spec > infra > configs > clusters > app > ports > ace_configurator > protocol |
string |
Protocol for ACE Configurator access. Defaults to ‘http’. |
|
spec > infra > configs > clusters > app > ports > ui |
map |
UI port configuration. |
|
spec > infra > configs > clusters > app > ports > ui > port |
integer |
Port number for UI access. Must be set to 30111 to match the default application configuration. |
|
spec > infra > configs > clusters > app > ports > ui > protocol |
string |
Protocol for UI access. Defaults to ‘https’. |
|
spec > infra > configs > clusters > app > features |
map |
Feature flags for the app cluster. |
|
spec > infra > configs > clusters > app > features > cns |
bool |
Whether to enable NVIDIA Cloud Native Stack. Defaults to true. |
|
spec > infra > configs > clusters > app > features > app |
bool |
Whether to enable Tokkio application. Defaults to true. |
|
spec > infra > configs > clusters > app > features > coturn |
bool |
Whether to enable CoTURN server. Defaults to true. |
|
spec > platform |
map |
Platform configuration settings. |
|
spec > platform > secrets |
map |
Platform secrets configuration. |
|
spec > platform > secrets > ngc_cli_api_key |
string |
NGC API KEY used to download helm charts and resources. |
|
spec > app |
map |
Application configuration settings. |
|
spec > app > configs |
map |
Application specific configurations. |
|
spec > app > configs > app_settings |
map |
Application deployment 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-3stream-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-GA. |
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 created for the application. |
|
spec > app > configs > app_settings > k8s_secrets > name |
string |
Name of the Kubernetes secret. |
|
spec > app > configs > app_settings > k8s_secrets > type |
string |
Type of the Kubernetes secret (Opaque or dockerconfigjson). |
|
spec > app > configs > app_settings > k8s_secrets > entries |
list |
yes |
List of key-value pairs for Opaque type secrets. |
spec > app > configs > app_settings > k8s_secrets > registry_name |
string |
yes |
Registry name for dockerconfigjson type secrets. |
spec > app > configs > app_settings > k8s_secrets > username |
string |
yes |
Username for dockerconfigjson type secrets. |
spec > app > configs > app_settings > k8s_secrets > password |
string |
yes |
Password for dockerconfigjson type secrets. |
spec > app > secrets |
map |
Application secrets configuration. |
|
spec > app > secrets > ngc_cli_api_key |
string |
NGC API KEY used to download application resources. |