Backstage Amplication Resources Plugin

What you will set up

You will install two backend modules that work together

• Catalog backend module that adds an Amplication catalog processor
• Scaffolder backend module that adds an Amplication action to scaffold a new service

There is no frontend package to install. The catalog will show the new entities after the backend sync runs.

Install the backend modules

Run these from your Backstage root

yarn workspace backend add @backstage-community/plugin-catalog-backend-module-amplication
yarn workspace backend add @backstage-community/plugin-scaffolder-backend-module-amplication

Configure app config

Add Amplication settings and the catalog location. Edit app-config.yaml

amplication:
  appUrl: https://app.amplication.com
  apiUrl: https://server.amplication.com/graphql
  token: ${AMPLICATION_TOKEN}

catalog:
  locations:
    - type: amplication
      target: https://server.amplication.com/graphql

Set AMPLICATION_TOKEN in the backend process environment.

New backend system

Register the modules

Edit packages/backend/src/index.ts

// packages/backend/src/index.ts
import { createBackend } from '@backstage/backend-defaults';

const backend = createBackend();

// Amplication catalog processor
backend.add(
  import('@backstage-community/plugin-catalog-backend-module-amplication'),
);

// Amplication scaffolder action
backend.add(
  import('@backstage-community/plugin-scaffolder-backend-module-amplication'),
);

backend.start();

Add an Amplication action to a template

Add the action to one of your Software Templates. Example action block

id: scaffoldService
name: Scaffold a New Service
action: amplication:scaffold-service
input:
  name: fooService
  description: fooService description
  project_id: 1a2b3c4d5e6f7g8h9i0j
  serviceTemplate_id: 9i8h7g6f5e4d3c2b1a0
  workspace_id: f1e2d3c4b5a6978685d4

Place this block inside a template that you already expose in your Backstage Scaffolder page.

Legacy backend system

This plugin ships a BackendFeature for the new backend system. A legacy backend registration is not provided. Migrate your backend to the new system to use this plugin.

Optional service discovery

If your new services include a catalog info file you can auto discover them with GitHub. Add this to app-config.yaml if you use the GitHub provider

catalog:
  providers:
    github:
      providerId:
        organization: YOUR_GITHUB_ORGANIZATION
        catalogPath: '**/catalog-info.yaml'
        filters:
          repository: '.*'

Where it shows in the app

The catalog backend module pulls Amplication templates into the catalog. It also adds entities for the Amplication bot user plus System plus API. You can view them in the Catalog pages after the backend sync runs. The scaffolder action appears in your template where you added the action.