@solo.io/platform-portal-backstage-plugin-backend 0.0.0 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +14 -1
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,8 +1,21 @@
1
1
  # @solo.io/platform-portal-backstage-plugin-backend
2
2
 
3
+ ## Description
4
+
5
+ This plugin will create the following Backstage catalog entities and relate them to each other:
6
+
7
+ - A `Group` with the name, `solo-io-service-accounts`.
8
+ - A `User` with the name, `gloo-platform-portal-service-account`.
9
+ - A `System` with the name, `gloo-platform-portal-apis`.
10
+ - An `API` for each `apiVersion` of each `apiProduct` in your Gloo Platform Portal instance that the service account has access to. The API's name is a combination of the `apiProductId` and the `apiVersion` (`apiProductId-apiVersion`).
11
+
3
12
  ## Installation
4
13
 
5
- 1. Install the plugin to your backend package.
14
+ 1. Install the plugin to your backstage instance:
15
+
16
+ ```shell
17
+ yarn add --cwd ./packages/backend @solo.io/platform-portal-backstage-plugin-backend
18
+ ```
6
19
 
7
20
  2. Update your backend plugin in `packages/backend/src/plugins/catalog.ts` with the following code. The parts that you will need to update should similar to what is described in the Backstage docs [here](https://backstage.io/docs/features/software-catalog/external-integrations/#installing-the-provider):
8
21
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@solo.io/platform-portal-backstage-plugin-backend",
3
- "version": "0.0.0",
3
+ "version": "0.0.2",
4
4
  "main": "dist/index.cjs.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "license": "Apache-2.0",
@@ -22,8 +22,8 @@
22
22
  "postpack": "backstage-cli package postpack"
23
23
  },
24
24
  "dependencies": {
25
- "@backstage/backend-common": "workspace:^",
26
- "@backstage/config": "workspace:^",
25
+ "@backstage/backend-common": "^0.18.2-next.0",
26
+ "@backstage/config": "^1.0.6",
27
27
  "@types/express": "*",
28
28
  "express": "^4.18.1",
29
29
  "express-promise-router": "^4.1.0",