@seatgeek/backstage-plugin-slack-catalog-backend
v2.0.0
Published
This plugin offers catalog integrations for ingesting data from the Slack API into the Software Catalog.
Downloads
1,017
Readme
@seatgeek/backstage-plugin-slack-catalog-backend
This plugin offers catalog integrations for ingesting data from the Slack API into the Software Catalog.
Installation
Install the @seatgeek/backstage-plugin-slack-catalog-backend
package in your backend package:
# From your Backstage root directory
yarn add --cwd packages/backend @seatgeek/backstage-plugin-slack-catalog-backend
Add the following config to your app-config.yaml
:
slackCatalog:
token: ${SLACK_API_TOKEN_CATALOG}
More information about Slack scopes requirements.
Processors
SlackUserProcessor
Enriches existing User
entities with information from Slack, notably the user's Slack ID and profile picture, based on the user's .profile.email
.
Installation
Add the following to your packages/backend/index.ts
:
backend.add(import('@seatgeek/backstage-plugin-slack-catalog-backend'));
Legacy backend system
Add the following to your packages/backend/catalog.ts
:
import { SlackUserProcessor } from '@seatgeek/backstage-plugin-slack-catalog-backend';
export default async function createPlugin(
env: PluginEnvironment,
): Promise<Router> {
const builder = CatalogBuilder.create(env);
builder.addProcessor(
// Add the slack user processor
SlackUserProcessor.fromConfig(env.config, env.logger),
);
const { processingEngine, router } = await builder.build();
processingEngine.start();
return router;
}