Set up process #

brew install cloudquery/tap/cloudquery

1. Download CLI and login

See installation options

2. Create source and destination configs

Plugin configuration

cloudquery sync backstage.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview #

The Backstage Source plugin for CloudQuery extracts configuration from the Backstage API and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).

Configuration #

The following configuration syncs from Backstage to a Postgres destination. The (top level) source spec section is described in the Source Spec Reference. The config for the postgresql destination is not shown here. See our Quickstart if you need help setting up the destination.

kind: source
spec:
  name: "backstage"
  path: "cloudquery/backstage"
  registry: "cloudquery"
  version: "v1.4.6"
  tables: ["*"]
  destinations:
    - "postgresql"
  spec:
    # Required, replace with your Backstage URL
    base_url: "https://demo.backstage.io"
    # Optional
    # Additional headers to send with each request. For example, to provide authentication.
    # additional_headers:
    #   Authorization: "Bearer <token>"

Backstage Spec #

This is the (nested) spec used by the Backstage source plugin:

base_url (string) (required)
The base URL of the Backstage API. For local backstage, this is typically http://localhost:7000.
filter (string) (optional)
To sync only subset of entities. As defined in Backstage documentation
concurrency (integer) (optional) (default: 50000)
The best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
additional_headers (map[string]string) (optional)
Additional headers to send with each request. For example, to provide authentication.