Keep Kindo's secrets in your secrets manager
Connect Kindo to your organization’s secrets manager to manage application passwords and API keys there. By default, Kindo stores these credentials in your Kubernetes cluster.
What you manage
Section titled “What you manage”Your secrets manager must hold every entry in Secret store keys, even an empty one, and the values your organization manages, which that page lists with where each goes. Install and upgrade stop until they are there. Kindo supplies everything else. A value you keep in your secrets manager overrides the config’s: it’s the one Kindo uses. The health check and the apply plan note each override, including one of an environment variable you set in a Helm value override, and a value left empty there.
Don’t edit the secret store’s settings directly in the cluster. Installing, upgrading, restoring, moving onto your secrets manager and applying the config all put them back, and the plan lists them. Until a full apply has put them back, applying only some components is refused.
Set up access to your secrets manager
Section titled “Set up access to your secrets manager”Kindo installs the External Secrets Operator, as Kubernetes cluster describes. Create the authentication resources for the secrets manager and auth you choose. Then give that identity read access to the Kindo entries in your secrets manager. Each one links to its provider’s setup steps.
| Secrets manager and auth | Config setting | You create |
|---|---|---|
| Vault, Kubernetes auth | vault.auth.kubernetes | A Vault role bound to the kindo-secret-store ServiceAccount in the kindo-system namespace; set role to it |
| Vault, token | vault.auth.token | A Kubernetes Secret in kindo-system, named by secretName, with a token key holding the Vault token |
| AWS Secrets Manager, the operator’s own identity | awsSecretsManager.auth.podIdentity | Access for the External Secrets Operator’s own AWS credentials: a role for its external-secrets ServiceAccount in the external-secrets namespace, an EKS Pod Identity association for it, or the node role |
| AWS Secrets Manager, a role to assume | awsSecretsManager.auth.assumeRole | A role the External Secrets Operator can assume with its own credentials; set roleArn to it |
| AWS Secrets Manager, access key | awsSecretsManager.auth.accessKey | A Kubernetes Secret in kindo-system, named by secretName, with access-key-id and secret-access-key keys |
| Azure Key Vault, workload identity | azureKeyVault.auth.workloadIdentity | A managed identity federated to the kindo-secret-store ServiceAccount in the kindo-system namespace; set clientId to its client ID |
| Azure Key Vault, service principal | azureKeyVault.auth.servicePrincipal | A Kubernetes Secret in kindo-system, named by secretName, with client-id and client-secret keys |
Create the entries
Section titled “Create the entries”Create each entry listed in Secret store keys in your secrets manager. An entry is a named group of keys and values.
For an entry with no values:
| Secrets manager | Create | Value |
|---|---|---|
| Vault | A KV v2 secret with one placeholder key, since Vault requires at least one key | KINDO_PLACEHOLDER=1 |
| AWS Secrets Manager | A secret whose value is the empty JSON object | {} |
| Azure Key Vault | A secret whose value is the empty JSON object | {} |
Config settings for your secrets manager
Section titled “Config settings for your secrets manager”Each example uses one auth choice, with the others commented out below it. Choose the secrets manager and auth carefully: once an instance uses one, you can’t change its config settings, including how Kindo signs in to it.
secretStore: vault: address: https://vault.example.com:8200 path: secret auth: kubernetes: role: kindo # token: # secretName: vault-tokenAWS Secrets Manager
Section titled “AWS Secrets Manager”secretStore: awsSecretsManager: region: us-west-2 auth: podIdentity: {} # assumeRole: # roleArn: arn:aws:iam::123456789012:role/kindo-secrets # accessKey: # secretName: aws-credentialsAzure Key Vault
Section titled “Azure Key Vault”secretStore: azureKeyVault: vaultUrl: https://your-vault.vault.azure.net tenantId: 00000000-0000-0000-0000-000000000000 auth: workloadIdentity: clientId: <managed-identity-client-id> # servicePrincipal: # secretName: azure-credentialsInstall with your secrets manager
Section titled “Install with your secrets manager”Create the entries before you install. Then add the example for your secrets manager to the config template, nested as shown:
inputs: <the example for your secrets manager, indented>If the secrets manager check fails, installing stops before it changes any of Kindo’s applications. After you install, check that the health check reports no secret store or sync findings. A note that an entry in your secrets manager overrides a config setting is expected, not a problem.
Move an existing instance onto your secrets manager
Section titled “Move an existing instance onto your secrets manager”You can move an instance only from Kubernetes Secrets to Vault, AWS Secrets Manager, or Azure Key Vault. The move is one-way: you can’t move back to Kubernetes Secrets or on to another secrets manager. Only restoring a backup taken before the move puts the instance back.
-
Back up the config.
Terminal window kindo config backup --output kindo-before-store-move.bundle -
Complete Set up access to your secrets manager and Create the entries.
-
Write your secrets manager’s config settings to a file, using the example for your secrets manager without its first two lines, so the file starts at the secrets manager’s own config settings, as here for AWS Secrets Manager:
region: us-west-2auth:podIdentity: {} -
Preview the move:
Terminal window kindo secret-store migrate --to <vault|awsSecretsManager|azureKeyVault> --settings <file> --plan -
Check that your secrets manager holds every entry and value from Secret store keys. Then run the move:
Terminal window kindo secret-store migrate --to <vault|awsSecretsManager|azureKeyVault> --settings <file>Answer yes only if the question names your cluster and your secrets manager.
Kindo then:
- Installs the secret store.
- Checks that it holds the keys.
- Saves the new config settings.
- Updates the affected applications.
If the check fails, Kindo puts the previous secret store back.
Rotate the secrets manager’s credentials
Section titled “Rotate the secrets manager’s credentials”If Kindo reaches your secrets manager with a credential you hold, rotate it in place: write the new value into the Kubernetes Secret you created for it in Set up access to your secrets manager, under the same keys.
Kindo picks up the new credential at the next sync, within a minute or two, without a restart. With Vault’s Kubernetes auth, AWS pod identity or an assumed role, or Azure workload identity, there’s no credential to rotate: change the role or app registration’s permissions in your cloud instead.
To retire a role or app registration, change the existing one rather than replacing it.
Change a value later
Section titled “Change a value later”To change a value your organization manages, update the entry. To hand a key back to Kindo, remove it from your secrets manager. Either way, restart the applications that read it, as described in Values in your secrets manager.
