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

Deprecate packages

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-04-18 20:46:29 +02:00
parent 3242f69c8e
commit 2a5657eb9c
9 changed files with 32 additions and 381 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/explore-backend/README.md
+2 -221
View File
@@ -1,222 +1,3 @@
# explore-backend
# Deprecated
The `explore-backend` plugin provides a backend service for the Explore plugin.
This allows your organizations tools to be surfaced in the Explore plugin
through an API. It also provides a search collator to make it possible to search
for these tools.
## Getting started
### Adding the plugin to your `packages/backend`
Install dependencies
```bash
# From your Backstage root directory
yarn --cwd packages/backend add @backstage/plugin-explore-backend
```
Add feature
```ts title="packages/backend/src/index.ts"
backend.add(import('@backstage/plugin-explore-backend'));
```
Config:
```yaml
explore:
tools:
- title: New Relic
description: new relic plugin
url: /newrelic
image: https://i.imgur.com/L37ikrX.jpg
tags:
- newrelic
- proxy
- nerdGraph
```
### Adding the plugin to your `packages/backend` (old)
#### Tools as Config
Install dependencies
```bash
# From your Backstage root directory
yarn --cwd packages/backend add @backstage/plugin-explore-backend
```
You'll need to add the plugin to the router in your `backend` package. You can
do this by creating a file called `packages/backend/src/plugins/explore.ts` with the following content:
```ts title="packages/backend/src/plugins/explore.ts"
import {
createRouter,
StaticExploreToolProvider,
} from '@backstage/plugin-explore-backend';
import { Router } from 'express';
import { PluginEnvironment } from '../types';
export default async function createPlugin(
env: PluginEnvironment,
): Promise<Router> {
return await createRouter({
logger: env.logger,
toolProvider: StaticExploreToolProvider.fromConfig(env.config),
});
}
```
Config:
```yaml
explore:
tools:
- title: New Relic
description: new relic plugin
url: /newrelic
image: https://i.imgur.com/L37ikrX.jpg
tags:
- newrelic
- proxy
- nerdGraph
```
#### Tools as Code
Install dependencies
```bash
# From your Backstage root directory
yarn --cwd packages/backend add @backstage/plugin-explore-backend @backstage/plugin-explore-common
```
You'll need to add the plugin to the router in your `backend` package. You can
do this by creating a file called `packages/backend/src/plugins/explore.ts` with the following content:
```ts
import {
createRouter,
StaticExploreToolProvider,
} from '@backstage/plugin-explore-backend';
import { ExploreTool } from '@backstage/plugin-explore-common';
import { Router } from 'express';
import { PluginEnvironment } from '../types';
// List of tools you want to surface in the Explore plugin "Tools" page.
const exploreTools: ExploreTool[] = [
{
title: 'New Relic',
description: 'new relic plugin',
url: '/newrelic',
image: 'https://i.imgur.com/L37ikrX.jpg',
tags: ['newrelic', 'proxy', 'nerdGraph'],
},
];
export default async function createPlugin(
env: PluginEnvironment,
): Promise<Router> {
return await createRouter({
logger: env.logger,
toolProvider: StaticExploreToolProvider.fromData(exploreTools),
});
}
```
#### Register the plugin router
With the `explore.ts` router setup in place, add the router to
`packages/backend/src/index.ts`:
```diff
+import explore from './plugins/explore';
async function main() {
...
const createEnv = makeCreateEnv(config);
const catalogEnv = useHotMemoize(module, () => createEnv('catalog'));
+ const exploreEnv = useHotMemoize(module, () => createEnv('explore'));
const apiRouter = Router();
+ apiRouter.use('/explore', await explore(exploreEnv));
...
apiRouter.use(notFoundHandler());
```
### Wire up Search Indexing
To index explore tools you will need to register the search collator in the
`packages/backend/src/plugins/search.ts` file.
```diff
+import { ToolDocumentCollatorFactory } from '@backstage/plugin-explore-backend';
...
+ // collator gathers entities from explore.
+ indexBuilder.addCollator({
+ schedule,
+ factory: ToolDocumentCollatorFactory.fromConfig(env.config, {
+ discovery: env.discovery,
+ logger: env.logger,
+ }),
+ });
...
```
### Wire up the Frontend
See [the explore plugin README](../explore/README.md) for more information.
## Explore Tool Customization
The `explore-backend` uses the `ExploreToolProvider` interface to provide a list
of tools used in your organization and/or within your Backstage instance. This
can be customized to provide tools from any source. For example you could create
a `CustomExploreToolProvider` that queries an internal for tools in your
`packages/backend/src/plugins/explore.ts` file.
```ts
import {
createRouter,
StaticExploreToolProvider,
} from '@backstage/plugin-explore-backend';
import { Router } from 'express';
import { PluginEnvironment } from '../types';
class CustomExploreToolProvider implements ExploreToolProvider {
async getTools(
request: GetExploreToolsRequest,
): Promise<GetExploreToolsResponse> {
const externalTools = await queryExternalTools(request);
const tools: ExploreTool[] = [
...externalTools,
// Backstage Tools
{
title: 'New Relic',
description: 'new relic plugin',
url: '/newrelic',
image: 'https://i.imgur.com/L37ikrX.jpg',
tags: ['newrelic', 'proxy', 'nerdGraph'],
},
];
return { tools };
}
}
export default async function createPlugin(
env: PluginEnvironment,
): Promise<Router> {
return await createRouter({
logger: env.logger,
toolProvider: new CustomExploreToolProvider(),
});
}
```
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-explore-backend` instead.
plugins/explore-backend/package.json
+4 -2
View File
@@ -2,7 +2,8 @@
"name": "@backstage/plugin-explore-backend",
"version": "0.0.27",
"backstage": {
"role": "backend-plugin"
"role": "backend-plugin",
"moved": "@backstage-community/plugin-explore-backend"
},
"publishConfig": {
"access": "public",
@@ -51,5 +52,6 @@
"@types/supertest": "^2.0.8",
"supertest": "^6.2.4"
},
"configSchema": "config.d.ts"
"configSchema": "config.d.ts",
"deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-explore-backend instead."
}