Documentation for v2.8.0. Read the latest, v2.12.0.
Operator
Operator track
Nine chapters for the person who runs the instance: how to deploy it, every variable it reads, who may log in and what they may do, what expires on its own, what it sends out, how to back it up and watch it, and what every error message means. They assume Concepts.
-
Chapter 1
Deployment
The image, Docker and Compose, Kustomize, the Helm chart, SQLite or PostgreSQL, scaling, upgrades, verifying a release.
-
Chapter 2
Configuration
Every environment variable with its default, root users, caches, CA certificates, the settings in the database.
-
Chapter 3
Authentication
The modes, local accounts and approval, LDAP and Active Directory, OpenID Connect, developer mode.
-
Chapter 4
Roles and permissions
The ten permissions, the five roles, maintainers, groups from the directory, token scopes.
-
Chapter 5
Administration
Producers, versions and Consumers, sanshain-branches, retention and cleanup, settings, the audit log, the Danger Zone.
-
Chapter 6
Webhooks
Hooks in three scopes, the events and their bodies, the signature, the allow-list, the outbox and its retries.
-
Chapter 7
Backup and restore
The SQLite snapshot and its CronJob, pg_dump, retention, restoring either engine.
-
Chapter 8
Observability
Every metric by name, traces over OTLP, the log filters, the observability page, the probes.
-
Chapter 9
Troubleshooting
Every message the service answers or logs, quoted, with cause and fix.
-
Chapter 10
An operator's story
From the Helm install to a restored snapshot: first login, OIDC, roles and a maintainer, a tested webhook with its signature, retention, backup, audit log and metrics, recorded.
-
Chapter 11
Operator recipes
Single tasks with the command and the answer: rotate a webhook secret, redeliver, delete a version, approve a user, grant a role, download a snapshot.
The complete administrative surface with the permission of every route is the generated Maintenance API; the architecture is in the Reference. The operator walkthrough, recorded against 2.6.0, is An operator's story.
Checked against v2.6.0.