chore(events,catalog/github): update with review comments

Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2022-11-23 15:34:39 +00:00
parent a0fd4af94a
commit e90b092d2a
8 changed files with 196 additions and 319 deletions
@@ -14,7 +14,7 @@ organization and register entities matching the configured path. This can be
 useful as an alternative to static locations or manually adding things to the
 catalog. This is the preferred method for ingesting entities into the catalog.

-## Installation
+## Installation without Events Support

 You will have to add the provider in the catalog initialization code of your
 backend. They are not installed by default, therefore you have to add a
@@ -53,6 +53,51 @@ And then add the entity provider to your catalog builder:
  }
 ```

+## Installation with Events Support
+
+Please follow the installation instructions at
+
+- https://github.com/backstage/backstage/tree/master/plugins/events-backend/README.md
+- https://github.com/backstage/backstage/tree/master/plugins/events-backend-module-github/README.md
+
+Additionally, you need to decide how you want to receive events from external sources like
+
+- [via HTTP endpoint](https://github.com/backstage/backstage/tree/master/plugins/events-backend/README.md)
+- [via an AWS SQS queue](https://github.com/backstage/backstage/tree/master/plugins/events-backend-module-aws-sqs/README.md)
+
+Set up your provider
+
+```diff
+// packages/backend/src/plugins/catalogEventBasedProviders.ts
+import { CatalogClient } from '@backstage/catalog-client';
+import { GithubEntityProvider } from '@backstage/plugin-catalog-backend-module-github';
+ import { EntityProvider } from '@backstage/plugin-catalog-node';
+ import { EventSubscriber } from '@backstage/plugin-events-node';
+ import { PluginEnvironment } from '../types';
+ export default async function createCatalogEventBasedProviders(
+-  _: PluginEnvironment,
+  env: PluginEnvironment,
+ ): Promise<Array<EntityProvider & EventSubscriber>> {
+   const providers: Array<
+     (EntityProvider & EventSubscriber) | Array<EntityProvider & EventSubscriber>
+   > = [];
+-  // add your event-based entity providers here
+  providers.push(
+    GithubEntityProvider.fromConfig(env.config, {
+       logger: env.logger,
+       // optional: alternatively, use scheduler with schedule defined in app-config.yaml
+       schedule: env.scheduler.createScheduledTaskRunner({
+         frequency: { minutes: 30 },
+         timeout: { minutes: 3 },
+       }),
+       // optional: alternatively, use schedule
+       scheduler: env.scheduler,
+    }),
+  );
+   return providers.flat();
+ }
+```
+
 ## Configuration

 To use the discovery provider, you'll need a GitHub integration
@@ -111,13 +156,6 @@ catalog:
          branch: 'main' # string
          repository: '.*' # Regex
        validateLocationsExist: true # optional boolean
-      checkRepositoryFiltersForWebhook:
-        organization: 'backstage' # string
-        catalogPath: '/catalog-info.yaml' # string
-        filters:
-          branch: 'main' # string
-          repository: '.*' # Regex
-        checkRepositoryFiltersForWebhook: true # optional boolean
      enterpriseProviderId:
        host: ghe.example.net
        organization: 'backstage' # string
@@ -160,11 +198,6 @@ This provider supports multiple organizations via unique provider IDs.
  Defaults to `false`.
  Due to limitations in the GitHub API's ability to query for repository objects, this option cannot be used in
  conjunction with wildcards in the `catalogPath`.
- **`checkRepositoryFiltersForWebhook`** _(optional)_:
-  Whether to validate push events received from webhook.
-  This option enforce check the repository from push event to be matched against the filters configured in the entity provider.
-  Defaults to `false`.
-  It is disabled for default because you can configure the webhook only in expected repositories
 - **`schedule`** _(optional)_:
  - **`frequency`**:
    How often you want the task to run. The system does its best to avoid overlapping invocations.