From 0ea9dbf619173b1649d2d05cb374e3afe04302da Mon Sep 17 00:00:00 2001 From: Emerson Chalegre Date: Tue, 2 Apr 2024 13:02:10 -0300 Subject: [PATCH 1/2] (fix) Fixed Kubernetes Plugin Installarion Document Signed-off-by: Emerson Chalegre Signed-off-by: Emerson Chalegre --- .changeset/moody-maps-behave.md | 30 ++++++++++++++++++++++++ docs/features/kubernetes/installation.md | 1 + 2 files changed, 31 insertions(+) create mode 100644 .changeset/moody-maps-behave.md diff --git a/.changeset/moody-maps-behave.md b/.changeset/moody-maps-behave.md new file mode 100644 index 0000000000..d47625ce88 --- /dev/null +++ b/.changeset/moody-maps-behave.md @@ -0,0 +1,30 @@ +--- +'@backstage/plugin-kubernetes-backend': major +--- + +--- + +## '@backstage/kubernetes-backend': patch + +Fixed the Kubernetes Plugin Installation documentation. Added the following change to plugin creation packages/backend/src/plugins/kubernetes.ts + +```ts title="packages/backend/src/plugins/kubernetes.ts" +import { KubernetesBuilder } from '@backstage/plugin-kubernetes-backend'; +import { Router } from 'express'; +import { PluginEnvironment } from '../types'; +import { CatalogClient } from '@backstage/catalog-client'; + +export default async function createPlugin( + env: PluginEnvironment, +): Promise { + const catalogApi = new CatalogClient({ discoveryApi: env.discovery }); + const { router } = await KubernetesBuilder.createBuilder({ + logger: env.logger, + config: env.config, + catalogApi, ++ discovery: env.discovery, + permissions: env.permissions, + }).build(); + return router; +} +``` diff --git a/docs/features/kubernetes/installation.md b/docs/features/kubernetes/installation.md index bdd14098ff..12053c1ac0 100644 --- a/docs/features/kubernetes/installation.md +++ b/docs/features/kubernetes/installation.md @@ -75,6 +75,7 @@ export default async function createPlugin( logger: env.logger, config: env.config, catalogApi, + discovery: env.discovery, permissions: env.permissions, }).build(); return router; From 8b8ec633df64a058cecf2c7d53f28d000ac6f7f6 Mon Sep 17 00:00:00 2001 From: Emerson Chalegre Date: Wed, 3 Apr 2024 09:44:07 -0300 Subject: [PATCH 2/2] Remove moody_maps_behave.md because de package is not changed Signed-off-by: Emerson Chalegre Signed-off-by: Emerson Chalegre --- .changeset/moody-maps-behave.md | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 .changeset/moody-maps-behave.md diff --git a/.changeset/moody-maps-behave.md b/.changeset/moody-maps-behave.md deleted file mode 100644 index d47625ce88..0000000000 --- a/.changeset/moody-maps-behave.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -'@backstage/plugin-kubernetes-backend': major ---- - ---- - -## '@backstage/kubernetes-backend': patch - -Fixed the Kubernetes Plugin Installation documentation. Added the following change to plugin creation packages/backend/src/plugins/kubernetes.ts - -```ts title="packages/backend/src/plugins/kubernetes.ts" -import { KubernetesBuilder } from '@backstage/plugin-kubernetes-backend'; -import { Router } from 'express'; -import { PluginEnvironment } from '../types'; -import { CatalogClient } from '@backstage/catalog-client'; - -export default async function createPlugin( - env: PluginEnvironment, -): Promise { - const catalogApi = new CatalogClient({ discoveryApi: env.discovery }); - const { router } = await KubernetesBuilder.createBuilder({ - logger: env.logger, - config: env.config, - catalogApi, -+ discovery: env.discovery, - permissions: env.permissions, - }).build(); - return router; -} -```