Users/hpn/implement postg rest auto api template

[nghiaz160904]

Overview

Adds a Backstage scaffolding template for PostgREST, enabling developers to quickly provision instant REST APIs connected to PostgreSQL databases without writing backend code.

What's Implemented

Template Features:

• Scaffolds PostgREST configuration on Backstage
• Uses official postgrest/postgrest Docker image
• Generates two Git repositories:
  • Source Repo: PostgREST configuration + Dockerfile + CI/CD setup
  • GitOps Repo: HeliosApp manifest + Tekton pipelines + ArgoCD sync

Key Capabilities:

• Configurable API schema, JWT authentication, and access roles
• Automatic PostgreSQL database provisioning via Helios Operator
• Environment variable injection for database credentials (PGRST_DB_URI)
• Tekton CI/CD pipeline for automated builds
• ArgoCD GitOps synchronization
• Ingress-based REST API exposure

Files Added

• apps/portal/examples/postgrest-template/template.yaml - Backstage scaffolder template
• apps/portal/examples/postgrest-template/content/source/ - PostgREST config templates (Dockerfile, postgrestrc.conf, etc.)
• apps/portal/examples/postgrest-template/content/gitops/ - Kubernetes manifests (HeliosApp, pipeline, triggers, ArgoCD)
• Documentation: README, QUICKSTART, REGISTRATION, OPERATORS, TESTING, OPERATOR_INTEGRATION, CHECKLIST, REPO_STRUCTURE

How It Works

1. User scaffolds component on Backstage portal
2. Provides: service name, port, API schema, JWT config, database settings, Git repo
3. Template generates two repositories with all configuration
4. Operator provisions PostgreSQL database and injects credentials as Secret
5. PostgREST container starts and exposes REST API automatically

User Experience

Users can now:

# Navigate to Backstage Create page
# Select "PostgREST API Template"
# Fill in configuration
# → Instant REST API deployed to cluster

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 636683e3-a5e0-4ac3-a129-78ec025d38de

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch users/hpn/implement-PostgREST-auto-api-template

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[PhuocHoan]

Thanks for the solid progress on PostgREST template + DB URI injection. I don’t think this is ready to merge yet due to a few blocking issues.

Required fixes before merge

1. Fix broken values mapping in template

   • File: apps/portal/examples/postgrest-template/template.yaml
   • fetch-source.input.values currently collapses multiple keys into one name string.
   • Please split into proper keys (name, owner, port, description, image, apiSchema, etc.).

2. Fix invalid Backstage catalog schema field

   • File: apps/portal/examples/postgrest-template/content/source/catalog-info.yaml
   • Replace provides with providesApis (same convention as existing templates).

3. Respect selected namespace for webhook

   • File: apps/portal/examples/postgrest-template/template.yaml
   • Webhook URL is hardcoded to .default.svc...; should use ${{ parameters.namespace }}.

4. Align PGRST_DB_URI reference with operator injection contract

   • File: apps/portal/examples/postgrest-template/content/gitops/helios-app.yaml
   • Current ref (${name}-db-uri / connection-string) conflicts with operator behavior.
   • Operator injects PGRST_DB_URI from database secret key PGRST_DB_URI (see apps/operator/internal/controller/database/injection.go).

5. Fix validation script reliability

   • File: apps/portal/examples/postgrest-template/validate.sh
   • Add/install dependency handling for PyYAML or use a tool already required by repo.
   • Remove/update stale kubernetes:apply expectation at apps/portal/examples/postgrest-template/validate.sh.

Quality improvements (recommended)

1. Build DB URI using structured URL handling to avoid edge-case formatting bugs (IPv6/userinfo escaping), and update tests accordingly.
2. Add a small template render test/smoke check in CI to catch malformed values mappings early.

Once the above is addressed, this should be in much better shape for merge.

[NgocAnhDo26]

The yaml files inside gitops folder, except for helios-app.yml are redundant, consider removing them.
They should be defined (or they are already defined) using CUE. They will be auto-generated by the Operator and will be pushed to the GitOps repo.

[NgocAnhDo26]

On second thought, we also need to establish a dedicated pipeline that handles database migrations and subsequently triggers a PostgREST schema reload.
This ensures the API immediately reflects the latest database changes without necessarily rebuilding images.

Here are some of my suggestions to achieve this:

Standardize the Migration Tool:

• Specify a definitive migration tool for the template rather than leaving it open-ended.
• You can try integrating golang-migrate or Atlas, as both integrate cleanly with containers and CI/Tekton workflows. For example golang-migrate: https://github.com/golang-migrate/migrate/blob/master/database/postgres/TUTORIAL.md

Implement a Schema Reload Mechanism:

• Ensure the pipeline includes a dedicated step to reload the PostgREST schema cache immediately after migrations are applied.
• Use the psql command NOTIFY pgrst, 'reload schema'; as the primary reload method. It is much cleaner and maintains better availability than triggering a full Kubernetes rollout restart.

Update Tekton Pipeline Configurations:

• Create a new CUE pipeline definition specifically for this database workflow.
• Structure the pipeline tasks sequentially as: git-clone → migrate → reload-postgrest. Register this new pipeline in the CUE #PipelineRegistry.
• Configure a trigger mechanism, such as a manual PipelineRun for controlled migrations or a scoped EventListener that only fires on changes to the db/** path.

Address Secrets and Networking:

• Ensure the new Tekton task pod has the necessary access to the database to run the migrations.
• Explicitly mount or project the existing database Kubernetes Secret into the migration task pod so it can successfully resolve the DATABASE_URL.