Merge pull request #24038 from awanlin/topic/nbs-external-integrations

Updated external integrations with new backend system examples
2024-04-09 12:06:46 +02:00
parent c6635e5ef5 b819c00802
commit 605bcab49f
1 changed files with 117 additions and 0 deletions
@@ -279,6 +279,45 @@ the `connect` call has been made to the provider.
 Start up the backend - it should now start reading from the previously
 registered location and you'll see your entities start to appear in Backstage.

+#### New Backend System
+
+To install the provider using the new backend system you will need to create a module and add it to your backend. The following is a very simplified example of what that would look like:
+
+```ts title="packages/backend/src/index.ts"
+import { createBackend } from '@backstage/backend-defaults';
+import {
+  coreServices,
+  createBackendModule,
+} from '@backstage/backend-plugin-api';
+import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';
+import { FrobsProvider } from './path/to/class';
+
+export const catalogModuleFrobsProvider = createBackendModule({
+  pluginId: 'catalog',
+  moduleId: 'frobs-provider',
+  register(env) {
+    env.registerInit({
+      deps: {
+        catalog: catalogProcessingExtensionPoint,
+        reader: coreServices.urlReader,
+      },
+      async init({ catalog, reader }) {
+        catalog.addEntityProvider(new FrobsProvider('dev', reader));
+      },
+    });
+  },
+});
+
+const backend = createBackend();
+
+backend.add(import('@backstage/plugin-catalog-backend/alpha'));
+backend.add(catalogModuleFrobsProvider);
+
+// Other plugins ...
+
+backend.start();
+```
+
 ### Example User Entity Provider

 If you have a 3rd party entity provider such as an internal HR system that you wish to use you are not limited to using our entity providers, (or simply wish to add to existing entity providers with your own data).
@@ -586,6 +625,45 @@ export default async function createPlugin(
 Start up the backend - it should now start reading from the previously
 registered location and you'll see your entities start to appear in Backstage.

+#### Installing Processor Using New Backend System
+
+To install the processor using the new backend system you will need to create a module and add it to your backend. The following is a very simplified example of what that would look like:
+
+```ts title="packages/backend/src/index.ts"
+import { createBackend } from '@backstage/backend-defaults';
+import {
+  coreServices,
+  createBackendModule,
+} from '@backstage/backend-plugin-api';
+import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';
+import { SystemXReaderProcessor } from '../path/to/class';
+
+export const catalogModuleSystemXReaderProcessor = createBackendModule({
+  pluginId: 'catalog',
+  moduleId: 'system-x-reader-processor',
+  register(env) {
+    env.registerInit({
+      deps: {
+        catalog: catalogProcessingExtensionPoint,
+        reader: coreServices.urlReader,
+      },
+      async init({ catalog, reader }) {
+        catalog.addProcessor(new SystemXReaderProcessor(reader));
+      },
+    });
+  },
+});
+
+const backend = createBackend();
+
+backend.add(import('@backstage/plugin-catalog-backend/alpha'));
+backend.add(catalogModuleSystemXReaderProcessor);
+
+// Other plugins ...
+
+backend.start();
+```
+
 ### Caching processing results

 The catalog periodically refreshes entities in the catalog, and in doing so it
@@ -808,3 +886,42 @@ import { customEntityDataParser } from '../lib/customEntityDataParser';

 builder.setEntityDataParser(customEntityDataParser);
 ```
+
+#### Using Custom Entity Data Parser with New Backend System
+
+To use a custom entity data parse with the new backend system you will need to create a module and add it to your backend. The following is a very simplified example of what that would look like:
+
+```ts title="packages/backend/src/index.ts"
+import { createBackend } from '@backstage/backend-defaults';
+import {
+  coreServices,
+  createBackendModule,
+} from '@backstage/backend-plugin-api';
+import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node/alpha';
+import { customEntityDataParser } from '../lib/customEntityDataParser';
+
+export const catalogModuleCustomDataParser = createBackendModule({
+  pluginId: 'catalog',
+  moduleId: 'custom-data-parser',
+  register(env) {
+    env.registerInit({
+      deps: {
+        catalog: catalogModelExtensionPoint,
+        reader: coreServices.urlReader,
+      },
+      async init({ catalog, reader }) {
+        catalog.setEntityDataParser(customEntityDataParser);
+      },
+    });
+  },
+});
+
+const backend = createBackend();
+
+backend.add(import('@backstage/plugin-catalog-backend/alpha'));
+backend.add(catalogModuleCustomDataParser);
+
+// Other plugins ...
+
+backend.start();
+```