@seatgeek/backstage-plugin-gitlab-catalog-backend
v1.1.2
Published
This plugin offers catalog integrations for ingesting data from gitlab API.
Downloads
295
Readme
@seatgeek/backstage-plugin-gitlab-catalog-backend
This plugin offers catalog integrations for ingesting data from gitlab API.
Installation
Install the @seatgeek/backstage-plugin-gitlab-catalog-backend
package in your backend package using the new backend:
# From your Backstage root directory
yarn add --cwd packages/backend @seatgeek/backstage-plugin-gitlab-catalog-backend
Add the following config to your app-config.yaml
:
gitlabCatalog:
host: ${GITLAB_HOST_CATALOG} # defaults to https://gitlab.com
token: ${GITLAB_TOKEN_CATALOG}
Requires read_user
scope with administrator level permissions to be able to view the email, see List Users (for administrators).
Processors
GitlabUserProcessor
Enriches existing User
entities with information from Gitlab, notably the user's Gitlab ID, based on the user's .profile.email
.
Installation
Add the following to your packages/backend/index.ts
:
// in your imports
import { catalogModuleGitlabUserProcessor } from '@seatgeek/backstage-plugin-gitlab-catalog-backend';
// in your catalog modules
backend.add(catalogModuleGitlabUserProcessor);