Datastore manifest

A datastore lives under .towbar/datastores/*.datastore.yml. Set type to one of the supported database or cache engines. Use a Service for a general OCI image. The file is Git-reviewed; saved secret values remain in Towbar.

.towbar/datastores/cache.datastore.yml

id: cache
name: Cache
type: redis
container:
  network: application
  networkAlias: cache
  resources:
    cpus: 1
    memory: 1g
secrets:
  runtime:
    - REDIS_PASSWORD
environments:
  production:
    server: 192.0.2.10

Register the server, save each declared secret value under Datastore → Settings → Secrets, and sync the mapped branch before deploying. Review the Redis guide for its required credentials and engine behavior.

Field map

Field	Purpose	Guide
`id`, `name`, `description`	Stable identity and display text. Keep `id` when renaming or moving a file.	Datastores
`type`, `image`	Supported engine and optional reviewed image.	Database catalog
`server`, `environments`	Target host and allowed environment overrides.	Environment branches
`container`, `health`, `access`	Limits, network, storage, readiness, and optional private access.	Datastores
`secrets`, `externalSecrets`	Runtime key names and an external-secret source.	Towbar secrets, external secrets
`backup`	Schedule, destinations, and retention for managed databases.	Backups
`autoDeploy`, `notifications`	Deployment automation and extra event destinations.	Sync and automation, Notifications
`domains`, `ingress`, `tls`	Routing for Datastores that expose a public endpoint.	Domains and TLS

The datastore JSON Schema describes exact shapes and constraints. Repository sync validates the merged environment and cross-workload conflicts, while deployment checks runtime readiness and required secret values. Objects merge recursively across common and environment settings; arrays replace. Identity, type, and secret declarations stay at entity level. A successful sync can change a datastore’s desired configuration without replacing its running container until a deployment occurs.

Servers

Repositories

Services

Datastores

Secrets

Deployments and access

Datastore manifest

Field map

​Field map

Field map