From 7c756da97cff00d5d08bd6b7f795cc43129c8b66 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:49:31 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713466169253.md | 6 +++ plugins/periskop-backend/README.md | 6 +-- plugins/periskop-backend/package.json | 6 ++- plugins/periskop/README.md | 67 +-------------------------- plugins/periskop/package.json | 6 ++- 5 files changed, 18 insertions(+), 73 deletions(-) create mode 100644 .changeset/migrate-1713466169253.md diff --git a/.changeset/migrate-1713466169253.md b/.changeset/migrate-1713466169253.md new file mode 100644 index 0000000000..06de197773 --- /dev/null +++ b/.changeset/migrate-1713466169253.md @@ -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. diff --git a/plugins/periskop-backend/README.md b/plugins/periskop-backend/README.md index 02552fe5b4..8697d58fb3 100644 --- a/plugins/periskop-backend/README.md +++ b/plugins/periskop-backend/README.md @@ -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. diff --git a/plugins/periskop-backend/package.json b/plugins/periskop-backend/package.json index 2bc5c1773d..c49f2e324e 100644 --- a/plugins/periskop-backend/package.json +++ b/plugins/periskop-backend/package.json @@ -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." } diff --git a/plugins/periskop/README.md b/plugins/periskop/README.md index 85bced7c1b..f61eef8db7 100644 --- a/plugins/periskop/README.md +++ b/plugins/periskop/README.md @@ -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 = ( - - {/* other tabs... */} - - - - - - - -``` - -4. [Setup the `app-config.yaml`](#instances) `periskop` block - -5. Annotate entities with the periskop service name - -```yaml -annotations: - periskop.io/service-name: '' -``` - -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: - url: -``` +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. diff --git a/plugins/periskop/package.json b/plugins/periskop/package.json index 1ab1ad729c..a758f3bce9 100644 --- a/plugins/periskop/package.json +++ b/plugins/periskop/package.json @@ -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." }