Deprecate packages

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-04-18 20:49:31 +02:00
parent 64164776a0
commit 7c756da97c
5 changed files with 18 additions and 73 deletions
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-periskop': patch
'@backstage/plugin-periskop-backend': patch
---
These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository.
+2 -4
View File
@@ -1,5 +1,3 @@
# periskop-backend
# Deprecated
Simple plugin that proxies requests to the Periskop server APIs.
To be used with the [Periskop plugin](../periskop/README.md).
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-periskop-backend` instead.
+4 -2
View File
@@ -2,7 +2,8 @@
"name": "@backstage/plugin-periskop-backend",
"version": "0.2.15",
"backstage": {
"role": "backend-plugin"
"role": "backend-plugin",
"moved": "@backstage-community/plugin-periskop-backend"
},
"publishConfig": {
"access": "public"
@@ -58,5 +59,6 @@
"@backstage/cli": "workspace:^",
"@types/supertest": "^2.0.8",
"supertest": "^6.1.6"
}
},
"deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-periskop-backend instead."
}
+2 -65
View File
@@ -1,66 +1,3 @@
# periskop
# Deprecated
[Periskop](https://periskop.io/) is a pull-based, language agnostic exception aggregator for microservice environments.
![periskop-logo](https://i.imgur.com/z8BLePO.png)
## Periskop aggregated errors
The Periskop Backstage Plugin exposes a component named `EntityPeriskopErrorsCard`.
Each of the entries in the table will direct you to the error details in your deployed Periskop instance location.
![periskop-errors-card](./docs/periskop-plugin-screenshot.png)
## Setup
1. Configure the [periskop backend plugin](https://github.com/backstage/backstage/tree/master/plugins/periskop-backend/)
2. Install the plugin by running:
```bash
# From your Backstage root directory
yarn --cwd packages/app add @backstage/plugin-periskop
```
3. Add to the app `EntityPage` component:
```tsx
// In packages/app/src/components/catalog/EntityPage.tsx
import { EntityPeriskopErrorsCard } from '@backstage/plugin-periskop';
const componentPage = (
<EntityLayout>
{/* other tabs... */}
<EntityLayout.Route path="/periskop" title="Periskop">
<Grid container spacing={3} alignItems="stretch">
<Grid item xs={12} sm={12} md={12}>
<EntityPeriskopErrorsCard />
</Grid>
</Grid>
</EntityLayout.Route>
```
4. [Setup the `app-config.yaml`](#instances) `periskop` block
5. Annotate entities with the periskop service name
```yaml
annotations:
periskop.io/service-name: '<THE NAME OF THE PERISKOP APP>'
```
6. Run app with `yarn start` and navigate to `/periskop` or a catalog entity 'Periskop' tab
### Instances
The periskop plugin can be configured to fetch aggregated errors from multiple deployment instances.
This is especially useful if you have a multi-zone deployment, or a federated setup and would like to drill deeper into a single instance of the federation. Each of the configured instances will be included in the plugin's UI via a dropdown on the errors table.
The plugin requires to configure _at least one_ Periskop API location in the [app-config.yaml](https://github.com/backstage/backstage/blob/master/app-config.yaml):
```yaml
periskop:
instances:
- name: <name of the instance>
url: <HTTP/S url for the Periskop instance's API>
```
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-periskop` instead.
+4 -2
View File
@@ -2,7 +2,8 @@
"name": "@backstage/plugin-periskop",
"version": "0.1.32",
"backstage": {
"role": "frontend-plugin"
"role": "frontend-plugin",
"moved": "@backstage-community/plugin-periskop"
},
"publishConfig": {
"access": "public",
@@ -55,5 +56,6 @@
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
},
"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-periskop instead."
}