Skip to content

fix: register DynamoDB Table template in Backstage catalog location#728

Open
csantanapr wants to merge 2 commits into
mainfrom
fix/backstage-ddb-template-registration
Open

fix: register DynamoDB Table template in Backstage catalog location#728
csantanapr wants to merge 2 commits into
mainfrom
fix/backstage-ddb-template-registration

Conversation

@csantanapr

@csantanapr csantanapr commented Jun 7, 2026

Copy link
Copy Markdown
Member

Summary

Fixes #727

Adds the DynamoDB Table template as a commented-out entry in platform/backstage/templates/catalog-info.yaml. Participants uncomment the line as part of the GenAI lab to register their AI-generated template via GitOps.

Change

     - ./cicd-pipeline/template-cicd-pipeline.yaml
     - ./platform-entities.yaml
+    # Uncomment the line below to register the custom DynamoDB template (Module 1 - GenAI section)
+    # - ../customtemplates/ddb-table/template.yaml

Why this approach

  • The manual "Register Existing Component" import UI silently fails for this GitLab integration (see fix: DynamoDB Table Template not visible in Backstage Create page #727 for root cause)
  • templates/catalog-info.yaml is the only catalog location Backstage polls (confirmed in backstage-config ConfigMap)
  • Keeping the line commented preserves the learning objective: participants discover the GitOps pattern of modifying a platform config file to register a template

Participant flow (replaces broken import UI steps)

  1. Generate DDB template with AI, compare with reference solution
  2. Uncomment # - ../customtemplates/ddb-table/template.yaml in catalog-info.yaml
  3. git add / commit / push
  4. kubectl rollout restart deployment/backstage -n backstage && kubectl rollout status ... (~60s)
  5. Template immediately visible in Backstage Create page

Note: The companion workshop content change (updating 005_Section4_Gitlab_Push/index.en.md to replace the broken import steps with the GitOps steps above) must be applied in the workshop content repo (GitLab).

Testing

Verified end-to-end:

  • Commented line present — template NOT in Backstage Create page ✅
  • Uncomment + git push + kubectl rollout restart ✅
  • Backstage pod comes up in ~60s ✅
  • Template immediately available at /backstage/create/templates/default/ddb-table-template-ack-kro
  • Template form loads, submission creates DynamoDB table ✅

The customtemplates/ddb-table template was not appearing in Backstage
because the manual catalog import UI silently fails to create Location
entities — the backend processor cannot resolve relative paths from
GitLab blob URLs submitted via the import form.

Fix: add the ddb-table template directly to the existing working
Location entity in templates/catalog-info.yaml, which is already
polled by Backstage's catalog processor.

Verified end-to-end: template loads, DynamoDB table created via ACK/kro.
Participants uncomment this line as part of the GenAI lab to register
their AI-generated DynamoDB Backstage template using GitOps.
Fixes #727
@csantanapr csantanapr requested a review from allamand June 7, 2026 21:24
@allamand

Copy link
Copy Markdown
Contributor

@csantanapr this is strange, this was working fine before, and the manual importing was an alternative way to showcase this. but I agree that Gitops first may be better, but that also needs update in the instructions

@allamand allamand added the question Further information is requested label Jun 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

question Further information is requested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: DynamoDB Table Template not visible in Backstage Create page

2 participants