@konfig.ts/sops

SOPS secret backend for konfig.ts. Keep encrypted secrets in git and turn them into cluster secrets at render time — either by re-encrypting to your cluster's recipients, or by emitting an already-encrypted SopsSecret for the in-cluster sops-secrets-operator to reconcile.

Install

bun add @konfig.ts/sops

Needs the sops CLI on the machine that runs konfig build. KMS / age credentials come from each file's own sops: metadata block.

Usage

Bind a secret contract (Secret.define, from @konfig.ts/env) to a Sops backend. Sops offers three modes — pick by how you want plaintext to flow.

import { Secret } from "@konfig.ts/k8s"
import { Sops } from "@konfig.ts/sops"

// dbCreds = Secret.define({ name, namespace, env: { url, password } })

// passthrough — emit an already-encrypted SopsSecret verbatim (offline, no decrypt)
Secret.bind({
  secret: dbCreds,
  backend: Sops.passthrough({ file: "infra/secrets/SopsSecret-db-creds.yaml" })
})

// backend — re-encrypt the resolved values to the operator's recipients
Secret.bind({
  secret: dbCreds,
  backend: Sops.backend({ recipients: { age: ["age1..."] } }),
  source: Sops.source({ file: "infra/secrets/db-creds.enc.yaml", keys: ["url", "password"] })
})

Secret.bind(...) returns a handle whose .manifest is the emitted CR. For a whole env bundle, plug the same backend into Environment.bind({ env, namespace, secrets: { db: { backend, source? } } }).

Modes

| Mode | Signature | Source | Emits | | ------------------ | ---------------------------- | ------ | ----------------------------------------------------------------------- | | Sops.passthrough | ({ file }) | no | the encrypted file's SopsSecret, restamped to the bound namespace | | Sops.backend | ({ recipients, type? }) | yes | a SopsSecret re-encrypted to recipients | | Sops.source | ({ file, keys, extract? }) | — | a SecretSource that decrypts a file once and yields Redacted values |

recipients accepts age / kms / gcpKms / azureKv / pgp arrays. Sops.source composes with any backend (e.g. decrypt with SOPS, seal with SealedSecrets.backend). Every emitted value is checked for the ENC[...] marker first — konfig fails closed rather than emit plaintext dressed as a secret.

Internals

Backends implement the SecretBackend<N, K, RequiresSource> contract from @konfig.ts/k8s; requiresSource: true makes source a compile-time requirement. See the Environment section of .docs/architecture.md.

Requirements

konfig.ts is built on Effect, currently in beta. Until Effect ships a stable 4.x, install the exact beta konfig.ts is built against:

• [email protected] — required by every package.
• @effect/[email protected] — required only when you call render() (the Node filesystem/subprocess entrypoint); manifest-only consumers can omit it (it is declared as an optional peer).

The pin is exact on purpose: Effect's beta line makes breaking changes between builds, so a looser range surfaces as ERESOLVE install conflicts. It relaxes to a caret range once Effect reaches a stable 4.x.