How padok-team/burrito works
Project type and purpose
• Burrito is a Kubernetes Operator (written in Go) plus a companion React Web UI—i.e., a full‑stack cloud‑native application.
• It implements custom Terraform orchestration via Kubernetes CRDs (TerraformLayer, TerraformPullRequest, TerraformRepository, TerraformRun), controller loops (cmd/controllers), runner agents (cmd/runner), an API server (cmd/server), and a Web UI (ui/).
• It integrates with Git providers (GitHub and GitLab) to watch push and pull/merge events, plan/apply Terraform code, detect drift, and display diffs in a UI.
File‑structure analysis
• Top level:
• cmd/… – entrypoints for controllers, datastore, runner, server.
• api/v1alpha1 – definitions of Burrito CRDs (TerraformLayer, TerraformPullRequest, TerraformRepository, TerraformRun).
• internal/… – business‑logic: controllers, datastore storage clients (S3, GCS, Azure), runner tools (Terraform, Terragrunt, OpenTofu), webhook handlers, Git provider abstractions, server handlers, locking, sync windows, etc.
• ui/ – React SPA consuming the Burrito API.
• deploy/ & manifests/ – Helm chart and Kustomize manifests for Kubernetes deployment.
Key architecture points from README & docs
• Burrito uses the Operator pattern: CRDs + controller loops drive state in Kubernetes.
• The API server exposes REST endpoints for UI and external clients.
• The runner component executes Terraform operations in pods.
• A pluggable datastore persists plans, logs, state diffs.
• Git provider module abstracts GitHub and GitLab webhook events and API calls.
a. Main components:
1. Kubernetes cluster (control plane).
2. Custom Resources (CRDs):
• TerraformLayer
• TerraformPullRequest
• TerraformRepository
• TerraformRun
3. Controller Manager (cmd/controllers): watches CRDs, reconciles state.
4. Runner Pods (cmd/runner): perform terraform plan/apply.
5. Datastore Service (cmd/datastore + storage backends): stores plans, logs, revisions.
6. API Server (cmd/server): serves UI and CLI clients.
7. Webhook Listener (internal/webhook): ingests GitHub/GitLab events.
8. Git Providers (GitHub, GitLab)—external systems.
9. React Web UI (ui/): user front end.
b. Relationships & data‑flow:
• GitHub/GitLab → Webhook Listener → CRD instances (TerraformPullRequest & TerraformRepository).
• Controller Manager watches CRDs → creates / updates Runner Pods & TerraformLayer/Run resources.
• Runner Pods execute Terraform via integrated tools → send logs/results to Datastore.
• Controller Manager updates TerraformRun CRDs with status & diff results.
• API Server reads CRDs & Datastore → exposes REST API.
• Web UI calls API Server → displays state, diffs, run history.
c. Architectural patterns/design principles:
• Kubernetes Operator pattern (CRD + controller loops).
• Event‑driven reconciliation (Git webhooks & Kubernetes events).
• Micro‑services-like separation: controller, runner, datastore, API, UI.
• Pluggable abstractions for storage backends and Git providers.
d. Key technologies / frameworks:
• Go & controller-runtime (Operator SDK)
• Kubernetes CRDs & Helm/Kustomize for deployment
• React, Vite, Tailwind CSS for UI
• Storage backends: AWS S3, GCS, Azure Blob (internal/datastore/storage)
• Git provider integrations: internal/utils/gitprovider/{github,gitlab}