@janus-idp/backstage-plugin-lightspeed-backend

Lightspeed Backend

This is the lightspeed backend plugin that enables you to interact with any LLM server running a model with OpenAI's API compatibility.

Getting Started

Installing the plugin

yarn add --cwd packages/backend  @janus-idp/backstage-plugin-lightspeed-backend

Configuring the Backend

Old Backend System

1. Create a new file packages/backend/src/plugins/lightspeed.ts, and add the following

import { Router } from 'express';

import { createRouter } from '@janus-idp/backstage-plugin-lightspeed-backend';

import { PluginEnvironment } from '../types';

export default async function createPlugin(
  env: PluginEnvironment,
): Promise<Router> {
  return await createRouter({
    config: env.config,
    logger: env.logger,
    discovery: env.discovery,
    catalogApi: env.catalogApi,
  });
}

1. Next, in your overall backend router (typically packages/backend/src/index.ts) add a route for /lightspeed:

import lightspeed from './plugins/lightspeed';

// ...
async function main() {
  // ...
  // Add the following line
  const lightspeedEnv = useHotMemoize(module, () => createEnv('lightspeed'));
  // ...
  // Add the following line under the other lines that add their routers to apiRouter
  apiRouter.use('/lightspeed', await lightspeed(lightspeedEnv));
  // ...
}

New Backend System

Add the following to your packages/backend/src/index.ts file:

const backend = createBackend();

// Add the following line
backend.add(import('@janus-idp/backstage-plugin-lightspeed-backend'));

backend.start();

Plugin Configurations

Add the following proxy configurations into your app-config.yaml file:

proxy:
  endpoints:
    '/lightspeed/api':
      target: '<LLM server URL>'
      headers:
        content-type: 'application/json'
        Authorization: 'Bearer <api-token>'
      secure: true
      changeOrigin: true
      credentials: 'dangerously-allow-unauthenticated' # No Backstage credentials are required to access this proxy target

Example local development configuration:

proxy:
  endpoints:
    '/lightspeed/api':
      target: 'https://localhost:443/v1'
      headers:
        content-type: 'application/json'
        Authorization: 'Bearer js92n-ssj28dbdk902' # dummy token
      secure: true
      changeOrigin: true
      credentials: 'dangerously-allow-unauthenticated' # No Backstage credentials are required to access this proxy target