Files
buzz/docs/operator-community-deletion.md
tornquist e56f4d4c3a Add typed deletion drain operator CronJob
Co-authored-by: Codex <noreply@openai.com>
Signed-off-by: tornquist <tornquist@squareup.com>
2026-09-28 15:12:21 -04:00

3.9 KiB

Community Deletion Operator Job

Buzz executes whole-community deletion through the typed, one-shot /usr/local/bin/buzz-admin deletions drain command. The Helm chart can schedule that command as a Kubernetes CronJob; it does not call relay HTTP and it does not add another queue or retry service.

Postgres remains the handoff and source of truth. A run claims only requests that the deletion store considers runnable, heartbeats the existing lease, and resumes from durable checkpoints. concurrencyPolicy: Forbid prevents scheduled pod overlap, backoffLimit: 0 prevents Kubernetes Job retries, and the deletion store remains authoritative when a pod exits, reaches its deadline, or is replaced.

Enablement

The CronJob is disabled by default. Production deployments should use an existing Secret and a dedicated service account when their cluster policy supports one:

secrets:
  existingSecret: buzz-operator-secrets

operatorJobs:
  deletionDrain:
    enabled: true
    schedule: "*/5 * * * *"
    activeDeadlineSeconds: 3600
    terminationGracePeriodSeconds: 30
    serviceAccountName: buzz-deletion-drain
    podLabels:
      tags.datadoghq.com/service: buzz-deletion-drain
    podAnnotations:
      sidecar.istio.io/inject: "false"
    resources:
      requests:
        cpu: 100m
        memory: 256Mi
      limits:
        cpu: "1"
        memory: 1Gi

Set s3.endpoint, s3.bucket, s3.region, and s3.addressingStyle in chart values. The selected Secret must contain DATABASE_URL and REDIS_URL; it may contain BUZZ_S3_ACCESS_KEY and BUZZ_S3_SECRET_KEY when the object store uses static credentials. The pod receives only those connection values and the four non-secret S3 settings. It does not receive BUZZ_RELAY_PRIVATE_KEY, BUZZ_GIT_HOOK_HMAC_SECRET, RELAY_URL, or the full Secret through envFrom. The pod also disables service-account token automounting and Kubernetes service link environment injection because the executor does not call the Kubernetes API or discover cluster Services.

The S3 principal needs the relay's normal object permissions plus bucket-level s3:ListBucketVersions and object-level s3:DeleteObjectVersion for every tenant-owned prefix. This also applies to never-versioned buckets because S3 reports their objects with the null version id.

Runbook

  1. Confirm database migrations are current and the deletion request has crossed the explicit inventory and approval boundary with buzz-admin deletions inspect <request-id>.
  2. Confirm the selected Secret contains the required keys and the S3 principal has version-list and exact-version delete permissions.
  3. Enable the CronJob and inspect its rendered command and environment before rollout.
  4. Start one staffed manual run with kubectl create job --from=cronjob/<release>-buzz-deletion-drain <job-name>.
  5. Follow pod logs and re-run buzz-admin deletions inspect <request-id> to verify lease, checkpoint, retry, blocked, and terminal state.
  6. If a run fails or times out, fix the recorded dependency or permission failure. Do not add Kubernetes retries: the next scheduled drain consults the durable retry/checkpoint state and resumes only when the store allows it.

The current owner self-serve relay admission records an owner-origin request at submitted and intentionally performs no inventory or approval synchronously. The deletion engine rejects submitted and inventoried requests at its explicit approval boundary. Automating the privileged inventory/approval step is therefore a separate control-plane slice; enabling this CronJob alone does not make a newly accepted owner request destructive.

The chart has no existing PrometheusRule or provider-neutral CronJob alert integration. Operators must alert on failed/missed Jobs and long-running active Jobs in their deployment platform. Adding a chart-native alert abstraction is debt, not part of this job contract.