docverse Helm values reference#
Helm values reference table for the docverse application.
Key |
Type |
Default |
Description |
|---|---|---|---|
affinity |
object |
|
Affinity rules for the docverse deployment pod |
cloudsql.enabled |
bool |
|
Enable the Cloud SQL Auth Proxy sidecar, used with Cloud SQL databases on Google Cloud |
cloudsql.image.pullPolicy |
string |
|
Pull policy for Cloud SQL Auth Proxy images |
cloudsql.image.repository |
string |
|
Cloud SQL Auth Proxy image to use |
cloudsql.image.tag |
string |
|
Cloud SQL Auth Proxy tag to use |
cloudsql.instanceConnectionName |
string |
|
Instance connection name for a Cloud SQL PostgreSQL instance |
cloudsql.resources |
object |
See |
Resource requests and limits for Cloud SQL Auth Proxy |
cloudsql.serviceAccount |
string |
|
The Google service account that has an IAM binding to the |
config.arqRedisUrl |
string |
Points to embedded Redis |
URL for Redis arq queue database |
config.cdnPurgeEnabled |
bool |
|
Whether a long-profile edition publish is followed by a purge of the project’s hostname from the Cloudflare edge cache. Leave this off until the Docverse Worker edge-caches edition responses: today a purge invalidates nothing while still spending calls against Cloudflare’s per-account purge rate limit (5 per minute on the Free plan), which a keeper-sync backfill across many hostnames exceeds within seconds. Re-enabling is tracked in lsst-sqre/docverse#683. |
config.credentialKeyRotation |
bool |
|
Set true during a credential-encryption (Fernet) key rotation to deliver the retired key (DOCVERSE_CREDENTIAL_ENCRYPTION_KEY_RETIRED) to all pods so existing credentials can still be decrypted. Set back to false and remove the Vault key once all credentials have been re-encrypted. |
config.databaseUrl |
string |
|
Database URL for PostgreSQL |
config.githubAppId |
string |
|
GitHub App ID for Docverse to use when accessing GitHub repositories. If not set, Docverse will operate in a limited mode without GitHub integration. |
config.keeperSync.copyRetryDelaySeconds |
float |
|
Seconds the keeper-sync worker waits before re-running a build copy that failed on a transport error at either end (an R2 outage that outlasted the per-object budget, or an LTD S3 timeout during a download). The copy is re-run exactly once; any other failure fails the edition as before. |
config.keeperSync.enabled |
bool |
|
Enable the Keeper-sync worker that consumes the |
config.keeperSync.jobTimeoutSeconds |
int |
|
Per-job timeout, in seconds, for keeper-sync arq jobs. |
config.keeperSync.uploadConcurrency |
int |
|
Process-wide cap on concurrent presigned uploads across every running keeper-sync job in the sync worker. Each concurrent upload holds one outbound connection, and the copy client keeps that many (plus 10 of headroom) connections alive, so this bounds the NAT source ports one sync-worker pod consumes. 32 fits the default 64 static Cloud NAT ports per GKE node; raise it toward |
config.keeperSync.uploadMaxAttempts |
int |
|
Attempts, including the first, that the keeper-sync worker spends on one presigned upload of a copied object before failing the build copy. Transport failures and retryable statuses (429, 5xx) share the budget; backoff starts at 0.5 s and doubles. At the default of 6 an object rides out an R2 connect outage of roughly 65 s. |
config.keeperSync.uploadMaxBackoffSeconds |
float |
|
Ceiling, in seconds, on any single wait between attempts of a keeper-sync presigned upload, including a server-requested |
config.logLevel |
string |
|
Logging level |
config.logProfile |
string |
|
Logging profile ( |
config.maintenance.editionReconcileEnabled |
bool |
|
Enable the edition reconcile loop that re-drives editions whose recorded publish state has drifted from what the CDN serves. The cron stays registered either way; disabling only makes each tick a no-op. |
config.maintenance.editionReconcileMaxActionsPerJob |
int |
|
Maximum number of republish plus unpublish actions one per-org |
config.maintenance.enabled |
bool |
|
Enable the maintenance worker that consumes the |
config.maintenance.gitRefAuditEnabled |
bool |
|
Whether to enable auditing the git ref lifecycle rule. Enabling this will cause docverse to make GitHub API calls to determine if the git ref associated with an edition still exists. |
config.maintenance.jobTimeoutSeconds |
int |
|
Per-job timeout, in seconds, for maintenance-pool jobs (lifecycle evaluation, git ref audits, and purgatory cleanup). |
config.maintenance.purgatoryCleanupCronHour |
int |
|
UTC hour at which the daily purgatory_cleanup dispatcher cron runs. |
config.maintenance.purgatoryCleanupCronMinute |
int |
|
UTC minute of |
config.maintenance.purgatoryCleanupEnabled |
bool |
|
Whether to run the daily purgatory_cleanup sweep that permanently deletes the object-store content (unpacked tree and staging tarball) of soft-deleted builds once the organization’s purgatory retention has elapsed and stamps |
config.maintenance.purgatoryCleanupMaxBuildsPerJob |
int |
|
Cap on the builds a single per-org purgatory_cleanup job reclaims per daily tick, oldest deletion first; anything past the cap is picked up by the next tick. |
config.metrics.application |
string |
|
Name under which to log metrics. Generally there is no reason to change this. |
config.metrics.enabled |
bool |
|
Whether to enable sending application metrics events to Sasquatch over Kafka. When disabled, Docverse uses a no-op metrics manager. |
config.metrics.events.topicPrefix |
string |
|
Topic prefix for events. It may sometimes be useful to change this in development environments. |
config.metrics.schemaManager.registryUrl |
string |
Sasquatch in the local cluster |
URL of the Confluent-compatible schema registry server |
config.pathPrefix |
string |
|
URL path prefix |
config.reaperThresholds.buildProcessingSeconds |
int |
|
Stuck-run reaper threshold, in seconds, for build_processing jobs. |
config.reaperThresholds.dashboardBuildSeconds |
int |
|
Stuck-run reaper threshold, in seconds, for dashboard_build jobs. |
config.reaperThresholds.dashboardSyncSeconds |
int |
|
Stuck-run reaper threshold, in seconds, for dashboard_sync jobs. |
config.reaperThresholds.editionReconcileSeconds |
string |
Derived by the server ( |
Stuck-run reaper threshold, in seconds, for edition_reconcile jobs. Leave unset to let the server derive it as |
config.reaperThresholds.keeperSyncSeconds |
int |
|
Stuck-run reaper threshold, in seconds, for keeper-sync jobs. |
config.reaperThresholds.lifecycleSeconds |
int |
|
Stuck-run reaper threshold, in seconds, for lifecycle_eval and git_ref_audit jobs (maintenance pool). |
config.reaperThresholds.publishEditionSeconds |
int |
|
Stuck-run reaper threshold, in seconds, for publish_edition jobs. |
config.reaperThresholds.purgatoryCleanupSeconds |
int |
|
Stuck-run reaper threshold, in seconds, for purgatory_cleanup jobs (maintenance pool). |
config.sentry.enabled |
bool |
|
Whether to send error reports and tracing data to Sentry. Requires the sentry-dsn secret to be set in Vault. |
config.sentry.tracesSampleRate |
float |
|
The percentage of requests that should be traced. This should be a float between 0 and 1. |
config.slackAlerts |
bool |
|
Whether to send Slack alerts for unexpected failures |
config.superadminUsers |
list |
|
Usernames that have super admin (de facto admin in all organizations) |
config.updateSchema |
bool |
|
Whether to run Alembic schema migrations on install/upgrade |
global.host |
string |
Set by Argo CD |
Host name for ingress |
global.repertoireUrl |
string |
Set by Argo CD |
Base URL for Repertoire discovery API |
global.vaultSecretsPath |
string |
Set by Argo CD |
Base path for Vault secrets |
image.pullPolicy |
string |
|
Pull policy for the docverse image |
image.pythonModule |
string |
|
Top-level Python module of the server in this image. Images built after the DM-55658 packaging restructure use “docverse_server”; earlier images use “docverse”. Must match the deployed image tag. |
image.repository |
string |
|
Image to use in the docverse deployment |
image.tag |
string |
The appVersion of the chart |
Tag of image to use |
ingress.annotations |
object |
|
Additional annotations for the ingress rule |
maintenanceWorker.affinity |
object |
|
Affinity rules for the maintenance worker pod |
maintenanceWorker.nodeSelector |
object |
|
Node selection rules for the maintenance worker pod |
maintenanceWorker.podAnnotations |
object |
|
Annotations for the maintenance worker pod |
maintenanceWorker.replicaCount |
int |
|
Number of maintenance worker pods to start |
maintenanceWorker.resources |
object |
See |
Resource limits and requests for the maintenance worker pod |
maintenanceWorker.tolerations |
list |
|
Tolerations for the maintenance worker pod |
nodeSelector |
object |
|
Node selection rules for the docverse deployment pod |
podAnnotations |
object |
|
Annotations for the docverse deployment pod |
redis.affinity |
object |
|
Affinity rules for the Redis pod |
redis.nodeSelector |
object |
|
Node selection rules for the Redis pod |
redis.persistence.enabled |
bool |
|
Whether to persist Redis storage. Setting this to false will use |
redis.persistence.size |
string |
|
Amount of persistent storage to request |
redis.persistence.storageClass |
string |
|
Class of storage to request |
redis.persistence.volumeClaimName |
string |
|
Use an existing PVC, not dynamic provisioning. If this is set, the size, storageClass, and accessMode settings are ignored. |
redis.podAnnotations |
object |
|
Pod annotations for the Redis pod |
redis.resources |
object |
See |
Resource limits and requests for the Redis pod |
redis.resources.requests.cpu |
string |
|
GKE Autopilot requires a minimum CPU request of 50m |
redis.tolerations |
list |
|
Tolerations for the Redis pod |
replicaCount.api |
int |
|
Number of API deployment pods to start |
replicaCount.worker |
int |
|
Number of worker deployment pods to start |
resources |
object |
See |
Resource limits and requests for the docverse deployment pod |
resources.requests.cpu |
string |
|
GKE Autopilot requires a minimum CPU request of 50m |
syncWorker.affinity |
object |
|
Affinity rules for the Keeper-sync worker pod |
syncWorker.nodeSelector |
object |
|
Node selection rules for the Keeper-sync worker pod |
syncWorker.podAnnotations |
object |
|
Annotations for the Keeper-sync worker pod |
syncWorker.replicaCount |
int |
|
Number of Keeper-sync worker pods to start |
syncWorker.resources |
object |
See |
Resource limits and requests for the Keeper-sync worker pod |
syncWorker.resources.limits.memory |
string |
|
Higher than the other workers because keeper-sync buffers whole LTD objects in memory while copying builds, across several concurrent jobs. Measured idle RSS after a 477-project backfill is about 840Mi (roundtable-prod, 2026-09-23), so the previous 1Gi limit left almost no room for the next wave. |
syncWorker.tolerations |
list |
|
Tolerations for the Keeper-sync worker pod |
tolerations |
list |
|
Tolerations for the docverse deployment pod |
workerResources |
object |
See |
Resource limits and requests for the docverse worker pod |
workerResources.limits.memory |
string |
|
The worker idles at roughly 480Mi after a keeper-sync backfill and was OOM-killed at 512Mi while running ten concurrent publish_edition and dashboard_build jobs (roundtable-prod, 2026-09-23). A killed worker strands in-flight publishes until the 4 h reaper runs, so leave headroom for a full burst. |
workerResources.requests.cpu |
string |
|
GKE Autopilot requires a minimum CPU request of 50m |