Overview

Welcome to the sg-library plugin!

This plugin can be used to deploy stacks and workflows using templates present on SG platform directly from backstage app.

Installation & Usage

1. To install this plugin into your backstage app run following command at root of your project.

yarn --cwd packages/app add @stackguardian/backstage-plugin-sg-library

2. In order to use this plugin please update config.yaml to have following information.

integrations:
  stackguardian:
    organization: '' # StackGuardian Organization name
backend:
  baseUrl: '' # Backstage Backend URL
  listen:
    port: 7007
proxy:
  '/stackguardian':
    target: 'https://api.app.stackguardian.io/api/v1'
    headers:
      Authorization: 'apikey {SG_API_KEY}'
    allowedHeaders:
      - x-sg-orgid
    changeOrigin: true

Set SG_API_KEY env var by getting your API Key from StackGuardian platform. Please check our docs to view how to get API Token from stackguardian platform.

NOTE - This plugin will use backstage proxy server to communicate to StackGuardian APIs (Mostly to avoid CORS error and to prevent exposing of API Key in the browser's network tab).

3. Now you can import SgLibraryPage component from @stackguardian/backstage-plugin-sg-library and your APP will start showing SG Library plugin.

Screenshots