@cortexapps/backstage-backend-plugin v1.6.2

Cortex Backend Plugin for Backstage

See the Cortex Scorecard Plugin for more details. The backend plugin will allow you to sync your Backstage services with Cortex asynchronously, set to any cron schedule of your choosing.

To start using the Backstage plugin and see a demo, please book a demo!

Setup and Integration

1. In the packages/backend directory of your Backstage instance, add the plugin as a package.json dependency:

$ yarn add @cortexapps/backstage-backend-plugin

2. Create a new file: packages/backend/src/plugins/cortex.ts:

import { PluginEnvironment } from '../types';
import { createRouter } from '@cortexapps/backstage-backend-plugin';

export default async function createPlugin(env: PluginEnvironment) {
  return await createRouter({
    discoveryApi: env.discovery,
    logger: env.logger,
    cronSchedule: env.config.getOptionalString('cortex.backend.cron') ?? '0 3,7,11,15,19,23 * * *'
  });
}

3. Update packages/backend/src/index.ts:

import cortex from './plugins/cortex';
...
const cortexEnv = useHotMemoize(module, () => createEnv('cortex'));
...
apiRouter.use('/cortex', await cortex(cortexEnv));

4. Update app-config.yaml to add a new config under the proxy section:

'/cortex':
    target: ${CORTEX_BACKEND_HOST_URL}
    headers:
      Authorization: Bearer ${CORTEX_TOKEN}

5. (Optional) You can choose to have the entity sync cron job use gzip to compress the entities by updating cortex.ts from step 2. You must also update the Backstage HTTP proxy to allow the Content-Encoding header.

import { PluginEnvironment } from '../types';
import { createRouter } from '@cortexapps/backstage-backend-plugin';

export default async function createPlugin(env: PluginEnvironment) {
  return await createRouter({
    discoveryApi: env.discovery,
    logger: env.logger,
    syncWithGzip: true,
    cronSchedule: env.config.getOptionalString('cortex.backend.cron') ?? '0 3,7,11,15,19,23 * * *'
  });
}

proxy:
  '/cortex':
    target: ${CORTEX_BACKEND_HOST_URL}
    headers:
      Authorization: ${CORTEX_TOKEN}
    allowedHeaders:
      - Content-Encoding