@backstage/plugin-kubernetes-backend 0.16.0-next.2 → 0.16.1

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/plugin-kubernetes-backend
 
+## 0.16.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.9.0
+  - @backstage/plugin-kubernetes-node@0.1.8
+
+## 0.16.0
+
+### Minor Changes
+
+- e1e540c: **BREAKING**: The `KubernetesBuilder.createBuilder` method now requires the `discovery` service to be forwarded from the plugin environment. This is part of the migration to support new auth services.
+
+### Patch Changes
+
+- b9a0888: Fixed a bug in the proxy endpoint. Now when the `serviceAccount` strategy is used and no `serviceAccountToken` has been provided, the proxy endpoint assumes backstage is running on Kubernetes and gets the URL and CA from the Pod instance.
+- 69d0217: Pass user credentials when calling catalog get entities api.
+- Updated dependencies
+  - @backstage/backend-common@0.21.4
+  - @backstage/plugin-auth-node@0.4.9
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/backend-plugin-api@0.6.14
+  - @backstage/plugin-permission-common@0.7.13
+  - @backstage/plugin-catalog-node@1.8.0
+  - @backstage/plugin-kubernetes-node@0.1.8
+  - @backstage/catalog-client@1.6.1
+  - @backstage/plugin-permission-node@0.7.25
+  - @backstage/plugin-kubernetes-common@0.7.5
+  - @backstage/catalog-model@1.4.5
+  - @backstage/integration-aws-node@0.1.10
+  - @backstage/types@1.1.1
+
 ## 0.16.0-next.2
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-kubernetes-backend",
-  "version": "0.16.0-next.2",
+  "version": "0.16.1",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -163,5 +163,5 @@ const kubernetesPlugin = backendPluginApi.createBackendPlugin({
   }
 });
 
-exports["default"] = kubernetesPlugin;
+exports.default = kubernetesPlugin;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/index.cjs.js

@@ -1,7 +1,5 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var credentialProviders = require('@aws-sdk/credential-providers');
 var signatureV4 = require('@aws-sdk/signature-v4');
 var sha256Js = require('@aws-crypto/sha256-js');
@@ -18,6 +16,7 @@ var luxon = require('luxon');
 var errors = require('@backstage/errors');
 var catalogClient = require('@backstage/catalog-client');
 var dns = require('node:dns');
+var backendCommon = require('@backstage/backend-common');
 var catalogModel = require('@backstage/catalog-model');
 var lodash = require('lodash');
 var fetch = require('node-fetch');
@@ -25,12 +24,11 @@ var https = require('https');
 var pluginAuthNode = require('@backstage/plugin-auth-node');
 var pluginPermissionCommon = require('@backstage/plugin-permission-common');
 var httpProxyMiddleware = require('http-proxy-middleware');
-var backendCommon = require('@backstage/backend-common');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
   var n = Object.create(null);
   if (e) {
     Object.keys(e).forEach(function (k) {
@@ -43,18 +41,18 @@ function _interopNamespace(e) {
       }
     });
   }
-  n["default"] = e;
+  n.default = e;
   return Object.freeze(n);
 }
 
