Config template
The Config reference describes every config setting. Print the config template for your version:
kindo config init --templatePrint the values your instance uses:
kindo config getHow the config works covers changing a value.
The full template
Section titled “The full template”## Config template for `kindo config init --file <this file>`.#### Replace every placeholder value, such as <password>, and delete the## optional blocks you don't use.## Then run `kindo config init --file <this file>`, followed by## `kindo install`.#### You type passwords and keys into this file. Once the config is saved in the## cluster you don't need it: delete it, and keep it out of version control.#### Kindo creates its own internal passwords and keys when you save the config.## To change a config value later, run `kindo config edit`.#### To answer questions instead of editing this file, run `kindo config init`## on its own.#### Lines that start with ## describe a config value. Lines that start with a## single # are optional values you can turn on: remove one # from each line of## the block.## Where a block lists choices, such as rabbitmq, keep exactly one: add a # to## the active choice's lines before you remove one from another.## The Kindo self-managed docs describe every config value in full.
apiVersion: kindo.ai/v1kind: Configinputs: ## --- Basics ---
## Required. The domain Kindo is served under. Each public address is ## https://<role>.<baseDomain>, such as https://app.kindo.example.com. baseDomain: <baseDomain>
## Required. The first superadmin's email address. The install prints this ## person's key only once, so store it when it appears. superadminEmail: <email>
## Required. The registry Kindo's charts and images come from, and the ## username and password Kindo gave you. registry: host: registry.kindo.ai username: <username> password: <password>
## --- How people reach Kindo ---
## Optional. Move the app, webhooks, or file downloads to their own address. ## Anything you leave out keeps its default: webhooks use the API's address, ## https://api.<baseDomain>, and every other address is <role>.<baseDomain>. ## ## app The web app. May include a path. ## webhooks Where outside services send webhooks. May include a path. ## storage File downloads, Azure Blob storage only. No path. ## ## Each value is a full https:// URL. When `ingress` is set, app and ## webhooks can't include a path. # endpoints: # app: <url> # webhooks: <url> # storage: <url>
## Optional. Have Kindo create an Ingress for every public address. Leave it ## out to route traffic to Kindo yourself. For TLS, keep one of certManager, ## acm or secret, or leave `tls` out for no TLS. # ingress: # className: <ingress class> # annotations: {} # externalDns: false # tls: # certManager: # clusterIssuer: <cluster issuer> # ## acm works only with className alb. # # acm: # # certificateArn: <certificate ARN> # ## Your own certificate. It must cover every public address. # # secret: # # certificate: | # # <PEM certificate chain> # # privateKey: | # # <PEM private key>
## --- Your cluster ---
## Where Kindo keeps its passwords and API keys: Kubernetes Secrets in the ## cluster, Vault, AWS Secrets Manager or Azure Key Vault. Keep exactly one. ## Choose before you install. After that, only `kindo secret-store migrate` ## can change it. secretStore: kubernetes: {} # vault: # address: <url> # path: secret # auth: # kubernetes: # role: <vault role> # # token: # # secretName: <secret name> # awsSecretsManager: # region: <region> # auth: # podIdentity: {} # # assumeRole: # # roleArn: <role ARN> # # accessKey: # # secretName: <secret name> # azureKeyVault: # vaultUrl: <url> # tenantId: <tenant ID> # auth: # workloadIdentity: # clientId: <client ID> # # servicePrincipal: # # secretName: <secret name>
## Optional. The StorageClass for Kindo's data volumes, and the nodes agent ## sandboxes run on. # cluster: # storageClass: <storage class> # sandboxNodePool: # nodeSelector: # <node label>: <value> # tolerations: # - key: <taint key> # operator: Exists # effect: NoSchedule
## --- Services you provide ---
## Required. The PostgreSQL servers Kindo creates its databases on, each ## with an administrator login that can create databases and roles. postgres: main: host: <host> port: 5432 tls: encrypt: {} # verify: {} # none: {} admin: username: <username> password: <password> database: postgres ## Optional, recommended for production. A separate server for the ## databases of Kindo's supporting services. Leave it out to use `main`. # auxiliary: # host: <host> # port: 5432 # tls: # encrypt: {} # admin: # username: <username> # password: <password> # database: postgres ## Optional, recommended. A separate server for Hatchet, Kindo's task ## scheduler. Leave it out to use `auxiliary`, or `main` if there is none. # hatchet: # host: <host> # port: 5432 # tls: # encrypt: {} # admin: # username: <username> # password: <password> # database: postgres
## Required. Your Redis server's connection URL, including its password if ## it has one. redis: url: <redis url>
## Required. Where Kindo keeps uploaded files: S3 or S3-compatible storage, ## or Azure Blob Storage. Keep exactly one. storage: s3: bucket: <bucket> region: <region> auth: accessKey: accessKeyId: <access key ID> secretAccessKey: <secret access key> ## With irsa, the role must trust these ServiceAccounts: ## system:serviceaccount:api:api, ## system:serviceaccount:task-worker-ts:task-worker-ts and ## system:serviceaccount:kindo-system:kindo-preflight. # irsa: # roleArn: <role ARN> ## podIdentity: EKS Pod Identity, or the node's role. # podIdentity: {} ## Optional. For MinIO, GCS or another S3-compatible store. # endpoint: <url> # publicEndpoint: <url> ## With workloadIdentity, give the managed identity the Storage Blob Data ## Contributor role on the account and a federated credential for ## system:serviceaccount:kindo-s3proxy:s3proxy. # azureBlob: # account: <account> # container: <container> # auth: # workloadIdentity: # clientId: <client ID> # # accountKey: # # key: <account key>
## Required. The mail relay that sends invites, sign-in codes and alerts. smtp: host: <host> port: 587 auth: login: username: <username> password: <password> # none: {} # tlsServerName: <certificate name> fromEmail: <email> # fromName: Kindo
## --- Services Kindo can run for you ---
## Required. Your RabbitMQ broker, or `bundled: {}` to have Kindo run one in ## the cluster. rabbitmq: bringYourOwn: url: <rabbitmq url> # bundled: {}
## Qdrant, Kindo's vector search. Kindo runs it in the cluster, or use ## `bringYourOwn` for your own server. qdrant: bundled: {} # bringYourOwn: # url: <url> # apiKey: <api key>
## Speaches, Kindo's speech-to-text. Kindo runs it in the cluster, or use ## `none` to turn it off. speaches: bundled: {} # none: {}
## --- Features you can turn on any time ---
## Optional. You don't add models here: superadmins add every model in the ## superadmin dashboard after the install. Set this only to let Kindo reach ## a model provider through a cloud identity instead of access keys. ## ## For Amazon Bedrock, the IAM role must trust the ServiceAccount ## system:serviceaccount:litellm:litellm. # modelAccess: # bedrock: # region: <region> # auth: # irsa: # roleArn: <role ARN>
## Optional. Integrations to turn on, by catalog name. Once the config is ## saved, `kindo integrations list` shows the names. # integrations: # github: # enabled: true # clientId: <client ID> # clientSecret: <client secret> # scopes: "" # airtable-pat: # enabled: true
## Optional. A Tavily API key, which turns on web search and web page reads ## for agents. # tavily: # apiKey: <api key>
## Optional. A Google OAuth client, which adds Google sign-in. # googleSignIn: # clientId: <client ID> # clientSecret: <client secret>
## Optional. Send audit events to a syslog receiver. # audit: # syslog: # host: <host> # port: 514 # transport: # tls: # caPem: <PEM CA certificate> # # tcp: {} # # udp: {}Overrides
Section titled “Overrides”The config template can’t hold these. Set them in the saved config, before or after installing.
| Override | Sets | Page |
|---|---|---|
overrides.serviceEnv.<app> | An application’s environment variables | How the config works |
overrides.helmValues.<component> | A component’s Helm values | How the config works |
