Config File Reference
Starting from K3ai 0.2.0 we introduced a configuration file to allow a user to deploy various flavors of Kubernetes both locally and remotely.
The config file is typically saved in <yourhomedir>/.k3ai but could be moved around and/or hosted on other locations. We currently do not support remote config files.
A single config file may host multiple configurations, hence is capable to deploy multiple clusters at the same time.
Generic Section
The kind definition at the beginning of the config file indicates that all the pieces of information below are relative to the infrastructure deployment. We did this with the intention later to have the capability to split the config behavior and possibly call other config files.
Common Sections
name: is the instance name as an internal reference for K3ai. Is not currently used so it act as a placeholder right now
enabled: if set to true the section will be used and the cluster will be deployed
type: represent the cluster to be installed: k3s,k3d,k0s,kinD
Rancher K3s Config Specifics
Rancher K3d Config Specifics
Mirantis K0s Config Specifics
Do not copy the above, has been truncated to make it more readable.
KinD Config Specifics
Remote Clusters Specifics
We currently support only Civo Cloud. Notice that the cloudSecretPath is a placeholder we are going to add this feature but for the time being, you'll need to pass the key through the terminal directly.