update changelog and docs

Signed-off-by: Christopher Diaz <cdiaz@rvohealth.com>
This commit is contained in:
Christopher Diaz
2023-05-16 10:49:44 -04:00
parent 47b9f0fe93
commit 3361cb8a32
2 changed files with 27 additions and 1 deletions
+12 -1
View File
@@ -2,4 +2,15 @@
'@backstage/plugin-search-backend-module-explore': patch
---
Allows for an optional token manager to authenticate requests from the collator to the explore backend
Allows for an optional token manager to authenticate requests from the collator to the explore backend. For example:
```
indexBuilder.addCollator({
schedule: every10MinutesSchedule,
factory: ToolDocumentCollatorFactory.fromConfig(env.config, {
discovery: env.discovery,
logger: env.logger,
tokenManager: env.tokenManager,
}),
});
```
@@ -39,3 +39,18 @@ backend.add(searchPlugin());
backend.add(searchModuleExploreCollator({ schedule }));
backend.start();
```
### Using Auth Middleware
If your Backstage instance uses service-to-service authentication you can pass an optional tokenManager to the collator factory. This will ensure that the collator makes authenticated requests to the explore backend.
```tsx
indexBuilder.addCollator({
schedule: every10MinutesSchedule,
factory: ToolDocumentCollatorFactory.fromConfig(env.config, {
discovery: env.discovery,
logger: env.logger,
tokenManager: env.tokenManager,
}),
});
```