From 8ad4b4c34c192d33eee984ceb81c7ec4fe59d972 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:49:46 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713466183571.md | 5 +++ plugins/puppetdb/README.md | 64 +---------------------------- plugins/puppetdb/package.json | 6 ++- 3 files changed, 11 insertions(+), 64 deletions(-) create mode 100644 .changeset/migrate-1713466183571.md diff --git a/.changeset/migrate-1713466183571.md b/.changeset/migrate-1713466183571.md new file mode 100644 index 0000000000..eab8ace070 --- /dev/null +++ b/.changeset/migrate-1713466183571.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-puppetdb': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/puppetdb/README.md b/plugins/puppetdb/README.md index c4fa06b874..2107d6ca6e 100644 --- a/plugins/puppetdb/README.md +++ b/plugins/puppetdb/README.md @@ -1,63 +1,3 @@ -# PuppetDB Plugin +# Deprecated -A frontend plugin to integrate PuppetDB with Backstage. When combined with the -[catalog-backend-module-puppetdb](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-puppetdb/README.md) plugin, this -frontend plugin allows viewing PuppetDB reports, including their logs and events, of Backstage resource entities. - -## Getting started - -### Prerequisites - -To get started, you need a running instance of PuppetDB. You can find instructions on how to install it -[here](https://www.puppet.com/docs/puppetdb/7/install_via_module.html). -The PuppetDB [should be configured](https://www.puppet.com/docs/puppetdb/7/configure.html#host) to allow being accessed from your Backstage instance. - -In addition, your Backstage instance need to either have -[catalog-backend-module-puppetdb](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-puppetdb/README.md) plugin installed -or you need to ensure your Resource entities have `puppet.com/certname` annotation set to the PuppetDB node name in some other way. - -### Installation - -1. Install the plugin with `yarn` in the root of your Backstage application directory: - -```bash -yarn --cwd packages/app add @backstage/plugin-puppetdb -``` - -1. Import and use the plugin in `packages/app/src/App.tsx`: - -```tsx -import { PuppetDbPage } from '@backstage/plugin-puppetdb'; - -const routes = ( - - {/* ...other routes */} - } /> - -); -``` - -### Configuration - -1. Configure `puppetdb` proxy. As this plugin uses the Backstage proxy to securely communicate with PuppetDB API, - add the following to your `app-config.yaml` to enable this configuration: - -```yaml -proxy: - '/puppetdb': - target: https://your.puppetdb.instance.com -``` - -## Screenshots - -#### Main page with the reports list: - -![Reports list](https://raw.githubusercontent.com/backstage/backstage/42b65232e763d3e39e2e641b105d2ad469db7a59/plugins/puppetdb/assets/Reports.png) - -#### Events for the specific report: - -![Events](https://raw.githubusercontent.com/backstage/backstage/1b39e86db17f139dc995f02daca4896533e53eb0/plugins/puppetdb/assets/Events.png) - -#### Logs of the specific report: - -![Logs](https://raw.githubusercontent.com/backstage/backstage/1b39e86db17f139dc995f02daca4896533e53eb0/plugins/puppetdb/assets/Logs.png) +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-puppetdb` instead. diff --git a/plugins/puppetdb/package.json b/plugins/puppetdb/package.json index 5d65129e09..1407dcb2a6 100644 --- a/plugins/puppetdb/package.json +++ b/plugins/puppetdb/package.json @@ -3,7 +3,8 @@ "version": "0.1.17", "description": "Backstage plugin to visualize resource information and Puppet facts from PuppetDB.", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-puppetdb" }, "publishConfig": { "access": "public", @@ -60,5 +61,6 @@ "react": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-router-dom": "6.0.0-beta.0 || ^6.3.0" - } + }, + "deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-puppetdb instead." }