@backstage/plugin-kubernetes-backend 0.18.6 → 0.18.7-next.1

package/dist/plugin.cjs.js

@@ -0,0 +1,155 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+var pluginKubernetesBackend = require('@backstage/plugin-kubernetes-backend');
+var pluginKubernetesNode = require('@backstage/plugin-kubernetes-node');
+
+class ObjectsProvider {
+  objectsProvider;
+  getObjectsProvider() {
+    return this.objectsProvider;
+  }
+  addObjectsProvider(provider) {
+    if (this.objectsProvider) {
+      throw new Error(
+        "Multiple Kubernetes objects provider is not supported at this time"
+      );
+    }
+    this.objectsProvider = provider;
+  }
+}
+class ClusterSuplier {
+  clusterSupplier;
+  getClusterSupplier() {
+    return this.clusterSupplier;
+  }
+  addClusterSupplier(clusterSupplier) {
+    if (this.clusterSupplier) {
+      throw new Error(
+        "Multiple Kubernetes Cluster Suppliers is not supported at this time"
+      );
+    }
+    this.clusterSupplier = clusterSupplier;
+  }
+}
+class Fetcher {
+  fetcher;
+  getFetcher() {
+    return this.fetcher;
+  }
+  addFetcher(fetcher) {
+    if (this.fetcher) {
+      throw new Error(
+        "Multiple Kubernetes Fetchers is not supported at this time"
+      );
+    }
+    this.fetcher = fetcher;
+  }
+}
+class ServiceLocator {
+  serviceLocator;
+  getServiceLocator() {
+    return this.serviceLocator;
+  }
+  addServiceLocator(serviceLocator) {
+    if (this.serviceLocator) {
+      throw new Error(
+        "Multiple Kubernetes Service Locators is not supported at this time"
+      );
+    }
+    this.serviceLocator = serviceLocator;
+  }
+}
+class AuthStrategy {
+  authStrategies;
+  constructor() {
+    this.authStrategies = new Array();
+  }
+  static addAuthStrategiesFromArray(authStrategies, builder) {
+    authStrategies.forEach((st) => builder.addAuthStrategy(st.key, st.strategy));
+  }
+  getAuthenticationStrategies() {
+    return this.authStrategies;
+  }
+  addAuthStrategy(key, authStrategy) {
+    this.authStrategies.push({ key, strategy: authStrategy });
+  }
+}
+const kubernetesPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "kubernetes",
+  register(env) {
+    const extPointObjectsProvider = new ObjectsProvider();
+    const extPointClusterSuplier = new ClusterSuplier();
+    const extPointAuthStrategy = new AuthStrategy();
+    const extPointFetcher = new Fetcher();
+    const extPointServiceLocator = new ServiceLocator();
+    env.registerExtensionPoint(
+      pluginKubernetesNode.kubernetesObjectsProviderExtensionPoint,
+      extPointObjectsProvider
+    );
+    env.registerExtensionPoint(
+      pluginKubernetesNode.kubernetesClusterSupplierExtensionPoint,
+      extPointClusterSuplier
+    );
+    env.registerExtensionPoint(
+      pluginKubernetesNode.kubernetesAuthStrategyExtensionPoint,
+      extPointAuthStrategy
+    );
+    env.registerExtensionPoint(
+      pluginKubernetesNode.kubernetesFetcherExtensionPoint,
+      extPointFetcher
+    );
+    env.registerExtensionPoint(
+      pluginKubernetesNode.kubernetesServiceLocatorExtensionPoint,
+      extPointServiceLocator
+    );
+    env.registerInit({
+      deps: {
+        http: backendPluginApi.coreServices.httpRouter,
+        logger: backendPluginApi.coreServices.logger,
+        config: backendPluginApi.coreServices.rootConfig,
+        discovery: backendPluginApi.coreServices.discovery,
+        catalogApi: alpha.catalogServiceRef,
+        permissions: backendPluginApi.coreServices.permissions,
+        auth: backendPluginApi.coreServices.auth,
+        httpAuth: backendPluginApi.coreServices.httpAuth
+      },
+      async init({
+        http,
+        logger,
+        config,
+        discovery,
+        catalogApi,
+        permissions,
+        auth,
+        httpAuth
+      }) {
+        if (config.has("kubernetes")) {
+          const builder = pluginKubernetesBackend.KubernetesBuilder.createBuilder({
+            logger,
+            config,
+            catalogApi,
+            permissions,
+            discovery,
+            auth,
+            httpAuth
+          }).setObjectsProvider(extPointObjectsProvider.getObjectsProvider()).setClusterSupplier(extPointClusterSuplier.getClusterSupplier()).setFetcher(extPointFetcher.getFetcher()).setServiceLocator(extPointServiceLocator.getServiceLocator());
+          AuthStrategy.addAuthStrategiesFromArray(
+            extPointAuthStrategy.getAuthenticationStrategies(),
+            builder
+          );
+          const { router } = await builder.build();
+          http.use(router);
+        } else {
+          logger.warn(
+            "Failed to initialize kubernetes backend: valid kubernetes config is missing"
+          );
+        }
+      }
+    });
+  }
+});
+
+exports.kubernetesPlugin = kubernetesPlugin;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\n\nimport { KubernetesBuilder } from '@backstage/plugin-kubernetes-backend';\n\nimport {\n  type AuthenticationStrategy,\n  kubernetesAuthStrategyExtensionPoint,\n  type KubernetesAuthStrategyExtensionPoint,\n  type KubernetesClustersSupplier,\n  kubernetesClusterSupplierExtensionPoint,\n  type KubernetesClusterSupplierExtensionPoint,\n  type KubernetesFetcher,\n  kubernetesFetcherExtensionPoint,\n  type KubernetesFetcherExtensionPoint,\n  type KubernetesObjectsProvider,\n  kubernetesObjectsProviderExtensionPoint,\n  type KubernetesObjectsProviderExtensionPoint,\n  type KubernetesServiceLocator,\n  kubernetesServiceLocatorExtensionPoint,\n  type KubernetesServiceLocatorExtensionPoint,\n} from '@backstage/plugin-kubernetes-node';\n\nclass ObjectsProvider implements KubernetesObjectsProviderExtensionPoint {\n  private objectsProvider: KubernetesObjectsProvider | undefined;\n\n  getObjectsProvider() {\n    return this.objectsProvider;\n  }\n\n  addObjectsProvider(provider: KubernetesObjectsProvider) {\n    if (this.objectsProvider) {\n      throw new Error(\n        'Multiple Kubernetes objects provider is not supported at this time',\n      );\n    }\n    this.objectsProvider = provider;\n  }\n}\n\nclass ClusterSuplier implements KubernetesClusterSupplierExtensionPoint {\n  private clusterSupplier: KubernetesClustersSupplier | undefined;\n\n  getClusterSupplier() {\n    return this.clusterSupplier;\n  }\n\n  addClusterSupplier(clusterSupplier: KubernetesClustersSupplier) {\n    if (this.clusterSupplier) {\n      throw new Error(\n        'Multiple Kubernetes Cluster Suppliers is not supported at this time',\n      );\n    }\n    this.clusterSupplier = clusterSupplier;\n  }\n}\n\nclass Fetcher implements KubernetesFetcherExtensionPoint {\n  private fetcher: KubernetesFetcher | undefined;\n\n  getFetcher() {\n    return this.fetcher;\n  }\n\n  addFetcher(fetcher: KubernetesFetcher) {\n    if (this.fetcher) {\n      throw new Error(\n        'Multiple Kubernetes Fetchers is not supported at this time',\n      );\n    }\n    this.fetcher = fetcher;\n  }\n}\n\nclass ServiceLocator implements KubernetesServiceLocatorExtensionPoint {\n  private serviceLocator: KubernetesServiceLocator | undefined;\n\n  getServiceLocator() {\n    return this.serviceLocator;\n  }\n\n  addServiceLocator(serviceLocator: KubernetesServiceLocator) {\n    if (this.serviceLocator) {\n      throw new Error(\n        'Multiple Kubernetes Service Locators is not supported at this time',\n      );\n    }\n    this.serviceLocator = serviceLocator;\n  }\n}\n\nclass AuthStrategy implements KubernetesAuthStrategyExtensionPoint {\n  private authStrategies: Array<{\n    key: string;\n    strategy: AuthenticationStrategy;\n  }>;\n\n  constructor() {\n    this.authStrategies = new Array<{\n      key: string;\n      strategy: AuthenticationStrategy;\n    }>();\n  }\n\n  static addAuthStrategiesFromArray(\n    authStrategies: Array<{ key: string; strategy: AuthenticationStrategy }>,\n    builder: KubernetesBuilder,\n  ) {\n    authStrategies.forEach(st => builder.addAuthStrategy(st.key, st.strategy));\n  }\n\n  getAuthenticationStrategies() {\n    return this.authStrategies;\n  }\n\n  addAuthStrategy(key: string, authStrategy: AuthenticationStrategy) {\n    this.authStrategies.push({ key, strategy: authStrategy });\n  }\n}\n\n/**\n * This is the backend plugin that provides the Kubernetes integration.\n * @alpha\n */\n\nexport const kubernetesPlugin = createBackendPlugin({\n  pluginId: 'kubernetes',\n  register(env) {\n    const extPointObjectsProvider = new ObjectsProvider();\n    const extPointClusterSuplier = new ClusterSuplier();\n    const extPointAuthStrategy = new AuthStrategy();\n    const extPointFetcher = new Fetcher();\n    const extPointServiceLocator = new ServiceLocator();\n\n    env.registerExtensionPoint(\n      kubernetesObjectsProviderExtensionPoint,\n      extPointObjectsProvider,\n    );\n    env.registerExtensionPoint(\n      kubernetesClusterSupplierExtensionPoint,\n      extPointClusterSuplier,\n    );\n    env.registerExtensionPoint(\n      kubernetesAuthStrategyExtensionPoint,\n      extPointAuthStrategy,\n    );\n    env.registerExtensionPoint(\n      kubernetesFetcherExtensionPoint,\n      extPointFetcher,\n    );\n    env.registerExtensionPoint(\n      kubernetesServiceLocatorExtensionPoint,\n      extPointServiceLocator,\n    );\n\n    env.registerInit({\n      deps: {\n        http: coreServices.httpRouter,\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n        catalogApi: catalogServiceRef,\n        permissions: coreServices.permissions,\n        auth: coreServices.auth,\n        httpAuth: coreServices.httpAuth,\n      },\n      async init({\n        http,\n        logger,\n        config,\n        discovery,\n        catalogApi,\n        permissions,\n        auth,\n        httpAuth,\n      }) {\n        if (config.has('kubernetes')) {\n          // TODO: expose all of the customization & extension points of the builder here\n          const builder: KubernetesBuilder = KubernetesBuilder.createBuilder({\n            logger,\n            config,\n            catalogApi,\n            permissions,\n            discovery,\n            auth,\n            httpAuth,\n          })\n            .setObjectsProvider(extPointObjectsProvider.getObjectsProvider())\n            .setClusterSupplier(extPointClusterSuplier.getClusterSupplier())\n            .setFetcher(extPointFetcher.getFetcher())\n            .setServiceLocator(extPointServiceLocator.getServiceLocator());\n\n          AuthStrategy.addAuthStrategiesFromArray(\n            extPointAuthStrategy.getAuthenticationStrategies(),\n            builder,\n          );\n          const { router } = await builder.build();\n          http.use(router);\n        } else {\n          logger.warn(\n            'Failed to initialize kubernetes backend: valid kubernetes config is missing',\n          );\n        }\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","kubernetesObjectsProviderExtensionPoint","kubernetesClusterSupplierExtensionPoint","kubernetesAuthStrategyExtensionPoint","kubernetesFetcherExtensionPoint","kubernetesServiceLocatorExtensionPoint","coreServices","catalogServiceRef","KubernetesBuilder"],"mappings":";;;;;;;AA0CA,MAAM,eAAmE,CAAA;AAAA,EAC/D,eAAA,CAAA;AAAA,EAER,kBAAqB,GAAA;AACnB,IAAA,OAAO,IAAK,CAAA,eAAA,CAAA;AAAA,GACd;AAAA,EAEA,mBAAmB,QAAqC,EAAA;AACtD,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,oEAAA;AAAA,OACF,CAAA;AAAA,KACF;AACA,IAAA,IAAA,CAAK,eAAkB,GAAA,QAAA,CAAA;AAAA,GACzB;AACF,CAAA;AAEA,MAAM,cAAkE,CAAA;AAAA,EAC9D,eAAA,CAAA;AAAA,EAER,kBAAqB,GAAA;AACnB,IAAA,OAAO,IAAK,CAAA,eAAA,CAAA;AAAA,GACd;AAAA,EAEA,mBAAmB,eAA6C,EAAA;AAC9D,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,qEAAA;AAAA,OACF,CAAA;AAAA,KACF;AACA,IAAA,IAAA,CAAK,eAAkB,GAAA,eAAA,CAAA;AAAA,GACzB;AACF,CAAA;AAEA,MAAM,OAAmD,CAAA;AAAA,EAC/C,OAAA,CAAA;AAAA,EAER,UAAa,GAAA;AACX,IAAA,OAAO,IAAK,CAAA,OAAA,CAAA;AAAA,GACd;AAAA,EAEA,WAAW,OAA4B,EAAA;AACrC,IAAA,IAAI,KAAK,OAAS,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,4DAAA;AAAA,OACF,CAAA;AAAA,KACF;AACA,IAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;AAAA,GACjB;AACF,CAAA;AAEA,MAAM,cAAiE,CAAA;AAAA,EAC7D,cAAA,CAAA;AAAA,EAER,iBAAoB,GAAA;AAClB,IAAA,OAAO,IAAK,CAAA,cAAA,CAAA;AAAA,GACd;AAAA,EAEA,kBAAkB,cAA0C,EAAA;AAC1D,IAAA,IAAI,KAAK,cAAgB,EAAA;AACvB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,oEAAA;AAAA,OACF,CAAA;AAAA,KACF;AACA,IAAA,IAAA,CAAK,cAAiB,GAAA,cAAA,CAAA;AAAA,GACxB;AACF,CAAA;AAEA,MAAM,YAA6D,CAAA;AAAA,EACzD,cAAA,CAAA;AAAA,EAKR,WAAc,GAAA;AACZ,IAAK,IAAA,CAAA,cAAA,GAAiB,IAAI,KAGvB,EAAA,CAAA;AAAA,GACL;AAAA,EAEA,OAAO,0BACL,CAAA,cAAA,EACA,OACA,EAAA;AACA,IAAe,cAAA,CAAA,OAAA,CAAQ,QAAM,OAAQ,CAAA,eAAA,CAAgB,GAAG,GAAK,EAAA,EAAA,CAAG,QAAQ,CAAC,CAAA,CAAA;AAAA,GAC3E;AAAA,EAEA,2BAA8B,GAAA;AAC5B,IAAA,OAAO,IAAK,CAAA,cAAA,CAAA;AAAA,GACd;AAAA,EAEA,eAAA,CAAgB,KAAa,YAAsC,EAAA;AACjE,IAAA,IAAA,CAAK,eAAe,IAAK,CAAA,EAAE,GAAK,EAAA,QAAA,EAAU,cAAc,CAAA,CAAA;AAAA,GAC1D;AACF,CAAA;AAOO,MAAM,mBAAmBA,oCAAoB,CAAA;AAAA,EAClD,QAAU,EAAA,YAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,uBAAA,GAA0B,IAAI,eAAgB,EAAA,CAAA;AACpD,IAAM,MAAA,sBAAA,GAAyB,IAAI,cAAe,EAAA,CAAA;AAClD,IAAM,MAAA,oBAAA,GAAuB,IAAI,YAAa,EAAA,CAAA;AAC9C,IAAM,MAAA,eAAA,GAAkB,IAAI,OAAQ,EAAA,CAAA;AACpC,IAAM,MAAA,sBAAA,GAAyB,IAAI,cAAe,EAAA,CAAA;AAElD,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,4DAAA;AAAA,MACA,uBAAA;AAAA,KACF,CAAA;AACA,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,4DAAA;AAAA,MACA,sBAAA;AAAA,KACF,CAAA;AACA,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,yDAAA;AAAA,MACA,oBAAA;AAAA,KACF,CAAA;AACA,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,oDAAA;AAAA,MACA,eAAA;AAAA,KACF,CAAA;AACA,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,2DAAA;AAAA,MACA,sBAAA;AAAA,KACF,CAAA;AAEA,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAMC,6BAAa,CAAA,UAAA;AAAA,QACnB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,UAAY,EAAAC,uBAAA;AAAA,QACZ,aAAaD,6BAAa,CAAA,WAAA;AAAA,QAC1B,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,UAAUA,6BAAa,CAAA,QAAA;AAAA,OACzB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,IAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,UAAA;AAAA,QACA,WAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAA;AAAA,OACC,EAAA;AACD,QAAI,IAAA,MAAA,CAAO,GAAI,CAAA,YAAY,CAAG,EAAA;AAE5B,UAAM,MAAA,OAAA,GAA6BE,0CAAkB,aAAc,CAAA;AAAA,YACjE,MAAA;AAAA,YACA,MAAA;AAAA,YACA,UAAA;AAAA,YACA,WAAA;AAAA,YACA,SAAA;AAAA,YACA,IAAA;AAAA,YACA,QAAA;AAAA,WACD,EACE,kBAAmB,CAAA,uBAAA,CAAwB,oBAAoB,CAAA,CAC/D,mBAAmB,sBAAuB,CAAA,kBAAA,EAAoB,CAC9D,CAAA,UAAA,CAAW,gBAAgB,UAAW,EAAC,EACvC,iBAAkB,CAAA,sBAAA,CAAuB,mBAAmB,CAAA,CAAA;AAE/D,UAAa,YAAA,CAAA,0BAAA;AAAA,YACX,qBAAqB,2BAA4B,EAAA;AAAA,YACjD,OAAA;AAAA,WACF,CAAA;AACA,UAAA,MAAM,EAAE,MAAA,EAAW,GAAA,MAAM,QAAQ,KAAM,EAAA,CAAA;AACvC,UAAA,IAAA,CAAK,IAAI,MAAM,CAAA,CAAA;AAAA,SACV,MAAA;AACL,UAAO,MAAA,CAAA,IAAA;AAAA,YACL,6EAAA;AAAA,WACF,CAAA;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/routes/resourcesRoutes.cjs.js

@@ -0,0 +1,65 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+var errors = require('@backstage/errors');
+
+const addResourceRoutesToRouter = (router, catalogApi, objectsProvider, auth, httpAuth) => {
+  const getEntityByReq = async (req) => {
+    const rawEntityRef = req.body.entityRef;
+    if (rawEntityRef && typeof rawEntityRef !== "string") {
+      throw new errors.InputError(`entity query must be a string`);
+    } else if (!rawEntityRef) {
+      throw new errors.InputError("entity is a required field");
+    }
+    let entityRef = void 0;
+    try {
+      entityRef = catalogModel.parseEntityRef(rawEntityRef);
+    } catch (error) {
+      throw new errors.InputError(`Invalid entity ref, ${error}`);
+    }
+    const { token } = await auth.getPluginRequestToken({
+      onBehalfOf: await httpAuth.credentials(req),
+      targetPluginId: "catalog"
+    });
+    const entity = await catalogApi.getEntityByRef(entityRef, { token });
+    if (!entity) {
+      throw new errors.InputError(
+        `Entity ref missing, ${catalogModel.stringifyEntityRef(entityRef)}`
+      );
+    }
+    return entity;
+  };
+  router.post("/resources/workloads/query", async (req, res) => {
+    const entity = await getEntityByReq(req);
+    const response = await objectsProvider.getKubernetesObjectsByEntity(
+      {
+        entity,
+        auth: req.body.auth
+      },
+      { credentials: await httpAuth.credentials(req) }
+    );
+    res.json(response);
+  });
+  router.post("/resources/custom/query", async (req, res) => {
+    const entity = await getEntityByReq(req);
+    if (!req.body.customResources) {
+      throw new errors.InputError("customResources is a required field");
+    } else if (!Array.isArray(req.body.customResources)) {
+      throw new errors.InputError("customResources must be an array");
+    } else if (req.body.customResources.length === 0) {
+      throw new errors.InputError("at least 1 customResource is required");
+    }
+    const response = await objectsProvider.getCustomResourcesByEntity(
+      {
+        entity,
+        customResources: req.body.customResources,
+        auth: req.body.auth
+      },
+      { credentials: await httpAuth.credentials(req) }
+    );
+    res.json(response);
+  });
+};
+
+exports.addResourceRoutesToRouter = addResourceRoutesToRouter;
+//# sourceMappingURL=resourcesRoutes.cjs.js.map

package/dist/routes/resourcesRoutes.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourcesRoutes.cjs.js","sources":["../../src/routes/resourcesRoutes.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  CompoundEntityRef,\n  parseEntityRef,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { CatalogApi } from '@backstage/catalog-client';\nimport { InputError } from '@backstage/errors';\nimport express, { Request } from 'express';\nimport { KubernetesObjectsProvider } from '@backstage/plugin-kubernetes-node';\nimport { AuthService, HttpAuthService } from '@backstage/backend-plugin-api';\n\nexport const addResourceRoutesToRouter = (\n  router: express.Router,\n  catalogApi: CatalogApi,\n  objectsProvider: KubernetesObjectsProvider,\n  auth: AuthService,\n  httpAuth: HttpAuthService,\n) => {\n  const getEntityByReq = async (req: Request<any>) => {\n    const rawEntityRef = req.body.entityRef;\n    if (rawEntityRef && typeof rawEntityRef !== 'string') {\n      throw new InputError(`entity query must be a string`);\n    } else if (!rawEntityRef) {\n      throw new InputError('entity is a required field');\n    }\n    let entityRef: CompoundEntityRef | undefined = undefined;\n\n    try {\n      entityRef = parseEntityRef(rawEntityRef);\n    } catch (error) {\n      throw new InputError(`Invalid entity ref, ${error}`);\n    }\n\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await httpAuth.credentials(req),\n      targetPluginId: 'catalog',\n    });\n\n    const entity = await catalogApi.getEntityByRef(entityRef, { token });\n    if (!entity) {\n      throw new InputError(\n        `Entity ref missing, ${stringifyEntityRef(entityRef)}`,\n      );\n    }\n\n    return entity;\n  };\n\n  router.post('/resources/workloads/query', async (req, res) => {\n    const entity = await getEntityByReq(req);\n    const response = await objectsProvider.getKubernetesObjectsByEntity(\n      {\n        entity,\n        auth: req.body.auth,\n      },\n      { credentials: await httpAuth.credentials(req) },\n    );\n    res.json(response);\n  });\n\n  router.post('/resources/custom/query', async (req, res) => {\n    const entity = await getEntityByReq(req);\n\n    if (!req.body.customResources) {\n      throw new InputError('customResources is a required field');\n    } else if (!Array.isArray(req.body.customResources)) {\n      throw new InputError('customResources must be an array');\n    } else if (req.body.customResources.length === 0) {\n      throw new InputError('at least 1 customResource is required');\n    }\n\n    const response = await objectsProvider.getCustomResourcesByEntity(\n      {\n        entity,\n        customResources: req.body.customResources,\n        auth: req.body.auth,\n      },\n      { credentials: await httpAuth.credentials(req) },\n    );\n    res.json(response);\n  });\n};\n"],"names":["InputError","parseEntityRef","stringifyEntityRef"],"mappings":";;;;;AA0BO,MAAM,4BAA4B,CACvC,MAAA,EACA,UACA,EAAA,eAAA,EACA,MACA,QACG,KAAA;AACH,EAAM,MAAA,cAAA,GAAiB,OAAO,GAAsB,KAAA;AAClD,IAAM,MAAA,YAAA,GAAe,IAAI,IAAK,CAAA,SAAA,CAAA;AAC9B,IAAI,IAAA,YAAA,IAAgB,OAAO,YAAA,KAAiB,QAAU,EAAA;AACpD,MAAM,MAAA,IAAIA,kBAAW,CAA+B,6BAAA,CAAA,CAAA,CAAA;AAAA,KACtD,MAAA,IAAW,CAAC,YAAc,EAAA;AACxB,MAAM,MAAA,IAAIA,kBAAW,4BAA4B,CAAA,CAAA;AAAA,KACnD;AACA,IAAA,IAAI,SAA2C,GAAA,KAAA,CAAA,CAAA;AAE/C,IAAI,IAAA;AACF,MAAA,SAAA,GAAYC,4BAAe,YAAY,CAAA,CAAA;AAAA,aAChC,KAAO,EAAA;AACd,MAAA,MAAM,IAAID,iBAAA,CAAW,CAAuB,oBAAA,EAAA,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,KACrD;AAEA,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAY,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAA;AAAA,MAC1C,cAAgB,EAAA,SAAA;AAAA,KACjB,CAAA,CAAA;AAED,IAAA,MAAM,SAAS,MAAM,UAAA,CAAW,eAAe,SAAW,EAAA,EAAE,OAAO,CAAA,CAAA;AACnE,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAA,MAAM,IAAIA,iBAAA;AAAA,QACR,CAAA,oBAAA,EAAuBE,+BAAmB,CAAA,SAAS,CAAC,CAAA,CAAA;AAAA,OACtD,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT,CAAA;AAEA,EAAA,MAAA,CAAO,IAAK,CAAA,4BAAA,EAA8B,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC5D,IAAM,MAAA,MAAA,GAAS,MAAM,cAAA,CAAe,GAAG,CAAA,CAAA;AACvC,IAAM,MAAA,QAAA,GAAW,MAAM,eAAgB,CAAA,4BAAA;AAAA,MACrC;AAAA,QACE,MAAA;AAAA,QACA,IAAA,EAAM,IAAI,IAAK,CAAA,IAAA;AAAA,OACjB;AAAA,MACA,EAAE,WAAa,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAE,EAAA;AAAA,KACjD,CAAA;AACA,IAAA,GAAA,CAAI,KAAK,QAAQ,CAAA,CAAA;AAAA,GAClB,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,IAAK,CAAA,yBAAA,EAA2B,OAAO,GAAA,EAAK,GAAQ,KAAA;AACzD,IAAM,MAAA,MAAA,GAAS,MAAM,cAAA,CAAe,GAAG,CAAA,CAAA;AAEvC,IAAI,IAAA,CAAC,GAAI,CAAA,IAAA,CAAK,eAAiB,EAAA;AAC7B,MAAM,MAAA,IAAIF,kBAAW,qCAAqC,CAAA,CAAA;AAAA,eACjD,CAAC,KAAA,CAAM,QAAQ,GAAI,CAAA,IAAA,CAAK,eAAe,CAAG,EAAA;AACnD,MAAM,MAAA,IAAIA,kBAAW,kCAAkC,CAAA,CAAA;AAAA,KAC9C,MAAA,IAAA,GAAA,CAAI,IAAK,CAAA,eAAA,CAAgB,WAAW,CAAG,EAAA;AAChD,MAAM,MAAA,IAAIA,kBAAW,uCAAuC,CAAA,CAAA;AAAA,KAC9D;AAEA,IAAM,MAAA,QAAA,GAAW,MAAM,eAAgB,CAAA,0BAAA;AAAA,MACrC;AAAA,QACE,MAAA;AAAA,QACA,eAAA,EAAiB,IAAI,IAAK,CAAA,eAAA;AAAA,QAC1B,IAAA,EAAM,IAAI,IAAK,CAAA,IAAA;AAAA,OACjB;AAAA,MACA,EAAE,WAAa,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAE,EAAA;AAAA,KACjD,CAAA;AACA,IAAA,GAAA,CAAI,KAAK,QAAQ,CAAA,CAAA;AAAA,GAClB,CAAA,CAAA;AACH;;;;"}

package/dist/service/KubernetesBuilder.cjs.js

@@ -0,0 +1,367 @@
+'use strict';
+
+var pluginKubernetesCommon = require('@backstage/plugin-kubernetes-common');
+var pluginPermissionNode = require('@backstage/plugin-permission-node');
+var express = require('express');
+var Router = require('express-promise-router');
+var luxon = require('luxon');
+var AksStrategy = require('../auth/AksStrategy.cjs.js');
+var AnonymousStrategy = require('../auth/AnonymousStrategy.cjs.js');
+var AwsIamStrategy = require('../auth/AwsIamStrategy.cjs.js');
+var AzureIdentityStrategy = require('../auth/AzureIdentityStrategy.cjs.js');
+var GoogleStrategy = require('../auth/GoogleStrategy.cjs.js');
+var GoogleServiceAccountStrategy = require('../auth/GoogleServiceAccountStrategy.cjs.js');
+var DispatchStrategy = require('../auth/DispatchStrategy.cjs.js');
+var ServiceAccountStrategy = require('../auth/ServiceAccountStrategy.cjs.js');
+var OidcStrategy = require('../auth/OidcStrategy.cjs.js');
+var index = require('../cluster-locator/index.cjs.js');
+var backendCommon = require('@backstage/backend-common');
+var resourcesRoutes = require('../routes/resourcesRoutes.cjs.js');
+var CatalogRelationServiceLocator = require('../service-locator/CatalogRelationServiceLocator.cjs.js');
+var MultiTenantServiceLocator = require('../service-locator/MultiTenantServiceLocator.cjs.js');
+var SingleTenantServiceLocator = require('../service-locator/SingleTenantServiceLocator.cjs.js');
+var KubernetesFanOutHandler = require('./KubernetesFanOutHandler.cjs.js');
+var KubernetesFetcher = require('./KubernetesFetcher.cjs.js');
+var KubernetesProxy = require('./KubernetesProxy.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
+
+class KubernetesBuilder {
+  constructor(env) {
+    this.env = env;
+  }
+  clusterSupplier;
+  defaultClusterRefreshInterval = luxon.Duration.fromObject({
+    minutes: 60
+  });
+  objectsProvider;
+  fetcher;
+  serviceLocator;
+  proxy;
+  authStrategyMap;
+  static createBuilder(env) {
+    return new KubernetesBuilder(env);
+  }
+  async build() {
+    const logger = this.env.logger;
+    const config = this.env.config;
+    const permissions = this.env.permissions;
+    logger.info("Initializing Kubernetes backend");
+    if (!config.has("kubernetes")) {
+      if (process.env.NODE_ENV !== "development") {
+        throw new Error("Kubernetes configuration is missing");
+      }
+      logger.warn(
+        "Failed to initialize kubernetes backend: kubernetes config is missing"
+      );
+      return {
+        router: Router__default.default()
+      };
+    }
+    const { auth, httpAuth } = backendCommon.createLegacyAuthAdapters({
+      auth: this.env.auth,
+      httpAuth: this.env.httpAuth,
+      discovery: this.env.discovery
+    });
+    const customResources = this.buildCustomResources();
+    const fetcher = this.getFetcher();
+    const clusterSupplier = this.getClusterSupplier();
+    const authStrategyMap = this.getAuthStrategyMap();
+    const proxy = this.getProxy(
+      logger,
+      clusterSupplier,
+      this.env.discovery,
+      httpAuth
+    );
+    const serviceLocator = this.getServiceLocator();
+    const objectsProvider = this.getObjectsProvider({
+      logger,
+      fetcher,
+      config,
+      serviceLocator,
+      customResources,
+      objectTypesToFetch: this.getObjectTypesToFetch()
+    });
+    const router = this.buildRouter(
+      objectsProvider,
+      clusterSupplier,
+      this.env.catalogApi,
+      proxy,
+      permissions,
+      auth,
+      httpAuth
+    );
+    return {
+      clusterSupplier,
+      customResources,
+      fetcher,
+      proxy,
+      objectsProvider,
+      router,
+      serviceLocator,
+      authStrategyMap
+    };
+  }
+  setClusterSupplier(clusterSupplier) {
+    this.clusterSupplier = clusterSupplier;
+    return this;
+  }
+  setDefaultClusterRefreshInterval(refreshInterval) {
+    this.defaultClusterRefreshInterval = refreshInterval;
+    return this;
+  }
+  setObjectsProvider(objectsProvider) {
+    this.objectsProvider = objectsProvider;
+    return this;
+  }
+  setFetcher(fetcher) {
+    this.fetcher = fetcher;
+    return this;
+  }
+  setServiceLocator(serviceLocator) {
+    this.serviceLocator = serviceLocator;
+    return this;
+  }
+  setProxy(proxy) {
+    this.proxy = proxy;
+    return this;
+  }
+  setAuthStrategyMap(authStrategyMap) {
+    this.authStrategyMap = authStrategyMap;
+  }
+  addAuthStrategy(key, strategy) {
+    if (key.includes("-")) {
+      throw new Error("Strategy name can not include dashes");
+    }
+    this.getAuthStrategyMap()[key] = strategy;
+    return this;
+  }
+  buildCustomResources() {
+    const customResources = (this.env.config.getOptionalConfigArray("kubernetes.customResources") ?? []).map(
+      (c) => ({
+        group: c.getString("group"),
+        apiVersion: c.getString("apiVersion"),
+        plural: c.getString("plural"),
+        objectType: "customresources"
+      })
+    );
+    this.env.logger.info(
+      `action=LoadingCustomResources numOfCustomResources=${customResources.length}`
+    );
+    return customResources;
+  }
+  buildClusterSupplier(refreshInterval) {
+    const config = this.env.config;
+    const { auth } = backendCommon.createLegacyAuthAdapters(this.env);
+    this.clusterSupplier = index.getCombinedClusterSupplier(
+      config,
+      this.env.catalogApi,
+      new DispatchStrategy.DispatchStrategy({ authStrategyMap: this.getAuthStrategyMap() }),
+      this.env.logger,
+      refreshInterval,
+      auth
+    );
+    return this.clusterSupplier;
+  }
+  buildObjectsProvider(options) {
+    const authStrategyMap = this.getAuthStrategyMap();
+    this.objectsProvider = new KubernetesFanOutHandler.KubernetesFanOutHandler({
+      ...options,
+      authStrategy: new DispatchStrategy.DispatchStrategy({
+        authStrategyMap
+      })
+    });
+    return this.objectsProvider;
+  }
+  buildFetcher() {
+    this.fetcher = new KubernetesFetcher.KubernetesClientBasedFetcher({
+      logger: this.env.logger
+    });
+    return this.fetcher;
+  }
+  buildServiceLocator(method, clusterSupplier) {
+    switch (method) {
+      case "multiTenant":
+        this.serviceLocator = this.buildMultiTenantServiceLocator(clusterSupplier);
+        break;
+      case "singleTenant":
+        this.serviceLocator = this.buildSingleTenantServiceLocator(clusterSupplier);
+        break;
+      case "catalogRelation":
+        this.serviceLocator = this.buildCatalogRelationServiceLocator(clusterSupplier);
+        break;
+      case "http":
+        this.serviceLocator = this.buildHttpServiceLocator(clusterSupplier);
+        break;
+      default:
+        throw new Error(
+          `Unsupported kubernetes.serviceLocatorMethod "${method}"`
+        );
+    }
+    return this.serviceLocator;
+  }
+  buildMultiTenantServiceLocator(clusterSupplier) {
+    return new MultiTenantServiceLocator.MultiTenantServiceLocator(clusterSupplier);
+  }
+  buildSingleTenantServiceLocator(clusterSupplier) {
+    return new SingleTenantServiceLocator.SingleTenantServiceLocator(clusterSupplier);
+  }
+  buildCatalogRelationServiceLocator(clusterSupplier) {
+    return new CatalogRelationServiceLocator.CatalogRelationServiceLocator(clusterSupplier);
+  }
+  buildHttpServiceLocator(_clusterSupplier) {
+    throw new Error("not implemented");
+  }
+  buildProxy(logger, clusterSupplier, discovery, httpAuth) {
+    const authStrategyMap = this.getAuthStrategyMap();
+    const authStrategy = new DispatchStrategy.DispatchStrategy({
+      authStrategyMap
+    });
+    this.proxy = new KubernetesProxy.KubernetesProxy({
+      logger,
+      clusterSupplier,
+      authStrategy,
+      discovery,
+      httpAuth
+    });
+    return this.proxy;
+  }
+  buildRouter(objectsProvider, clusterSupplier, catalogApi, proxy, permissionApi, authService, httpAuth) {
+    const logger = this.env.logger;
+    const router = Router__default.default();
+    router.use("/proxy", proxy.createRequestHandler({ permissionApi }));
+    router.use(express__default.default.json());
+    router.use(
+      pluginPermissionNode.createPermissionIntegrationRouter({
+        permissions: pluginKubernetesCommon.kubernetesPermissions
+      })
+    );
+    router.post("/services/:serviceId", async (req, res) => {
+      const serviceId = req.params.serviceId;
+      const requestBody = req.body;
+      try {
+        const response = await objectsProvider.getKubernetesObjectsByEntity(
+          {
+            entity: requestBody.entity,
+            auth: requestBody.auth || {}
+          },
+          { credentials: await httpAuth.credentials(req) }
+        );
+        res.json(response);
+      } catch (e) {
+        logger.error(
+          `action=retrieveObjectsByServiceId service=${serviceId}, error=${e}`
+        );
+        res.status(500).json({ error: e.message });
+      }
+    });
+    router.get("/clusters", async (req, res) => {
+      const credentials = await httpAuth.credentials(req);
+      const clusterDetails = await this.fetchClusterDetails(clusterSupplier, {
+        credentials
+      });
+      res.json({
+        items: clusterDetails.map((cd) => {
+          const oidcTokenProvider = cd.authMetadata[pluginKubernetesCommon.ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER];
+          const authProvider = cd.authMetadata[pluginKubernetesCommon.ANNOTATION_KUBERNETES_AUTH_PROVIDER];
+          const strategy = this.getAuthStrategyMap()[authProvider];
+          let auth = {};
+          if (strategy) {
+            auth = strategy.presentAuthMetadata(cd.authMetadata);
+          }
+          return {
+            name: cd.name,
+            title: cd.title,
+            dashboardUrl: cd.dashboardUrl,
+            authProvider,
+            ...oidcTokenProvider && { oidcTokenProvider },
+            ...auth && Object.keys(auth).length !== 0 && { auth }
+          };
+        })
+      });
+    });
+    resourcesRoutes.addResourceRoutesToRouter(
+      router,
+      catalogApi,
+      objectsProvider,
+      authService,
+      httpAuth
+    );
+    return router;
+  }
+  buildAuthStrategyMap() {
+    this.authStrategyMap = {
+      aks: new AksStrategy.AksStrategy(),
+      aws: new AwsIamStrategy.AwsIamStrategy({ config: this.env.config }),
+      azure: new AzureIdentityStrategy.AzureIdentityStrategy(this.env.logger),
+      google: new GoogleStrategy.GoogleStrategy(),
+      googleServiceAccount: new GoogleServiceAccountStrategy.GoogleServiceAccountStrategy(),
+      localKubectlProxy: new AnonymousStrategy.AnonymousStrategy(),
+      oidc: new OidcStrategy.OidcStrategy(),
+      serviceAccount: new ServiceAccountStrategy.ServiceAccountStrategy()
+    };
+    return this.authStrategyMap;
+  }
+  async fetchClusterDetails(clusterSupplier, options) {
+    const clusterDetails = await clusterSupplier.getClusters(options);
+    this.env.logger.info(
+      `action=loadClusterDetails numOfClustersLoaded=${clusterDetails.length}`
+    );
+    return clusterDetails;
+  }
+  getServiceLocatorMethod() {
+    return this.env.config.getString(
+      "kubernetes.serviceLocatorMethod.type"
+    );
+  }
+  getFetcher() {
+    return this.fetcher ?? this.buildFetcher();
+  }
+  getClusterSupplier() {
+    return this.clusterSupplier ?? this.buildClusterSupplier(this.defaultClusterRefreshInterval);
+  }
+  getServiceLocator() {
+    return this.serviceLocator ?? this.buildServiceLocator(
+      this.getServiceLocatorMethod(),
+      this.getClusterSupplier()
+    );
+  }
+  getObjectsProvider(options) {
+    return this.objectsProvider ?? this.buildObjectsProvider(options);
+  }
+  getObjectTypesToFetch() {
+    const objectTypesToFetchStrings = this.env.config.getOptionalStringArray(
+      "kubernetes.objectTypes"
+    );
+    const apiVersionOverrides = this.env.config.getOptionalConfig(
+      "kubernetes.apiVersionOverrides"
+    );
+    let objectTypesToFetch;
+    if (objectTypesToFetchStrings) {
+      objectTypesToFetch = KubernetesFanOutHandler.DEFAULT_OBJECTS.filter(
+        (obj) => objectTypesToFetchStrings.includes(obj.objectType)
+      );
+    }
+    if (apiVersionOverrides) {
+      objectTypesToFetch = objectTypesToFetch ?? KubernetesFanOutHandler.DEFAULT_OBJECTS;
+      for (const obj of objectTypesToFetch) {
+        if (apiVersionOverrides.has(obj.objectType)) {
+          obj.apiVersion = apiVersionOverrides.getString(obj.objectType);
+        }
+      }
+    }
+    return objectTypesToFetch;
+  }
+  getProxy(logger, clusterSupplier, discovery, httpAuth) {
+    return this.proxy ?? this.buildProxy(logger, clusterSupplier, discovery, httpAuth);
+  }
+  getAuthStrategyMap() {
+    return this.authStrategyMap ?? this.buildAuthStrategyMap();
+  }
+}
+
+exports.KubernetesBuilder = KubernetesBuilder;
+//# sourceMappingURL=KubernetesBuilder.cjs.js.map