-var container__namespace = /*#__PURE__*/_interopNamespace(container);
-var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
-var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
-var dns__default = /*#__PURE__*/_interopDefaultLegacy(dns);
-var lodash__default = /*#__PURE__*/_interopDefaultLegacy(lodash);
-var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
-var https__namespace = /*#__PURE__*/_interopNamespace(https);
+var container__namespace = /*#__PURE__*/_interopNamespaceCompat(container);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
+var dns__default = /*#__PURE__*/_interopDefaultCompat(dns);
+var lodash__default = /*#__PURE__*/_interopDefaultCompat(lodash);
+var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
+var https__namespace = /*#__PURE__*/_interopNamespaceCompat(https);
 
 class AksStrategy {
   async getCredential(_, requestAuth) {
@@ -81,16 +79,16 @@ class AnonymousStrategy {
   }
 }
 
-var __defProp$b = Object.defineProperty;
-var __defNormalProp$b = (obj, key, value) => key in obj ? __defProp$b(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$b = (obj, key, value) => {
-  __defNormalProp$b(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$c = Object.defineProperty;
+var __defNormalProp$c = (obj, key, value) => key in obj ? __defProp$c(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$c = (obj, key, value) => {
+  __defNormalProp$c(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 const defaultRegion = "us-east-1";
 class AwsIamStrategy {
   constructor(opts) {
-    __publicField$b(this, "credsManager");
+    __publicField$c(this, "credsManager");
     this.credsManager = integrationAwsNode.DefaultAwsCredentialsManager.fromConfig(opts.config);
   }
   async getCredential(clusterDetails) {
@@ -162,10 +160,10 @@ class AwsIamStrategy {
   }
 }
 
-var __defProp$a = Object.defineProperty;
-var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$a = (obj, key, value) => {
-  __defNormalProp$a(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$b = Object.defineProperty;
+var __defNormalProp$b = (obj, key, value) => key in obj ? __defProp$b(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$b = (obj, key, value) => {
+  __defNormalProp$b(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 const aksScope = "6dae42f8-4368-4678-94ff-3960e28e3630/.default";
@@ -173,8 +171,8 @@ class AzureIdentityStrategy {
   constructor(logger, tokenCredential = new identity.DefaultAzureCredential()) {
     this.logger = logger;
     this.tokenCredential = tokenCredential;
-    __publicField$a(this, "accessToken", { token: "", expiresOnTimestamp: 0 });
-    __publicField$a(this, "newTokenPromise");
+    __publicField$b(this, "accessToken", { token: "", expiresOnTimestamp: 0 });
+    __publicField$b(this, "newTokenPromise");
   }
   async getCredential() {
     if (!this.tokenRequiresRefresh()) {
@@ -257,15 +255,15 @@ class GoogleServiceAccountStrategy {
   }
 }
 
-var __defProp$9 = Object.defineProperty;
-var __defNormalProp$9 = (obj, key, value) => key in obj ? __defProp$9(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$9 = (obj, key, value) => {
-  __defNormalProp$9(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$a = Object.defineProperty;
+var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$a = (obj, key, value) => {
+  __defNormalProp$a(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class DispatchStrategy {
   constructor(options) {
-    __publicField$9(this, "strategyMap");
+    __publicField$a(this, "strategyMap");
     this.strategyMap = options.authStrategyMap;
   }
   getCredential(clusterDetails, auth) {
@@ -305,7 +303,7 @@ class ServiceAccountStrategy {
     const user = kc.getCurrentUser();
     return {
       type: "bearer token",
-      token: fs__default["default"].readFileSync(user.authProvider.config.tokenFile).toString()
+      token: fs__default.default.readFileSync(user.authProvider.config.tokenFile).toString()
     };
   }
   validateCluster() {
@@ -345,15 +343,15 @@ class OidcStrategy {
   }
 }
 
-var __defProp$8 = Object.defineProperty;
-var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$8 = (obj, key, value) => {
-  __defNormalProp$8(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$9 = Object.defineProperty;
+var __defNormalProp$9 = (obj, key, value) => key in obj ? __defProp$9(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$9 = (obj, key, value) => {
+  __defNormalProp$9(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class ConfigClusterLocator {
   constructor(clusterDetails) {
-    __publicField$8(this, "clusterDetails");
+    __publicField$9(this, "clusterDetails");
     this.clusterDetails = clusterDetails;
   }
   static fromConfig(config, authStrategy) {
@@ -473,7 +471,7 @@ function runPeriodically(fn, delayMs) {
 
 var name = "@backstage/plugin-kubernetes-backend";
 var description = "A Backstage backend plugin that integrates towards Kubernetes";
-var version = "0.16.0-next.2";
+var version = "0.16.1";
 var main = "src/index.ts";
 var types = "src/index.ts";
 var license = "Apache-2.0";
@@ -696,10 +694,10 @@ class GkeClusterLocator {
   }
 }
 
-var __defProp$7 = Object.defineProperty;
-var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$7 = (obj, key, value) => {
-  __defNormalProp$7(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$8 = Object.defineProperty;
+var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$8 = (obj, key, value) => {
+  __defNormalProp$8(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 function isObject(obj) {
@@ -707,8 +705,8 @@ function isObject(obj) {
 }
 class CatalogClusterLocator {
   constructor(catalogClient, auth) {
-    __publicField$7(this, "catalogClient");
-    __publicField$7(this, "auth");
+    __publicField$8(this, "catalogClient");
+    __publicField$8(this, "auth");
     this.catalogClient = catalogClient;
     this.auth = auth;
   }
@@ -768,18 +766,18 @@ class CatalogClusterLocator {
   }
 }
 
-var __defProp$6 = Object.defineProperty;
-var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$6 = (obj, key, value) => {
-  __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$7 = Object.defineProperty;
+var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$7 = (obj, key, value) => {
+  __defNormalProp$7(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class LocalKubectlProxyClusterLocator {
   constructor() {
-    __publicField$6(this, "clusterDetails");
+    __publicField$7(this, "clusterDetails");
     // verbatim: when false, IPv4 addresses are placed before IPv6 addresses, ignoring the order from the DNS resolver
     // By default kubectl proxy listens on 127.0.0.1 instead of [::1]
-    __publicField$6(this, "lookupPromise", dns__default["default"].promises.lookup("localhost", { verbatim: false }));
+    __publicField$7(this, "lookupPromise", dns__default.default.promises.lookup("localhost", { verbatim: false }));
     this.clusterDetails = [
       {
         name: "local",
@@ -908,6 +906,42 @@ const addResourceRoutesToRouter = (router, catalogApi, objectsProvider, auth, ht
   });
 };
 
+var __defProp$6 = Object.defineProperty;
+var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$6 = (obj, key, value) => {
+  __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class CatalogRelationServiceLocator {
+  constructor(clusterSupplier) {
+    __publicField$6(this, "clusterSupplier");
+    this.clusterSupplier = clusterSupplier;
+  }
+  // As this implementation always returns all clusters serviceId is ignored here
+  getClustersByEntity(entity, _requestContext) {
+    if (entity.relations && entity.relations.some(
+      (r) => r.type === "dependsOn" && r.targetRef.includes("resource:")
+    )) {
+      return this.clusterSupplier.getClusters().then((clusters) => {
+        return {
+          clusters: clusters.filter(
+            (c) => this.doesEntityDependOnCluster(entity, c)
+          )
+        };
+      });
+    }
+    return Promise.resolve({ clusters: [] });
+  }
+  doesEntityDependOnCluster(entity, cluster) {
+    return entity.relations.some(
+      (rel) => {
+        var _a;
+        return rel.type === "dependsOn" && rel.targetRef === `resource:${(_a = entity.metadata.namespace) != null ? _a : "default"}/${cluster.name}`;
+      }
+    );
+  }
+}
+
 var __defProp$5 = Object.defineProperty;
 var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$5 = (obj, key, value) => {
@@ -1224,7 +1258,7 @@ var __publicField$2 = (obj, key, value) => {
 const isError = (fr) => fr.hasOwnProperty("errorType");
 function fetchResultsToResponseWrapper(results) {
   var _a, _b;
-  const groupBy = lodash__default["default"].groupBy(results, (value) => {
+  const groupBy = lodash__default.default.groupBy(results, (value) => {
     return isError(value) ? "errors" : "responses";
   });
   return {
@@ -1358,10 +1392,10 @@ class KubernetesClientBasedFetcher {
     if (labelSelector) {
       url.search = `labelSelector=${encode(labelSelector)}`;
     }
-    return fetch__default["default"](url, requestInit);
+    return fetch__default.default(url, requestInit);
   }
   isServiceAccountAuthentication(authProvider, clusterDetails) {
-    return authProvider === "serviceAccount" && !clusterDetails.authMetadata.serviceAccountToken && fs__default["default"].pathExistsSync(clientNode.Config.SERVICEACCOUNT_CA_PATH);
+    return authProvider === "serviceAccount" && !clusterDetails.authMetadata.serviceAccountToken && fs__default.default.pathExistsSync(clientNode.Config.SERVICEACCOUNT_CA_PATH);
   }
   isCredentialMissing(authProvider, credential) {
     return authProvider !== "localKubectlProxy" && credential.type === "anonymous";
@@ -1411,7 +1445,7 @@ class KubernetesClientBasedFetcher {
     const url = new URL(cluster.server);
     if (url.protocol === "https:") {
       requestInit.agent = new https__namespace.Agent({
-        ca: fs__default["default"].readFileSync(cluster.caFile)
+        ca: fs__default.default.readFileSync(cluster.caFile)
       });
     }
     return [url, requestInit];
@@ -1551,7 +1585,7 @@ class KubernetesProxy {
       throw new errors.NotFoundError(`Cluster '${clusterName}' not found`);
     }
     const authProvider = cluster.authMetadata[pluginKubernetesCommon.ANNOTATION_KUBERNETES_AUTH_PROVIDER];
-    if (authProvider === "serviceAccount" && fs__default["default"].pathExistsSync(clientNode.Config.SERVICEACCOUNT_CA_PATH) && !cluster.authMetadata.serviceAccountToken) {
+    if (authProvider === "serviceAccount" && fs__default.default.pathExistsSync(clientNode.Config.SERVICEACCOUNT_CA_PATH) && !cluster.authMetadata.serviceAccountToken) {
       const kc = new clientNode.KubeConfig();
       kc.loadFromCluster();
       const clusterFromKubeConfig = kc.getCurrentCluster();
@@ -1631,7 +1665,7 @@ class KubernetesBuilder {
         "Failed to initialize kubernetes backend: kubernetes config is missing"
       );
       return {
-        router: Router__default["default"]()
+        router: Router__default.default()
       };
     }
     const { auth, httpAuth } = backendCommon.createLegacyAuthAdapters({
@@ -1759,6 +1793,9 @@ class KubernetesBuilder {
       case "singleTenant":
         this.serviceLocator = this.buildSingleTenantServiceLocator(clusterSupplier);
         break;
+      case "catalogRelation":
+        this.serviceLocator = this.buildCatalogRelationServiceLocator(clusterSupplier);
+        break;
       case "http":
         this.serviceLocator = this.buildHttpServiceLocator(clusterSupplier);
         break;
@@ -1775,6 +1812,9 @@ class KubernetesBuilder {
   buildSingleTenantServiceLocator(clusterSupplier) {
     return new SingleTenantServiceLocator(clusterSupplier);
   }
+  buildCatalogRelationServiceLocator(clusterSupplier) {
+    return new CatalogRelationServiceLocator(clusterSupplier);
+  }
   buildHttpServiceLocator(_clusterSupplier) {
     throw new Error("not implemented");
   }
@@ -1792,9 +1832,9 @@ class KubernetesBuilder {
   }
   buildRouter(objectsProvider, clusterSupplier, catalogApi, proxy, permissionApi, authService, httpAuth) {
     const logger = this.env.logger;
-    const router = Router__default["default"]();
+    const router = Router__default.default();
     router.use("/proxy", proxy.createRequestHandler({ permissionApi }));
-    router.use(express__default["default"].json());
+    router.use(express__default.default.json());
     router.use(
       pluginPermissionNode.createPermissionIntegrationRouter({
         permissions: pluginKubernetesCommon.kubernetesPermissions