paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 48 Packages Projects Releases Wiki Activity

add more info to the readme of the catalog collator

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2023-08-14 15:49:10 +02:00
parent 3c543a91e2
commit 9fb4c0d65d
1 changed files with 46 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/search-backend-module-catalog/README.md
+46 -11
View File
@@ -2,11 +2,18 @@
> DISCLAIMER: The new backend system is in alpha, and so are the search backend module support for the new backend system. We don't recommend you to migrate your backend installations to the new system yet. But if you want to experiment, you can find getting started guides below.
This package exports catalog backend modules responsible for extending search.
This package exports a module that extends the search backend to also indexing the entities of your catalog.
## Example
## Installation
### Use default schedule
Add the module package as a dependency:
```bash
# From your Backstage root directory
yarn add --cwd packages/backend @backstage/plugin-search-backend-module-catalog
```
Add the collator to your backend instance, along with the search plugin itself:
```tsx
// packages/backend-next/src/index.ts
@@ -20,22 +27,50 @@ backend.add(searchModuleCatalogCollator());
backend.start();
```
### Use custom schedule
You may also want to add configuration parameters to your app-config, for example for controlling the scheduled indexing interval. These parameters should be placed under the `search.collators.catalog` key. See [the config definition file](https://github.com/backstage/backstage/blob/master/plugins/search-backend-module-catalog/config.d.ts) for more details.
## Advanced Customizations
This module also has an extension point, which lets you inject advanced customizations. Here's an example of how to leverage that extension point to tweak the transformer used for building the search indexer documents:
```tsx
// packages/backend-next/src/index.ts
import { createBackend } from '@backstage/backend-defaults';
import { createBackendModule } from '@backstage/backend-plugin-api';
import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
import { searchModuleCatalogCollator } from '@backstage/plugin-search-backend-module-catalog/alpha';
import { CatalogCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-catalog';
import {
searchModuleCatalogCollator,
catalogCollatorExtensionPoint,
} from '@backstage/plugin-search-backend-module-catalog/alpha';
const schedule = {
frequency: { minutes: 10 },
timeout: { minutes: 15 },
initialDelay: { seconds: 3 },
};
const customTransformer: CatalogCollatorEntityTransformer = entity => ({
title: entity.metadata.title || entity.metadata.name,
text: entity.metadata.description || '',
componentType: entity.spec?.type?.toString() || 'other',
type: entity.spec?.type?.toString() || 'other',
namespace: entity.metadata.namespace || 'default',
kind: entity.kind,
lifecycle: (entity.spec?.lifecycle as string) || '',
owner: (entity.spec?.owner as string) || '',
});
const backend = createBackend();
backend.add(searchPlugin());
backend.add(searchModuleCatalogCollator({ schedule }));
backend.add(searchModuleCatalogCollator());
backend.add(
createBackendModule({
pluginId: 'search',
moduleId: 'myCatalogCollatorOptions',
register(reg) {
reg.registerInit({
deps: { collator: catalogCollatorExtensionPoint },
init({ collator }) {
collator.setEntityTransformer(customTransformer);
},
});
},
})(),
);
backend.start();
```