[feat][r2] optionally split rrGitServer into its own deployment#309
[feat][r2] optionally split rrGitServer into its own deployment#309JatinNanda wants to merge 1 commit into
Conversation
JatinNanda
force-pushed
the
jatin/separate-git-server
branch
from
ccc2f8f to
3cd2a94
Compare
Adds rrGitServer.separate.enabled to run the git server as a dedicated deployment + service instead of in-process on the main backend, mirroring how the workload is split in Retool Cloud (reached via normal k8s service discovery). When enabled: - a dedicated <release>-git-server Deployment runs SERVICE_TYPE=RR_GIT_SERVER on RR_GIT_SERVER_PORT, with the Postgres connection, bootstrap secrets, blob-storage env, and telemetry - the main backend drops RR_GIT_SERVER from its SERVICE_TYPE and proxies git traffic to the service via RR_GIT_SERVER_HOST / RR_GIT_SERVER_PORT - the MCP server (if enabled) is auto-pointed at the service unless mcp.config.retoolGitServerUrl is set explicitly The blob-storage env block is extracted into a shared helper (retool.rrGitServer.commonEnv) so the in-process backend and the standalone deployment stay in sync. In-process mode (rrGitServer.enabled without separate) is unchanged. Adds ci/test-rr-git-server-separate-option.yaml exercising the split + S3 blob storage + MCP auto-wiring. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
JatinNanda
force-pushed
the
jatin/separate-git-server
branch
from
3cd2a94 to
903816e
Compare
|
| Filename | Overview |
|---|---|
| charts/retool/templates/deployment_git_server.yaml | New file rendering the standalone git server Service + Deployment; missing PDB (claimed by PR description), missing telemetry env vars, and shared annotations applied to both Service and Pod template without differentiation. |
| charts/retool/templates/_helpers.tpl | Adds retool.rrGitServer.{name,separateEnabled,port,url} helpers and extracts the blob-storage/repack env block into retool.rrGitServer.commonEnv; logic is correct and the separateEnabled guard properly requires both flags. |
| charts/retool/templates/deployment_backend.yaml | Correctly removes RR_GIT_SERVER from SERVICE_TYPE in separate mode and switches from commonEnv to RR_GIT_SERVER_HOST/PORT proxy vars; blob-storage vars are no longer duplicated onto the backend when git server is split out. |
| charts/retool/templates/deployment_mcp.yaml | MCP auto-wiring to the standalone git server URL is clean; explicit mcp.config.retoolGitServerUrl correctly takes precedence over the auto-computed URL. |
| charts/retool/values.yaml | Adds rrGitServer.separate stanza with sensible defaults (disabled, port 3010, 1 replica, empty affinity/resources/annotations/labels); mirrored identically to values.yaml at repo root. |
| charts/retool/ci/test-rr-git-server-separate-option.yaml | CI test values exercising separate mode with S3 blob storage and MCP auto-wiring; covers the main happy path. |
Sequence Diagram
sequenceDiagram
participant Client
participant Backend as Main Backend
participant GitSvc as git-server Service (ClusterIP)
participant GitDep as git-server Deployment
participant MCP as MCP Server
participant PG as PostgreSQL
participant Blob as Blob Storage
Note over Backend,GitDep: rrGitServer.separate.enabled = true
Client->>Backend: "/api/ai/rr/git/v2/* request"
Backend->>GitSvc: proxy via RR_GIT_SERVER_HOST:RR_GIT_SERVER_PORT
GitSvc->>GitDep: route to git-server pod
GitDep->>PG: read/write git metadata
GitDep->>Blob: read/write git objects
GitDep-->>Backend: git response
Backend-->>Client: response
MCP->>GitSvc: RETOOL_GIT_SERVER_URL (auto-wired)
GitSvc->>GitDep: route to git-server pod
Reviews (1): Last reviewed commit: "[feat][r2] optionally split rrGitServer ..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| env: | ||
| - name: DEPLOYMENT_TEMPLATE_TYPE | ||
| value: {{ template "retool.deploymentTemplateType" . }} | ||
| - name: DEPLOYMENT_TEMPLATE_VERSION | ||
| value: {{ template "retool.deploymentTemplateVersion" . }} | ||
| - name: NODE_ENV | ||
| value: production | ||
| - name: SERVICE_TYPE | ||
| value: RR_GIT_SERVER | ||
| - name: RR_GIT_SERVER_PORT | ||
| value: {{ $gitServerPort | quote }} | ||
| # The standalone git server does not run migrations; the main backend owns them. | ||
| - name: DISABLE_DATABASE_MIGRATIONS | ||
| value: "true" | ||
| - name: COOKIE_INSECURE | ||
| value: {{ .Values.config.useInsecureCookies | quote }} | ||
| - name: POSTGRES_HOST | ||
| value: {{ template "retool.postgresql.host" . }} | ||
| - name: POSTGRES_PORT | ||
| value: {{ template "retool.postgresql.port" . }} | ||
| - name: POSTGRES_DB | ||
| value: {{ template "retool.postgresql.database" . }} | ||
| - name: POSTGRES_USER | ||
| value: {{ template "retool.postgresql.user" . }} | ||
| - name: POSTGRES_SSL_ENABLED | ||
| value: {{ template "retool.postgresql.ssl_enabled" . }} | ||
| {{- if include "shouldIncludeConfigSecretsEnvVars" . }} | ||
| - name: LICENSE_KEY | ||
| valueFrom: | ||
| secretKeyRef: | ||
| {{- if .Values.config.licenseKeySecretName }} | ||
| name: {{ .Values.config.licenseKeySecretName }} | ||
| key: {{ .Values.config.licenseKeySecretKey | default "license-key" }} | ||
| {{- else }} | ||
| name: {{ template "retool.fullname" . }} | ||
| key: license-key | ||
| {{- end }} | ||
| - name: JWT_SECRET | ||
| valueFrom: | ||
| secretKeyRef: | ||
| {{- if .Values.config.jwtSecretSecretName }} | ||
| name: {{ .Values.config.jwtSecretSecretName }} | ||
| key: {{ .Values.config.jwtSecretSecretKey | default "jwt-secret" }} | ||
| {{- else }} | ||
| name: {{ template "retool.fullname" . }} | ||
| key: jwt-secret | ||
| {{- end }} | ||
| - name: ENCRYPTION_KEY | ||
| valueFrom: | ||
| secretKeyRef: | ||
| {{- if .Values.config.encryptionKeySecretName }} | ||
| name: {{ .Values.config.encryptionKeySecretName }} | ||
| key: {{ .Values.config.encryptionKeySecretKey | default "encryption-key" }} | ||
| {{- else }} | ||
| name: {{ template "retool.fullname" . }} | ||
| key: encryption-key | ||
| {{- end }} | ||
| - name: POSTGRES_PASSWORD | ||
| valueFrom: | ||
| secretKeyRef: | ||
| {{- if .Values.postgresql.enabled }} | ||
| name: {{ template "retool.postgresql.fullname" . }} | ||
| # `postgres` is the default admin username for postgres in the subchart we use, so it needs the admin password | ||
| # if a different username is picked, then it needs the custom password instead. | ||
| {{- if eq .Values.postgresql.auth.username "postgres" }} | ||
| key: postgres-password | ||
| {{- else }} | ||
| key: password | ||
| {{- end }} | ||
| {{- else }} | ||
| {{- if .Values.config.postgresql.passwordSecretName }} | ||
| name: {{ .Values.config.postgresql.passwordSecretName }} | ||
| key: {{ .Values.config.postgresql.passwordSecretKey | default "postgresql-password" }} | ||
| {{- else }} | ||
| name: {{ template "retool.fullname" . }} | ||
| key: postgresql-password | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- include "retool.rrGitServer.commonEnv" . | nindent 10 }} |
There was a problem hiding this comment.
Every other Retool service deployment (backend, jobs, workflows, workers, code-executor, js-executor) calls {{- include "retool.telemetry.includeEnvVars" . | nindent 10 }} to inject RTEL_ENABLED, RTEL_SERVICE_NAME, STATSD_HOST/PORT, and the K8S_* field refs that feed the telemetry sidecar. The standalone git server deployment omits this call entirely. The PR description explicitly lists "telemetry" as one of the env var groups the git server receives, but it is absent from the rendered pod spec. Additionally, the pod template does not set the telemetry.retool.com/service-name label required by RTEL_SERVICE_NAME, so if telemetry were added without that label the service-name fieldRef would resolve to an empty string.
| {{- if include "retool.rrGitServer.separateEnabled" . }} | ||
| {{- include "retool.rrGitServer.validateBlobStorage" . }} | ||
| {{- $gitServerPort := include "retool.rrGitServer.port" . }} | ||
| {{- $gitServerValues := .Values.rrGitServer.separate }} | ||
| apiVersion: v1 | ||
| kind: Service | ||
| metadata: | ||
| name: {{ template "retool.rrGitServer.name" . }} | ||
| labels: | ||
| {{- include "retool.labels" . | nindent 4 }} | ||
| {{- with $gitServerValues.labels }} | ||
| {{- range $key, $value := . }} | ||
| {{ $key }}: {{ $value | quote }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- with $gitServerValues.annotations }} | ||
| annotations: | ||
| {{- range $key, $value := . }} | ||
| {{ $key }}: {{ $value | quote }} | ||
| {{- end }} | ||
| {{- end }} | ||
| spec: | ||
| selector: | ||
| retoolService: {{ template "retool.rrGitServer.name" . }} | ||
| ports: | ||
| - name: http-server | ||
| protocol: TCP | ||
| port: {{ $gitServerPort }} | ||
| targetPort: {{ $gitServerPort }} | ||
| --- |
There was a problem hiding this comment.
Every other multi-replica Retool service (backend, dbconnector, code-executor, js-executor, workflows, workers) renders a PodDisruptionBudget alongside its Deployment. The PR description states "A matching Service (+ PDB) is rendered" but the template ends after the Deployment — there is no PDB block. If this deployment is set to replicaCount: 2 (as the CI test does), a rolling node drain can take down all git-server pods simultaneously with no protection.
| {{- with $gitServerValues.annotations }} | ||
| annotations: | ||
| {{- range $key, $value := . }} | ||
| {{ $key }}: {{ $value | quote }} | ||
| {{- end }} | ||
| {{- end }} | ||
| spec: | ||
| selector: | ||
| retoolService: {{ template "retool.rrGitServer.name" . }} | ||
| ports: | ||
| - name: http-server | ||
| protocol: TCP | ||
| port: {{ $gitServerPort }} | ||
| targetPort: {{ $gitServerPort }} | ||
| --- | ||
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| metadata: | ||
| name: {{ template "retool.rrGitServer.name" . }} | ||
| labels: | ||
| {{- include "retool.labels" . | nindent 4 }} | ||
| {{- if .Values.deployment.annotations }} | ||
| annotations: | ||
| {{ toYaml .Values.deployment.annotations | indent 4 }} | ||
| {{- end }} | ||
| spec: | ||
| replicas: {{ $gitServerValues.replicaCount | default 1 }} | ||
| selector: | ||
| matchLabels: | ||
| retoolService: {{ template "retool.rrGitServer.name" . }} | ||
| revisionHistoryLimit: {{ .Values.revisionHistoryLimit }} | ||
| template: | ||
| metadata: | ||
| annotations: | ||
| {{- if .Values.podAnnotations }} | ||
| {{ toYaml .Values.podAnnotations | indent 8 }} | ||
| {{- end }} | ||
| {{- with $gitServerValues.annotations }} | ||
| {{ toYaml . | indent 8 }} |
There was a problem hiding this comment.
annotations key applied to both the Service and the Pod template
$gitServerValues.annotations (i.e., rrGitServer.separate.annotations) is rendered into metadata.annotations on the Service (lines 16-21) and into the pod template metadata.annotations inside the Deployment (lines 53-55). Annotations for these two resources have different semantics: Service annotations are typically used for cloud load-balancer configuration or external-DNS, while pod annotations are used for things like Prometheus scraping or Vault injection. A user who sets a pod annotation (e.g., prometheus.io/scrape: "true") would also have it land on the Service, and vice versa. Consider splitting this into rrGitServer.separate.podAnnotations and rrGitServer.separate.serviceAnnotations, or at minimum document the dual application.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
1 participant
Summary
Adds
rrGitServer.separate.enabledto optionally run the git server as a dedicated deployment + service instead of in-process on the main backend, mirroring how the workload is split in Retool Cloud. The split-out git server is reached over normal Kubernetes service discovery.Stacks on top of the in-process git server work (
#296), so this PR targetsr2-cleanup.When
rrGitServer.separate.enabled: true<release>-git-serverDeployment runsSERVICE_TYPE=RR_GIT_SERVERonRR_GIT_SERVER_PORT, with the Postgres connection, bootstrap secrets (license/JWT/encryption/pg password), blob-storage env, and telemetry. A matching Service (+ PDB) is rendered.RR_GIT_SERVERfrom itsSERVICE_TYPEand proxies git traffic to the service viaRR_GIT_SERVER_HOST/RR_GIT_SERVER_PORT.RETOOL_GIT_SERVER_URL, unlessmcp.config.retoolGitServerUrlis set explicitly.In-process mode (
rrGitServer.enabledwithoutseparate) is unchanged.Implementation notes
retool.rrGitServer.commonEnvso the in-process backend and the standalone deployment stay in sync.retool.rrGitServer.{name,separateEnabled,port,url}.values.yamlfiles kept byte-identical (sync check).The backend→remote git server contract uses
RR_GIT_SERVER_HOST(bare service DNS) +RR_GIT_SERVER_PORT, extending the documented in-processRR_GIT_SERVER_PORT. If the backend expects a different var (e.g. a full URL), it's a one-line change indeployment_backend.yaml. DefaultrrGitServer.separate.portis3010.Testing
helm lintpasses.RR_GIT_SERVERabsent from backend), in-process mode (unchanged), and default-off mode. All parse as valid YAML.ci/test-rr-git-server-separate-option.yamlexercising the split + S3 blob storage + MCP auto-wiring.🤖 Generated with Claude Code