Merge pull request #10669 from anicke/gerrit-entity-provider

New plugin: "plugin-catalog-backend-module-gerrit"
2022-04-21 14:20:23 +02:00
parent aa75fc1568 566407bf8a
commit 3feeeef3b6
23 changed files with 845 additions and 1 deletions
@@ -0,0 +1,69 @@
+---
+id: discovery
+title: Gerrit Discovery
+sidebar_label: Discovery
+# prettier-ignore
+description: Automatically discovering catalog entities from Gerrit repositories
+---
+
+The Gerrit integration has a special entity provider for discovering catalog entities
+from Gerrit repositories. The provider uses the "List Projects" API in Gerrit to get
+a list of repositories and will automatically ingest all `catalog-info.yaml` files
+stored in the root of the matching projects.
+
+## Installation
+
+As this provider is not one of the default providers, you will first need to install
+the Gerrit provider plugin:
+
+```bash
+# From the Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-gerrit
+```
+
+Then add the plugin to the plugin catalog `packages/backend/src/plugins/catalog.ts`:
+
+```ts
+/* packages/backend/src/plugins/catalog.ts */
+import { GerritEntityProvider } from '@backstage/plugin-catalog-backend-module-gerrit';
+import { Duration } from 'luxon';
+const builder = await CatalogBuilder.create(env);
+/** ... other processors and/or providers ... */
+builder.addEntityProvider(
+  ...GerritEntityProvider.fromConfig(env.config, {
+    logger: env.logger,
+    schedule: env.scheduler.createScheduledTaskRunner({
+      frequency: Duration.fromObject({ minutes: 30 }),
+      timeout: Duration.fromObject({ minutes: 3 }),
+    }),
+  }),
+);
+```
+
+## Configuration
+
+To use the discovery processor, you'll need a Gerrit integration
+[set up](locations.md). Then you can add any number of providers.
+
+```yaml
+# app-config.yaml
+catalog:
+  providers:
+    gerrit:
+      yourProviderId: # identifies your dataset / provider independent of config changes
+        host: gerrit-your-company.com
+        branch: master # Optional
+        query: 'state=ACTIVE&prefix=webapps'
+      backend:
+        host: gerrit-your-company.com
+        branch: master # Optional
+        query: 'state=ACTIVE&prefix=backend'
+```
+
+The provider configuration is composed of three parts:
+
+- host, the host of the Gerrit integration to use.
+- branch, the branch where we will look for catalog entities (defaults to "master").
+- query, this string is directly used as the argument to the "List Project" API.
+  Typically you will want to have some filter here to exclude projects that will
+  never contain any catalog files.