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

package/dist/auth/ServiceAccountStrategy.cjs.js

@@ -0,0 +1,33 @@
+'use strict';
+
+var clientNode = require('@kubernetes/client-node');
+var fs = require('fs-extra');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+class ServiceAccountStrategy {
+  async getCredential(clusterDetails) {
+    const token = clusterDetails.authMetadata.serviceAccountToken;
+    if (token) {
+      return { type: "bearer token", token };
+    }
+    const kc = new clientNode.KubeConfig();
+    kc.loadFromCluster();
+    const user = kc.getCurrentUser();
+    return {
+      type: "bearer token",
+      token: fs__default.default.readFileSync(user.authProvider.config.tokenFile).toString()
+    };
+  }
+  validateCluster() {
+    return [];
+  }
+  presentAuthMetadata(_authMetadata) {
+    return {};
+  }
+}
+
+exports.ServiceAccountStrategy = ServiceAccountStrategy;
+//# sourceMappingURL=ServiceAccountStrategy.cjs.js.map

package/dist/auth/ServiceAccountStrategy.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceAccountStrategy.cjs.js","sources":["../../src/auth/ServiceAccountStrategy.ts"],"sourcesContent":["/*\n * Copyright 2020 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  AuthMetadata,\n  AuthenticationStrategy,\n  ClusterDetails,\n  KubernetesCredential,\n} from '@backstage/plugin-kubernetes-node';\nimport { KubeConfig, User } from '@kubernetes/client-node';\nimport fs from 'fs-extra';\n\n/**\n *\n * @public\n */\nexport class ServiceAccountStrategy implements AuthenticationStrategy {\n  public async getCredential(\n    clusterDetails: ClusterDetails,\n  ): Promise<KubernetesCredential> {\n    const token = clusterDetails.authMetadata.serviceAccountToken;\n    if (token) {\n      return { type: 'bearer token', token };\n    }\n    const kc = new KubeConfig();\n    kc.loadFromCluster();\n    // loadFromCluster is guaranteed to populate the user\n    const user = kc.getCurrentUser() as User;\n\n    return {\n      type: 'bearer token',\n      token: fs.readFileSync(user.authProvider.config.tokenFile).toString(),\n    };\n  }\n\n  public validateCluster(): Error[] {\n    return [];\n  }\n\n  public presentAuthMetadata(_authMetadata: AuthMetadata): AuthMetadata {\n    return {};\n  }\n}\n"],"names":["KubeConfig","fs"],"mappings":";;;;;;;;;AA6BO,MAAM,sBAAyD,CAAA;AAAA,EACpE,MAAa,cACX,cAC+B,EAAA;AAC/B,IAAM,MAAA,KAAA,GAAQ,eAAe,YAAa,CAAA,mBAAA,CAAA;AAC1C,IAAA,IAAI,KAAO,EAAA;AACT,MAAO,OAAA,EAAE,IAAM,EAAA,cAAA,EAAgB,KAAM,EAAA,CAAA;AAAA,KACvC;AACA,IAAM,MAAA,EAAA,GAAK,IAAIA,qBAAW,EAAA,CAAA;AAC1B,IAAA,EAAA,CAAG,eAAgB,EAAA,CAAA;AAEnB,IAAM,MAAA,IAAA,GAAO,GAAG,cAAe,EAAA,CAAA;AAE/B,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,cAAA;AAAA,MACN,KAAA,EAAOC,oBAAG,YAAa,CAAA,IAAA,CAAK,aAAa,MAAO,CAAA,SAAS,EAAE,QAAS,EAAA;AAAA,KACtE,CAAA;AAAA,GACF;AAAA,EAEO,eAA2B,GAAA;AAChC,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAAA,EAEO,oBAAoB,aAA2C,EAAA;AACpE,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AACF;;;;"}

package/dist/cluster-locator/CatalogClusterLocator.cjs.js

@@ -0,0 +1,73 @@
+'use strict';
+
+var catalogClient = require('@backstage/catalog-client');
+var pluginKubernetesCommon = require('@backstage/plugin-kubernetes-common');
+
+function isObject(obj) {
+  return typeof obj === "object" && obj !== null && !Array.isArray(obj);
+}
+class CatalogClusterLocator {
+  catalogClient;
+  auth;
+  constructor(catalogClient, auth) {
+    this.catalogClient = catalogClient;
+    this.auth = auth;
+  }
+  static fromConfig(catalogApi, auth) {
+    return new CatalogClusterLocator(catalogApi, auth);
+  }
+  async getClusters(options) {
+    const apiServerKey = `metadata.annotations.${pluginKubernetesCommon.ANNOTATION_KUBERNETES_API_SERVER}`;
+    const apiServerCaKey = `metadata.annotations.${pluginKubernetesCommon.ANNOTATION_KUBERNETES_API_SERVER_CA}`;
+    const authProviderKey = `metadata.annotations.${pluginKubernetesCommon.ANNOTATION_KUBERNETES_AUTH_PROVIDER}`;
+    const filter = {
+      kind: "Resource",
+      "spec.type": "kubernetes-cluster",
+      [apiServerKey]: catalogClient.CATALOG_FILTER_EXISTS,
+      [apiServerCaKey]: catalogClient.CATALOG_FILTER_EXISTS,
+      [authProviderKey]: catalogClient.CATALOG_FILTER_EXISTS
+    };
+    const clusters = await this.catalogClient.getEntities(
+      {
+        filter: [filter]
+      },
+      options?.credentials ? {
+        token: (await this.auth.getPluginRequestToken({
+          onBehalfOf: options.credentials,
+          targetPluginId: "catalog"
+        })).token
+      } : void 0
+    );
+    return clusters.items.map((entity) => {
+      const annotations = entity.metadata.annotations;
+      const clusterDetails = {
+        name: entity.metadata.name,
+        title: entity.metadata.title,
+        url: annotations[pluginKubernetesCommon.ANNOTATION_KUBERNETES_API_SERVER],
+        authMetadata: annotations,
+        caData: annotations[pluginKubernetesCommon.ANNOTATION_KUBERNETES_API_SERVER_CA],
+        skipMetricsLookup: annotations[pluginKubernetesCommon.ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP] === "true",
+        skipTLSVerify: annotations[pluginKubernetesCommon.ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY] === "true",
+        dashboardUrl: annotations[pluginKubernetesCommon.ANNOTATION_KUBERNETES_DASHBOARD_URL],
+        dashboardApp: annotations[pluginKubernetesCommon.ANNOTATION_KUBERNETES_DASHBOARD_APP],
+        dashboardParameters: this.getDashboardParameters(annotations)
+      };
+      return clusterDetails;
+    });
+  }
+  getDashboardParameters(annotations) {
+    const dashboardParamsString = annotations[pluginKubernetesCommon.ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS];
+    if (dashboardParamsString) {
+      try {
+        const dashboardParams = JSON.parse(dashboardParamsString);
+        return isObject(dashboardParams) ? dashboardParams : void 0;
+      } catch {
+        return void 0;
+      }
+    }
+    return void 0;
+  }
+}
+
+exports.CatalogClusterLocator = CatalogClusterLocator;
+//# sourceMappingURL=CatalogClusterLocator.cjs.js.map

package/dist/cluster-locator/CatalogClusterLocator.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogClusterLocator.cjs.js","sources":["../../src/cluster-locator/CatalogClusterLocator.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 */\n\nimport {\n  AuthService,\n  BackstageCredentials,\n} from '@backstage/backend-plugin-api';\nimport { ClusterDetails, KubernetesClustersSupplier } from '../types/types';\nimport { CATALOG_FILTER_EXISTS, CatalogApi } from '@backstage/catalog-client';\nimport {\n  ANNOTATION_KUBERNETES_API_SERVER,\n  ANNOTATION_KUBERNETES_API_SERVER_CA,\n  ANNOTATION_KUBERNETES_AUTH_PROVIDER,\n  ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP,\n  ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY,\n  ANNOTATION_KUBERNETES_DASHBOARD_URL,\n  ANNOTATION_KUBERNETES_DASHBOARD_APP,\n  ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS,\n} from '@backstage/plugin-kubernetes-common';\nimport { JsonObject } from '@backstage/types';\n\nfunction isObject(obj: unknown): obj is JsonObject {\n  return typeof obj === 'object' && obj !== null && !Array.isArray(obj);\n}\n\nexport class CatalogClusterLocator implements KubernetesClustersSupplier {\n  private catalogClient: CatalogApi;\n  private auth: AuthService;\n\n  constructor(catalogClient: CatalogApi, auth: AuthService) {\n    this.catalogClient = catalogClient;\n    this.auth = auth;\n  }\n\n  static fromConfig(\n    catalogApi: CatalogApi,\n    auth: AuthService,\n  ): CatalogClusterLocator {\n    return new CatalogClusterLocator(catalogApi, auth);\n  }\n\n  async getClusters(options?: {\n    credentials: BackstageCredentials;\n  }): Promise<ClusterDetails[]> {\n    const apiServerKey = `metadata.annotations.${ANNOTATION_KUBERNETES_API_SERVER}`;\n    const apiServerCaKey = `metadata.annotations.${ANNOTATION_KUBERNETES_API_SERVER_CA}`;\n    const authProviderKey = `metadata.annotations.${ANNOTATION_KUBERNETES_AUTH_PROVIDER}`;\n\n    const filter: Record<string, symbol | string> = {\n      kind: 'Resource',\n      'spec.type': 'kubernetes-cluster',\n      [apiServerKey]: CATALOG_FILTER_EXISTS,\n      [apiServerCaKey]: CATALOG_FILTER_EXISTS,\n      [authProviderKey]: CATALOG_FILTER_EXISTS,\n    };\n\n    const clusters = await this.catalogClient.getEntities(\n      {\n        filter: [filter],\n      },\n      options?.credentials\n        ? {\n            token: (\n              await this.auth.getPluginRequestToken({\n                onBehalfOf: options.credentials,\n                targetPluginId: 'catalog',\n              })\n            ).token,\n          }\n        : undefined,\n    );\n    return clusters.items.map(entity => {\n      const annotations = entity.metadata.annotations!;\n      const clusterDetails: ClusterDetails = {\n        name: entity.metadata.name,\n        title: entity.metadata.title,\n        url: annotations[ANNOTATION_KUBERNETES_API_SERVER],\n        authMetadata: annotations,\n        caData: annotations[ANNOTATION_KUBERNETES_API_SERVER_CA],\n        skipMetricsLookup:\n          annotations[ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP] === 'true',\n        skipTLSVerify:\n          annotations[ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY] === 'true',\n        dashboardUrl: annotations[ANNOTATION_KUBERNETES_DASHBOARD_URL],\n        dashboardApp: annotations[ANNOTATION_KUBERNETES_DASHBOARD_APP],\n        dashboardParameters: this.getDashboardParameters(annotations),\n      };\n\n      return clusterDetails;\n    });\n  }\n\n  private getDashboardParameters(\n    annotations: Record<string, string>,\n  ): JsonObject | undefined {\n    const dashboardParamsString =\n      annotations[ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS];\n    if (dashboardParamsString) {\n      try {\n        const dashboardParams = JSON.parse(dashboardParamsString);\n        return isObject(dashboardParams) ? dashboardParams : undefined;\n      } catch {\n        return undefined;\n      }\n    }\n    return undefined;\n  }\n}\n"],"names":["ANNOTATION_KUBERNETES_API_SERVER","ANNOTATION_KUBERNETES_API_SERVER_CA","ANNOTATION_KUBERNETES_AUTH_PROVIDER","CATALOG_FILTER_EXISTS","ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP","ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY","ANNOTATION_KUBERNETES_DASHBOARD_URL","ANNOTATION_KUBERNETES_DASHBOARD_APP","ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS"],"mappings":";;;;;AAkCA,SAAS,SAAS,GAAiC,EAAA;AACjD,EAAO,OAAA,OAAO,QAAQ,QAAY,IAAA,GAAA,KAAQ,QAAQ,CAAC,KAAA,CAAM,QAAQ,GAAG,CAAA,CAAA;AACtE,CAAA;AAEO,MAAM,qBAA4D,CAAA;AAAA,EAC/D,aAAA,CAAA;AAAA,EACA,IAAA,CAAA;AAAA,EAER,WAAA,CAAY,eAA2B,IAAmB,EAAA;AACxD,IAAA,IAAA,CAAK,aAAgB,GAAA,aAAA,CAAA;AACrB,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GACd;AAAA,EAEA,OAAO,UACL,CAAA,UAAA,EACA,IACuB,EAAA;AACvB,IAAO,OAAA,IAAI,qBAAsB,CAAA,UAAA,EAAY,IAAI,CAAA,CAAA;AAAA,GACnD;AAAA,EAEA,MAAM,YAAY,OAEY,EAAA;AAC5B,IAAM,MAAA,YAAA,GAAe,wBAAwBA,uDAAgC,CAAA,CAAA,CAAA;AAC7E,IAAM,MAAA,cAAA,GAAiB,wBAAwBC,0DAAmC,CAAA,CAAA,CAAA;AAClF,IAAM,MAAA,eAAA,GAAkB,wBAAwBC,0DAAmC,CAAA,CAAA,CAAA;AAEnF,IAAA,MAAM,MAA0C,GAAA;AAAA,MAC9C,IAAM,EAAA,UAAA;AAAA,MACN,WAAa,EAAA,oBAAA;AAAA,MACb,CAAC,YAAY,GAAGC,mCAAA;AAAA,MAChB,CAAC,cAAc,GAAGA,mCAAA;AAAA,MAClB,CAAC,eAAe,GAAGA,mCAAA;AAAA,KACrB,CAAA;AAEA,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,aAAc,CAAA,WAAA;AAAA,MACxC;AAAA,QACE,MAAA,EAAQ,CAAC,MAAM,CAAA;AAAA,OACjB;AAAA,MACA,SAAS,WACL,GAAA;AAAA,QACE,KACE,EAAA,CAAA,MAAM,IAAK,CAAA,IAAA,CAAK,qBAAsB,CAAA;AAAA,UACpC,YAAY,OAAQ,CAAA,WAAA;AAAA,UACpB,cAAgB,EAAA,SAAA;AAAA,SACjB,CACD,EAAA,KAAA;AAAA,OAEJ,GAAA,KAAA,CAAA;AAAA,KACN,CAAA;AACA,IAAO,OAAA,QAAA,CAAS,KAAM,CAAA,GAAA,CAAI,CAAU,MAAA,KAAA;AAClC,MAAM,MAAA,WAAA,GAAc,OAAO,QAAS,CAAA,WAAA,CAAA;AACpC,MAAA,MAAM,cAAiC,GAAA;AAAA,QACrC,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,QACtB,KAAA,EAAO,OAAO,QAAS,CAAA,KAAA;AAAA,QACvB,GAAA,EAAK,YAAYH,uDAAgC,CAAA;AAAA,QACjD,YAAc,EAAA,WAAA;AAAA,QACd,MAAA,EAAQ,YAAYC,0DAAmC,CAAA;AAAA,QACvD,iBAAA,EACE,WAAY,CAAAG,gEAAyC,CAAM,KAAA,MAAA;AAAA,QAC7D,aAAA,EACE,WAAY,CAAAC,4DAAqC,CAAM,KAAA,MAAA;AAAA,QACzD,YAAA,EAAc,YAAYC,0DAAmC,CAAA;AAAA,QAC7D,YAAA,EAAc,YAAYC,0DAAmC,CAAA;AAAA,QAC7D,mBAAA,EAAqB,IAAK,CAAA,sBAAA,CAAuB,WAAW,CAAA;AAAA,OAC9D,CAAA;AAEA,MAAO,OAAA,cAAA,CAAA;AAAA,KACR,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,uBACN,WACwB,EAAA;AACxB,IAAM,MAAA,qBAAA,GACJ,YAAYC,iEAA0C,CAAA,CAAA;AACxD,IAAA,IAAI,qBAAuB,EAAA;AACzB,MAAI,IAAA;AACF,QAAM,MAAA,eAAA,GAAkB,IAAK,CAAA,KAAA,CAAM,qBAAqB,CAAA,CAAA;AACxD,QAAO,OAAA,QAAA,CAAS,eAAe,CAAA,GAAI,eAAkB,GAAA,KAAA,CAAA,CAAA;AAAA,OAC/C,CAAA,MAAA;AACN,QAAO,OAAA,KAAA,CAAA,CAAA;AAAA,OACT;AAAA,KACF;AACA,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AACF;;;;"}

package/dist/cluster-locator/ConfigClusterLocator.cjs.js

@@ -0,0 +1,100 @@
+'use strict';
+
+var pluginKubernetesCommon = require('@backstage/plugin-kubernetes-common');
+
+class ConfigClusterLocator {
+  clusterDetails;
+  constructor(clusterDetails) {
+    this.clusterDetails = clusterDetails;
+  }
+  static fromConfig(config, authStrategy) {
+    const clusterNames = /* @__PURE__ */ new Set();
+    return new ConfigClusterLocator(
+      config.getConfigArray("clusters").map((c) => {
+        const authMetadataBlock = c.getOptional("authMetadata");
+        const name = c.getString("name");
+        if (clusterNames.has(name)) {
+          throw new Error(`Duplicate cluster name '${name}'`);
+        }
+        clusterNames.add(name);
+        const authProvider = authMetadataBlock?.[pluginKubernetesCommon.ANNOTATION_KUBERNETES_AUTH_PROVIDER] ?? c.getOptionalString("authProvider");
+        if (!authProvider) {
+          throw new Error(
+            `cluster '${name}' has no auth provider configured; this must be specified via the 'authProvider' or 'authMetadata.${pluginKubernetesCommon.ANNOTATION_KUBERNETES_AUTH_PROVIDER}' parameter`
+          );
+        }
+        const title = c.getOptionalString("title");
+        const clusterDetails = {
+          name,
+          ...title && { title },
+          url: c.getString("url"),
+          skipTLSVerify: c.getOptionalBoolean("skipTLSVerify") ?? false,
+          skipMetricsLookup: c.getOptionalBoolean("skipMetricsLookup") ?? false,
+          caData: c.getOptionalString("caData"),
+          caFile: c.getOptionalString("caFile"),
+          authMetadata: {
+            [pluginKubernetesCommon.ANNOTATION_KUBERNETES_AUTH_PROVIDER]: authProvider,
+            ...ConfigClusterLocator.parseAuthMetadata(c),
+            ...authMetadataBlock
+          }
+        };
+        const customResources = c.getOptionalConfigArray("customResources");
+        if (customResources) {
+          clusterDetails.customResources = customResources.map((cr) => {
+            return {
+              group: cr.getString("group"),
+              apiVersion: cr.getString("apiVersion"),
+              plural: cr.getString("plural")
+            };
+          });
+        }
+        const dashboardUrl = c.getOptionalString("dashboardUrl");
+        if (dashboardUrl) {
+          clusterDetails.dashboardUrl = dashboardUrl;
+        }
+        const dashboardApp = c.getOptionalString("dashboardApp");
+        if (dashboardApp) {
+          clusterDetails.dashboardApp = dashboardApp;
+        }
+        if (c.has("dashboardParameters")) {
+          clusterDetails.dashboardParameters = c.get("dashboardParameters");
+        }
+        const validationErrors = authStrategy.validateCluster(
+          clusterDetails.authMetadata
+        );
+        if (validationErrors.length !== 0) {
+          throw new Error(
+            `Invalid cluster '${clusterDetails.name}': ${validationErrors.map((e) => e.message).join(", ")}`
+          );
+        }
+        return clusterDetails;
+      })
+    );
+  }
+  static parseAuthMetadata(clusterConfig) {
+    const serviceAccountToken = clusterConfig.getOptionalString(
+      "serviceAccountToken"
+    );
+    const assumeRole = clusterConfig.getOptionalString("assumeRole");
+    const externalId = clusterConfig.getOptionalString("externalId");
+    const oidcTokenProvider = clusterConfig.getOptionalString("oidcTokenProvider");
+    return serviceAccountToken || assumeRole || externalId || oidcTokenProvider ? {
+      ...serviceAccountToken && { serviceAccountToken },
+      ...assumeRole && {
+        [pluginKubernetesCommon.ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE]: assumeRole
+      },
+      ...externalId && {
+        [pluginKubernetesCommon.ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID]: externalId
+      },
+      ...oidcTokenProvider && {
+        [pluginKubernetesCommon.ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER]: oidcTokenProvider
+      }
+    } : void 0;
+  }
+  async getClusters() {
+    return this.clusterDetails;
+  }
+}
+
+exports.ConfigClusterLocator = ConfigClusterLocator;
+//# sourceMappingURL=ConfigClusterLocator.cjs.js.map

package/dist/cluster-locator/ConfigClusterLocator.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigClusterLocator.cjs.js","sources":["../../src/cluster-locator/ConfigClusterLocator.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { Config } from '@backstage/config';\nimport {\n  ANNOTATION_KUBERNETES_AUTH_PROVIDER,\n  ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE,\n  ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID,\n  ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER,\n} from '@backstage/plugin-kubernetes-common';\nimport { ClusterDetails, KubernetesClustersSupplier } from '../types/types';\nimport { AuthenticationStrategy } from '../auth';\n\nexport class ConfigClusterLocator implements KubernetesClustersSupplier {\n  private readonly clusterDetails: ClusterDetails[];\n\n  constructor(clusterDetails: ClusterDetails[]) {\n    this.clusterDetails = clusterDetails;\n  }\n\n  static fromConfig(\n    config: Config,\n    authStrategy: AuthenticationStrategy,\n  ): ConfigClusterLocator {\n    const clusterNames = new Set();\n    return new ConfigClusterLocator(\n      config.getConfigArray('clusters').map(c => {\n        const authMetadataBlock = c.getOptional<{\n          [ANNOTATION_KUBERNETES_AUTH_PROVIDER]?: string;\n        }>('authMetadata');\n        const name = c.getString('name');\n        if (clusterNames.has(name)) {\n          throw new Error(`Duplicate cluster name '${name}'`);\n        }\n        clusterNames.add(name);\n        const authProvider =\n          authMetadataBlock?.[ANNOTATION_KUBERNETES_AUTH_PROVIDER] ??\n          c.getOptionalString('authProvider');\n        if (!authProvider) {\n          throw new Error(\n            `cluster '${name}' has no auth provider configured; this must be ` +\n              `specified via the 'authProvider' or ` +\n              `'authMetadata.${ANNOTATION_KUBERNETES_AUTH_PROVIDER}' parameter`,\n          );\n        }\n        const title = c.getOptionalString('title');\n        const clusterDetails: ClusterDetails = {\n          name,\n          ...(title && { title }),\n          url: c.getString('url'),\n          skipTLSVerify: c.getOptionalBoolean('skipTLSVerify') ?? false,\n          skipMetricsLookup: c.getOptionalBoolean('skipMetricsLookup') ?? false,\n          caData: c.getOptionalString('caData'),\n          caFile: c.getOptionalString('caFile'),\n          authMetadata: {\n            [ANNOTATION_KUBERNETES_AUTH_PROVIDER]: authProvider,\n            ...ConfigClusterLocator.parseAuthMetadata(c),\n            ...authMetadataBlock,\n          },\n        };\n\n        const customResources = c.getOptionalConfigArray('customResources');\n        if (customResources) {\n          clusterDetails.customResources = customResources.map(cr => {\n            return {\n              group: cr.getString('group'),\n              apiVersion: cr.getString('apiVersion'),\n              plural: cr.getString('plural'),\n            };\n          });\n        }\n\n        const dashboardUrl = c.getOptionalString('dashboardUrl');\n        if (dashboardUrl) {\n          clusterDetails.dashboardUrl = dashboardUrl;\n        }\n        const dashboardApp = c.getOptionalString('dashboardApp');\n        if (dashboardApp) {\n          clusterDetails.dashboardApp = dashboardApp;\n        }\n        if (c.has('dashboardParameters')) {\n          clusterDetails.dashboardParameters = c.get('dashboardParameters');\n        }\n\n        const validationErrors = authStrategy.validateCluster(\n          clusterDetails.authMetadata,\n        );\n        if (validationErrors.length !== 0) {\n          throw new Error(\n            `Invalid cluster '${clusterDetails.name}': ${validationErrors\n              .map(e => e.message)\n              .join(', ')}`,\n          );\n        }\n        return clusterDetails;\n      }),\n    );\n  }\n\n  private static parseAuthMetadata(\n    clusterConfig: Config,\n  ): Record<string, string> | undefined {\n    const serviceAccountToken = clusterConfig.getOptionalString(\n      'serviceAccountToken',\n    );\n    const assumeRole = clusterConfig.getOptionalString('assumeRole');\n    const externalId = clusterConfig.getOptionalString('externalId');\n    const oidcTokenProvider =\n      clusterConfig.getOptionalString('oidcTokenProvider');\n\n    return serviceAccountToken || assumeRole || externalId || oidcTokenProvider\n      ? {\n          ...(serviceAccountToken && { serviceAccountToken }),\n          ...(assumeRole && {\n            [ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE]: assumeRole,\n          }),\n          ...(externalId && {\n            [ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID]: externalId,\n          }),\n          ...(oidcTokenProvider && {\n            [ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER]: oidcTokenProvider,\n          }),\n        }\n      : undefined;\n  }\n\n  async getClusters(): Promise<ClusterDetails[]> {\n    return this.clusterDetails;\n  }\n}\n"],"names":["ANNOTATION_KUBERNETES_AUTH_PROVIDER","ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE","ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID","ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER"],"mappings":";;;;AA0BO,MAAM,oBAA2D,CAAA;AAAA,EACrD,cAAA,CAAA;AAAA,EAEjB,YAAY,cAAkC,EAAA;AAC5C,IAAA,IAAA,CAAK,cAAiB,GAAA,cAAA,CAAA;AAAA,GACxB;AAAA,EAEA,OAAO,UACL,CAAA,MAAA,EACA,YACsB,EAAA;AACtB,IAAM,MAAA,YAAA,uBAAmB,GAAI,EAAA,CAAA;AAC7B,IAAA,OAAO,IAAI,oBAAA;AAAA,MACT,MAAO,CAAA,cAAA,CAAe,UAAU,CAAA,CAAE,IAAI,CAAK,CAAA,KAAA;AACzC,QAAM,MAAA,iBAAA,GAAoB,CAAE,CAAA,WAAA,CAEzB,cAAc,CAAA,CAAA;AACjB,QAAM,MAAA,IAAA,GAAO,CAAE,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AAC/B,QAAI,IAAA,YAAA,CAAa,GAAI,CAAA,IAAI,CAAG,EAAA;AAC1B,UAAA,MAAM,IAAI,KAAA,CAAM,CAA2B,wBAAA,EAAA,IAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,SACpD;AACA,QAAA,YAAA,CAAa,IAAI,IAAI,CAAA,CAAA;AACrB,QAAA,MAAM,eACJ,iBAAoB,GAAAA,0DAAmC,CACvD,IAAA,CAAA,CAAE,kBAAkB,cAAc,CAAA,CAAA;AACpC,QAAA,IAAI,CAAC,YAAc,EAAA;AACjB,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,CAAA,SAAA,EAAY,IAAI,CAAA,kGAAA,EAEGA,0DAAmC,CAAA,WAAA,CAAA;AAAA,WACxD,CAAA;AAAA,SACF;AACA,QAAM,MAAA,KAAA,GAAQ,CAAE,CAAA,iBAAA,CAAkB,OAAO,CAAA,CAAA;AACzC,QAAA,MAAM,cAAiC,GAAA;AAAA,UACrC,IAAA;AAAA,UACA,GAAI,KAAS,IAAA,EAAE,KAAM,EAAA;AAAA,UACrB,GAAA,EAAK,CAAE,CAAA,SAAA,CAAU,KAAK,CAAA;AAAA,UACtB,aAAe,EAAA,CAAA,CAAE,kBAAmB,CAAA,eAAe,CAAK,IAAA,KAAA;AAAA,UACxD,iBAAmB,EAAA,CAAA,CAAE,kBAAmB,CAAA,mBAAmB,CAAK,IAAA,KAAA;AAAA,UAChE,MAAA,EAAQ,CAAE,CAAA,iBAAA,CAAkB,QAAQ,CAAA;AAAA,UACpC,MAAA,EAAQ,CAAE,CAAA,iBAAA,CAAkB,QAAQ,CAAA;AAAA,UACpC,YAAc,EAAA;AAAA,YACZ,CAACA,0DAAmC,GAAG,YAAA;AAAA,YACvC,GAAG,oBAAqB,CAAA,iBAAA,CAAkB,CAAC,CAAA;AAAA,YAC3C,GAAG,iBAAA;AAAA,WACL;AAAA,SACF,CAAA;AAEA,QAAM,MAAA,eAAA,GAAkB,CAAE,CAAA,sBAAA,CAAuB,iBAAiB,CAAA,CAAA;AAClE,QAAA,IAAI,eAAiB,EAAA;AACnB,UAAe,cAAA,CAAA,eAAA,GAAkB,eAAgB,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA;AACzD,YAAO,OAAA;AAAA,cACL,KAAA,EAAO,EAAG,CAAA,SAAA,CAAU,OAAO,CAAA;AAAA,cAC3B,UAAA,EAAY,EAAG,CAAA,SAAA,CAAU,YAAY,CAAA;AAAA,cACrC,MAAA,EAAQ,EAAG,CAAA,SAAA,CAAU,QAAQ,CAAA;AAAA,aAC/B,CAAA;AAAA,WACD,CAAA,CAAA;AAAA,SACH;AAEA,QAAM,MAAA,YAAA,GAAe,CAAE,CAAA,iBAAA,CAAkB,cAAc,CAAA,CAAA;AACvD,QAAA,IAAI,YAAc,EAAA;AAChB,UAAA,cAAA,CAAe,YAAe,GAAA,YAAA,CAAA;AAAA,SAChC;AACA,QAAM,MAAA,YAAA,GAAe,CAAE,CAAA,iBAAA,CAAkB,cAAc,CAAA,CAAA;AACvD,QAAA,IAAI,YAAc,EAAA;AAChB,UAAA,cAAA,CAAe,YAAe,GAAA,YAAA,CAAA;AAAA,SAChC;AACA,QAAI,IAAA,CAAA,CAAE,GAAI,CAAA,qBAAqB,CAAG,EAAA;AAChC,UAAe,cAAA,CAAA,mBAAA,GAAsB,CAAE,CAAA,GAAA,CAAI,qBAAqB,CAAA,CAAA;AAAA,SAClE;AAEA,QAAA,MAAM,mBAAmB,YAAa,CAAA,eAAA;AAAA,UACpC,cAAe,CAAA,YAAA;AAAA,SACjB,CAAA;AACA,QAAI,IAAA,gBAAA,CAAiB,WAAW,CAAG,EAAA;AACjC,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,CAAoB,iBAAA,EAAA,cAAA,CAAe,IAAI,CAAA,GAAA,EAAM,gBAC1C,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,CAAA,CAClB,IAAK,CAAA,IAAI,CAAC,CAAA,CAAA;AAAA,WACf,CAAA;AAAA,SACF;AACA,QAAO,OAAA,cAAA,CAAA;AAAA,OACR,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,OAAe,kBACb,aACoC,EAAA;AACpC,IAAA,MAAM,sBAAsB,aAAc,CAAA,iBAAA;AAAA,MACxC,qBAAA;AAAA,KACF,CAAA;AACA,IAAM,MAAA,UAAA,GAAa,aAAc,CAAA,iBAAA,CAAkB,YAAY,CAAA,CAAA;AAC/D,IAAM,MAAA,UAAA,GAAa,aAAc,CAAA,iBAAA,CAAkB,YAAY,CAAA,CAAA;AAC/D,IAAM,MAAA,iBAAA,GACJ,aAAc,CAAA,iBAAA,CAAkB,mBAAmB,CAAA,CAAA;AAErD,IAAO,OAAA,mBAAA,IAAuB,UAAc,IAAA,UAAA,IAAc,iBACtD,GAAA;AAAA,MACE,GAAI,mBAAuB,IAAA,EAAE,mBAAoB,EAAA;AAAA,MACjD,GAAI,UAAc,IAAA;AAAA,QAChB,CAACC,4DAAqC,GAAG,UAAA;AAAA,OAC3C;AAAA,MACA,GAAI,UAAc,IAAA;AAAA,QAChB,CAACC,4DAAqC,GAAG,UAAA;AAAA,OAC3C;AAAA,MACA,GAAI,iBAAqB,IAAA;AAAA,QACvB,CAACC,gEAAyC,GAAG,iBAAA;AAAA,OAC/C;AAAA,KAEF,GAAA,KAAA,CAAA,CAAA;AAAA,GACN;AAAA,EAEA,MAAM,WAAyC,GAAA;AAC7C,IAAA,OAAO,IAAK,CAAA,cAAA,CAAA;AAAA,GACd;AACF;;;;"}

package/dist/cluster-locator/GkeClusterLocator.cjs.js

@@ -0,0 +1,126 @@
+'use strict';
+
+var pluginKubernetesCommon = require('@backstage/plugin-kubernetes-common');
+var errors = require('@backstage/errors');
+var container = require('@google-cloud/container');
+var runPeriodically = require('../service/runPeriodically.cjs.js');
+var _package = require('../package.json.cjs.js');
+
+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) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var container__namespace = /*#__PURE__*/_interopNamespaceCompat(container);
+
+class GkeClusterLocator {
+  constructor(options, client, clusterDetails = void 0, hasClusterDetails = false) {
+    this.options = options;
+    this.client = client;
+    this.clusterDetails = clusterDetails;
+    this.hasClusterDetails = hasClusterDetails;
+  }
+  static fromConfigWithClient(config, client, refreshInterval) {
+    const matchingResourceLabels = config.getOptionalConfigArray("matchingResourceLabels")?.map((mrl) => {
+      return { key: mrl.getString("key"), value: mrl.getString("value") };
+    }) ?? [];
+    const storeAuthProviderString = config.getOptionalString("authProvider") === "googleServiceAccount" ? "googleServiceAccount" : "google";
+    const options = {
+      projectId: config.getString("projectId"),
+      authProvider: storeAuthProviderString,
+      region: config.getOptionalString("region") ?? "-",
+      skipTLSVerify: config.getOptionalBoolean("skipTLSVerify") ?? false,
+      skipMetricsLookup: config.getOptionalBoolean("skipMetricsLookup") ?? false,
+      exposeDashboard: config.getOptionalBoolean("exposeDashboard") ?? false,
+      matchingResourceLabels
+    };
+    const gkeClusterLocator = new GkeClusterLocator(options, client);
+    if (refreshInterval) {
+      runPeriodically.runPeriodically(
+        () => gkeClusterLocator.refreshClusters(),
+        refreshInterval.toMillis()
+      );
+    }
+    return gkeClusterLocator;
+  }
+  // Added an `x-goog-api-client` header to API requests made by the GKE cluster locator to clearly identify API requests from this plugin.
+  static fromConfig(config, refreshInterval = void 0) {
+    return GkeClusterLocator.fromConfigWithClient(
+      config,
+      new container__namespace.v1.ClusterManagerClient({
+        libName: `backstage/kubernetes-backend.GkeClusterLocator`,
+        libVersion: _package.default.version
+      }),
+      refreshInterval
+    );
+  }
+  async getClusters() {
+    if (!this.hasClusterDetails) {
+      await this.refreshClusters();
+    }
+    return this.clusterDetails ?? [];
+  }
+  // TODO pass caData into the object
+  async refreshClusters() {
+    const {
+      projectId,
+      region,
+      authProvider,
+      skipTLSVerify,
+      skipMetricsLookup,
+      exposeDashboard,
+      matchingResourceLabels
+    } = this.options;
+    const request = {
+      parent: `projects/${projectId}/locations/${region}`
+    };
+    try {
+      const [response] = await this.client.listClusters(request);
+      this.clusterDetails = (response.clusters ?? []).filter((r) => {
+        return matchingResourceLabels?.every((mrl) => {
+          if (!r.resourceLabels) {
+            return false;
+          }
+          return r.resourceLabels[mrl.key] === mrl.value;
+        });
+      }).map((r) => ({
+        // TODO filter out clusters which don't have name or endpoint
+        name: r.name ?? "unknown",
+        url: `https://${r.endpoint ?? ""}`,
+        authMetadata: { [pluginKubernetesCommon.ANNOTATION_KUBERNETES_AUTH_PROVIDER]: authProvider },
+        skipTLSVerify,
+        skipMetricsLookup,
+        ...exposeDashboard ? {
+          dashboardApp: "gke",
+          dashboardParameters: {
+            projectId,
+            region,
+            clusterName: r.name
+          }
+        } : {}
+      }));
+      this.hasClusterDetails = true;
+    } catch (e) {
+      throw new errors.ForwardedError(
+        `There was an error retrieving clusters from GKE for projectId=${projectId} region=${region}`,
+        e
+      );
+    }
+  }
+}
+
+exports.GkeClusterLocator = GkeClusterLocator;
+//# sourceMappingURL=GkeClusterLocator.cjs.js.map

package/dist/cluster-locator/GkeClusterLocator.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GkeClusterLocator.cjs.js","sources":["../../src/cluster-locator/GkeClusterLocator.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { ANNOTATION_KUBERNETES_AUTH_PROVIDER } from '@backstage/plugin-kubernetes-common';\nimport { Config } from '@backstage/config';\nimport { ForwardedError } from '@backstage/errors';\nimport * as container from '@google-cloud/container';\nimport { Duration } from 'luxon';\nimport { runPeriodically } from '../service/runPeriodically';\nimport { ClusterDetails, KubernetesClustersSupplier } from '../types/types';\nimport packageinfo from '../../package.json';\n\ninterface MatchResourceLabelEntry {\n  key: string;\n  value: string;\n}\n\ntype GkeClusterLocatorOptions = {\n  projectId: string;\n  authProvider: string;\n  region?: string;\n  skipTLSVerify?: boolean;\n  skipMetricsLookup?: boolean;\n  exposeDashboard?: boolean;\n  matchingResourceLabels?: MatchResourceLabelEntry[];\n};\n\nexport class GkeClusterLocator implements KubernetesClustersSupplier {\n  constructor(\n    private readonly options: GkeClusterLocatorOptions,\n    private readonly client: container.v1.ClusterManagerClient,\n    private clusterDetails: ClusterDetails[] | undefined = undefined,\n    private hasClusterDetails: boolean = false,\n  ) {}\n\n  static fromConfigWithClient(\n    config: Config,\n    client: container.v1.ClusterManagerClient,\n    refreshInterval?: Duration,\n  ): GkeClusterLocator {\n    const matchingResourceLabels: MatchResourceLabelEntry[] =\n      config.getOptionalConfigArray('matchingResourceLabels')?.map(mrl => {\n        return { key: mrl.getString('key'), value: mrl.getString('value') };\n      }) ?? [];\n\n    const storeAuthProviderString =\n      config.getOptionalString('authProvider') === 'googleServiceAccount'\n        ? 'googleServiceAccount'\n        : 'google';\n\n    const options = {\n      projectId: config.getString('projectId'),\n      authProvider: storeAuthProviderString,\n      region: config.getOptionalString('region') ?? '-',\n      skipTLSVerify: config.getOptionalBoolean('skipTLSVerify') ?? false,\n      skipMetricsLookup:\n        config.getOptionalBoolean('skipMetricsLookup') ?? false,\n      exposeDashboard: config.getOptionalBoolean('exposeDashboard') ?? false,\n      matchingResourceLabels,\n    };\n    const gkeClusterLocator = new GkeClusterLocator(options, client);\n    if (refreshInterval) {\n      runPeriodically(\n        () => gkeClusterLocator.refreshClusters(),\n        refreshInterval.toMillis(),\n      );\n    }\n    return gkeClusterLocator;\n  }\n\n  // Added an `x-goog-api-client` header to API requests made by the GKE cluster locator to clearly identify API requests from this plugin.\n  static fromConfig(\n    config: Config,\n    refreshInterval: Duration | undefined = undefined,\n  ): GkeClusterLocator {\n    return GkeClusterLocator.fromConfigWithClient(\n      config,\n      new container.v1.ClusterManagerClient({\n        libName: `backstage/kubernetes-backend.GkeClusterLocator`,\n        libVersion: packageinfo.version,\n      }),\n      refreshInterval,\n    );\n  }\n\n  async getClusters(): Promise<ClusterDetails[]> {\n    if (!this.hasClusterDetails) {\n      // refresh at least once when first called, when retries are disabled and in tests\n      await this.refreshClusters();\n    }\n    return this.clusterDetails ?? [];\n  }\n\n  // TODO pass caData into the object\n  async refreshClusters(): Promise<void> {\n    const {\n      projectId,\n      region,\n      authProvider,\n      skipTLSVerify,\n      skipMetricsLookup,\n      exposeDashboard,\n      matchingResourceLabels,\n    } = this.options;\n    const request = {\n      parent: `projects/${projectId}/locations/${region}`,\n    };\n\n    try {\n      const [response] = await this.client.listClusters(request);\n      this.clusterDetails = (response.clusters ?? [])\n        .filter(r => {\n          return matchingResourceLabels?.every(mrl => {\n            if (!r.resourceLabels) {\n              return false;\n            }\n            return r.resourceLabels[mrl.key] === mrl.value;\n          });\n        })\n        .map(r => ({\n          // TODO filter out clusters which don't have name or endpoint\n          name: r.name ?? 'unknown',\n          url: `https://${r.endpoint ?? ''}`,\n          authMetadata: { [ANNOTATION_KUBERNETES_AUTH_PROVIDER]: authProvider },\n          skipTLSVerify,\n          skipMetricsLookup,\n          ...(exposeDashboard\n            ? {\n                dashboardApp: 'gke',\n                dashboardParameters: {\n                  projectId,\n                  region,\n                  clusterName: r.name,\n                },\n              }\n            : {}),\n        }));\n      this.hasClusterDetails = true;\n    } catch (e) {\n      throw new ForwardedError(\n        `There was an error retrieving clusters from GKE for projectId=${projectId} region=${region}`,\n        e,\n      );\n    }\n  }\n}\n"],"names":["runPeriodically","container","packageinfo","ANNOTATION_KUBERNETES_AUTH_PROVIDER","ForwardedError"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCO,MAAM,iBAAwD,CAAA;AAAA,EACnE,YACmB,OACA,EAAA,MAAA,EACT,cAA+C,GAAA,KAAA,CAAA,EAC/C,oBAA6B,KACrC,EAAA;AAJiB,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACT,IAAA,IAAA,CAAA,cAAA,GAAA,cAAA,CAAA;AACA,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA,CAAA;AAAA,GACP;AAAA,EAEH,OAAO,oBAAA,CACL,MACA,EAAA,MAAA,EACA,eACmB,EAAA;AACnB,IAAA,MAAM,yBACJ,MAAO,CAAA,sBAAA,CAAuB,wBAAwB,CAAA,EAAG,IAAI,CAAO,GAAA,KAAA;AAClE,MAAO,OAAA,EAAE,GAAK,EAAA,GAAA,CAAI,SAAU,CAAA,KAAK,GAAG,KAAO,EAAA,GAAA,CAAI,SAAU,CAAA,OAAO,CAAE,EAAA,CAAA;AAAA,KACnE,KAAK,EAAC,CAAA;AAET,IAAA,MAAM,0BACJ,MAAO,CAAA,iBAAA,CAAkB,cAAc,CAAA,KAAM,yBACzC,sBACA,GAAA,QAAA,CAAA;AAEN,IAAA,MAAM,OAAU,GAAA;AAAA,MACd,SAAA,EAAW,MAAO,CAAA,SAAA,CAAU,WAAW,CAAA;AAAA,MACvC,YAAc,EAAA,uBAAA;AAAA,MACd,MAAQ,EAAA,MAAA,CAAO,iBAAkB,CAAA,QAAQ,CAAK,IAAA,GAAA;AAAA,MAC9C,aAAe,EAAA,MAAA,CAAO,kBAAmB,CAAA,eAAe,CAAK,IAAA,KAAA;AAAA,MAC7D,iBACE,EAAA,MAAA,CAAO,kBAAmB,CAAA,mBAAmB,CAAK,IAAA,KAAA;AAAA,MACpD,eAAiB,EAAA,MAAA,CAAO,kBAAmB,CAAA,iBAAiB,CAAK,IAAA,KAAA;AAAA,MACjE,sBAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,iBAAoB,GAAA,IAAI,iBAAkB,CAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAC/D,IAAA,IAAI,eAAiB,EAAA;AACnB,MAAAA,+BAAA;AAAA,QACE,MAAM,kBAAkB,eAAgB,EAAA;AAAA,QACxC,gBAAgB,QAAS,EAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AACA,IAAO,OAAA,iBAAA,CAAA;AAAA,GACT;AAAA;AAAA,EAGA,OAAO,UAAA,CACL,MACA,EAAA,eAAA,GAAwC,KACrB,CAAA,EAAA;AACnB,IAAA,OAAO,iBAAkB,CAAA,oBAAA;AAAA,MACvB,MAAA;AAAA,MACA,IAAIC,oBAAU,CAAA,EAAA,CAAG,oBAAqB,CAAA;AAAA,QACpC,OAAS,EAAA,CAAA,8CAAA,CAAA;AAAA,QACT,YAAYC,gBAAY,CAAA,OAAA;AAAA,OACzB,CAAA;AAAA,MACD,eAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,WAAyC,GAAA;AAC7C,IAAI,IAAA,CAAC,KAAK,iBAAmB,EAAA;AAE3B,MAAA,MAAM,KAAK,eAAgB,EAAA,CAAA;AAAA,KAC7B;AACA,IAAO,OAAA,IAAA,CAAK,kBAAkB,EAAC,CAAA;AAAA,GACjC;AAAA;AAAA,EAGA,MAAM,eAAiC,GAAA;AACrC,IAAM,MAAA;AAAA,MACJ,SAAA;AAAA,MACA,MAAA;AAAA,MACA,YAAA;AAAA,MACA,aAAA;AAAA,MACA,iBAAA;AAAA,MACA,eAAA;AAAA,MACA,sBAAA;AAAA,QACE,IAAK,CAAA,OAAA,CAAA;AACT,IAAA,MAAM,OAAU,GAAA;AAAA,MACd,MAAQ,EAAA,CAAA,SAAA,EAAY,SAAS,CAAA,WAAA,EAAc,MAAM,CAAA,CAAA;AAAA,KACnD,CAAA;AAEA,IAAI,IAAA;AACF,MAAA,MAAM,CAAC,QAAQ,CAAA,GAAI,MAAM,IAAK,CAAA,MAAA,CAAO,aAAa,OAAO,CAAA,CAAA;AACzD,MAAA,IAAA,CAAK,kBAAkB,QAAS,CAAA,QAAA,IAAY,EAAC,EAC1C,OAAO,CAAK,CAAA,KAAA;AACX,QAAO,OAAA,sBAAA,EAAwB,MAAM,CAAO,GAAA,KAAA;AAC1C,UAAI,IAAA,CAAC,EAAE,cAAgB,EAAA;AACrB,YAAO,OAAA,KAAA,CAAA;AAAA,WACT;AACA,UAAA,OAAO,CAAE,CAAA,cAAA,CAAe,GAAI,CAAA,GAAG,MAAM,GAAI,CAAA,KAAA,CAAA;AAAA,SAC1C,CAAA,CAAA;AAAA,OACF,CACA,CAAA,GAAA,CAAI,CAAM,CAAA,MAAA;AAAA;AAAA,QAET,IAAA,EAAM,EAAE,IAAQ,IAAA,SAAA;AAAA,QAChB,GAAK,EAAA,CAAA,QAAA,EAAW,CAAE,CAAA,QAAA,IAAY,EAAE,CAAA,CAAA;AAAA,QAChC,YAAc,EAAA,EAAE,CAACC,0DAAmC,GAAG,YAAa,EAAA;AAAA,QACpE,aAAA;AAAA,QACA,iBAAA;AAAA,QACA,GAAI,eACA,GAAA;AAAA,UACE,YAAc,EAAA,KAAA;AAAA,UACd,mBAAqB,EAAA;AAAA,YACnB,SAAA;AAAA,YACA,MAAA;AAAA,YACA,aAAa,CAAE,CAAA,IAAA;AAAA,WACjB;AAAA,YAEF,EAAC;AAAA,OACL,CAAA,CAAA,CAAA;AACJ,MAAA,IAAA,CAAK,iBAAoB,GAAA,IAAA,CAAA;AAAA,aAClB,CAAG,EAAA;AACV,MAAA,MAAM,IAAIC,qBAAA;AAAA,QACR,CAAA,8DAAA,EAAiE,SAAS,CAAA,QAAA,EAAW,MAAM,CAAA,CAAA;AAAA,QAC3F,CAAA;AAAA,OACF,CAAA;AAAA,KACF;AAAA,GACF;AACF;;;;"}

package/dist/cluster-locator/LocalKubectlProxyLocator.cjs.js

@@ -0,0 +1,35 @@
+'use strict';
+
+var pluginKubernetesCommon = require('@backstage/plugin-kubernetes-common');
+var dns = require('node:dns');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var dns__default = /*#__PURE__*/_interopDefaultCompat(dns);
+
+class LocalKubectlProxyClusterLocator {
+  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]
+  lookupPromise = dns__default.default.promises.lookup("localhost", { verbatim: false });
+  constructor() {
+    this.clusterDetails = [
+      {
+        name: "local",
+        url: "http://localhost:8001",
+        authMetadata: {
+          [pluginKubernetesCommon.ANNOTATION_KUBERNETES_AUTH_PROVIDER]: "localKubectlProxy"
+        },
+        skipMetricsLookup: true
+      }
+    ];
+  }
+  async getClusters() {
+    const lookupResolution = await this.lookupPromise;
+    this.clusterDetails[0].url = `http://${lookupResolution.address}:8001`;
+    return this.clusterDetails;
+  }
+}
+
+exports.LocalKubectlProxyClusterLocator = LocalKubectlProxyClusterLocator;
+//# sourceMappingURL=LocalKubectlProxyLocator.cjs.js.map

package/dist/cluster-locator/LocalKubectlProxyLocator.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalKubectlProxyLocator.cjs.js","sources":["../../src/cluster-locator/LocalKubectlProxyLocator.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { ANNOTATION_KUBERNETES_AUTH_PROVIDER } from '@backstage/plugin-kubernetes-common';\nimport {\n  ClusterDetails,\n  KubernetesClustersSupplier,\n} from '@backstage/plugin-kubernetes-node';\nimport dns from 'node:dns';\n\nexport class LocalKubectlProxyClusterLocator\n  implements KubernetesClustersSupplier\n{\n  private readonly clusterDetails: ClusterDetails[];\n  // verbatim: when false, IPv4 addresses are placed before IPv6 addresses, ignoring the order from the DNS resolver\n  // By default kubectl proxy listens on 127.0.0.1 instead of [::1]\n  private lookupPromise = dns.promises.lookup('localhost', { verbatim: false });\n\n  public constructor() {\n    this.clusterDetails = [\n      {\n        name: 'local',\n        url: 'http://localhost:8001',\n        authMetadata: {\n          [ANNOTATION_KUBERNETES_AUTH_PROVIDER]: 'localKubectlProxy',\n        },\n        skipMetricsLookup: true,\n      },\n    ];\n  }\n\n  async getClusters(): Promise<ClusterDetails[]> {\n    const lookupResolution = await this.lookupPromise;\n    this.clusterDetails[0].url = `http://${lookupResolution.address}:8001`;\n    return this.clusterDetails;\n  }\n}\n"],"names":["dns","ANNOTATION_KUBERNETES_AUTH_PROVIDER"],"mappings":";;;;;;;;;AAuBO,MAAM,+BAEb,CAAA;AAAA,EACmB,cAAA,CAAA;AAAA;AAAA;AAAA,EAGT,aAAA,GAAgBA,qBAAI,QAAS,CAAA,MAAA,CAAO,aAAa,EAAE,QAAA,EAAU,OAAO,CAAA,CAAA;AAAA,EAErE,WAAc,GAAA;AACnB,IAAA,IAAA,CAAK,cAAiB,GAAA;AAAA,MACpB;AAAA,QACE,IAAM,EAAA,OAAA;AAAA,QACN,GAAK,EAAA,uBAAA;AAAA,QACL,YAAc,EAAA;AAAA,UACZ,CAACC,0DAAmC,GAAG,mBAAA;AAAA,SACzC;AAAA,QACA,iBAAmB,EAAA,IAAA;AAAA,OACrB;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,WAAyC,GAAA;AAC7C,IAAM,MAAA,gBAAA,GAAmB,MAAM,IAAK,CAAA,aAAA,CAAA;AACpC,IAAA,IAAA,CAAK,eAAe,CAAC,CAAA,CAAE,GAAM,GAAA,CAAA,OAAA,EAAU,iBAAiB,OAAO,CAAA,KAAA,CAAA,CAAA;AAC/D,IAAA,OAAO,IAAK,CAAA,cAAA,CAAA;AAAA,GACd;AACF;;;;"}

package/dist/cluster-locator/index.cjs.js

@@ -0,0 +1,67 @@
+'use strict';
+
+var ConfigClusterLocator = require('./ConfigClusterLocator.cjs.js');
+var GkeClusterLocator = require('./GkeClusterLocator.cjs.js');
+var CatalogClusterLocator = require('./CatalogClusterLocator.cjs.js');
+var LocalKubectlProxyLocator = require('./LocalKubectlProxyLocator.cjs.js');
+
+class CombinedClustersSupplier {
+  constructor(clusterSuppliers, logger) {
+    this.clusterSuppliers = clusterSuppliers;
+    this.logger = logger;
+  }
+  async getClusters(options) {
+    const clusters = await Promise.all(
+      this.clusterSuppliers.map((supplier) => supplier.getClusters(options))
+    ).then((res) => {
+      return res.flat();
+    }).catch((e) => {
+      throw e;
+    });
+    return this.warnDuplicates(clusters);
+  }
+  warnDuplicates(clusters) {
+    const clusterNames = /* @__PURE__ */ new Set();
+    const duplicatedNames = /* @__PURE__ */ new Set();
+    for (const clusterName of clusters.map((c) => c.name)) {
+      if (clusterNames.has(clusterName)) {
+        duplicatedNames.add(clusterName);
+      } else {
+        clusterNames.add(clusterName);
+      }
+    }
+    for (const clusterName of duplicatedNames) {
+      this.logger.warn(`Duplicate cluster name '${clusterName}'`);
+    }
+    return clusters;
+  }
+}
+const getCombinedClusterSupplier = (rootConfig, catalogClient, authStrategy, logger, refreshInterval = void 0, auth) => {
+  const clusterSuppliers = rootConfig.getConfigArray("kubernetes.clusterLocatorMethods").map((clusterLocatorMethod) => {
+    const type = clusterLocatorMethod.getString("type");
+    switch (type) {
+      case "catalog":
+        return CatalogClusterLocator.CatalogClusterLocator.fromConfig(catalogClient, auth);
+      case "localKubectlProxy":
+        return new LocalKubectlProxyLocator.LocalKubectlProxyClusterLocator();
+      case "config":
+        return ConfigClusterLocator.ConfigClusterLocator.fromConfig(
+          clusterLocatorMethod,
+          authStrategy
+        );
+      case "gke":
+        return GkeClusterLocator.GkeClusterLocator.fromConfig(
+          clusterLocatorMethod,
+          refreshInterval
+        );
+      default:
+        throw new Error(
+          `Unsupported kubernetes.clusterLocatorMethods: "${type}"`
+        );
+    }
+  });
+  return new CombinedClustersSupplier(clusterSuppliers, logger);
+};
+
+exports.getCombinedClusterSupplier = getCombinedClusterSupplier;
+//# sourceMappingURL=index.cjs.js.map

package/dist/cluster-locator/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../../src/cluster-locator/index.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { CatalogApi } from '@backstage/catalog-client';\nimport { Config } from '@backstage/config';\nimport { Duration } from 'luxon';\nimport { ClusterDetails, KubernetesClustersSupplier } from '../types/types';\nimport { AuthenticationStrategy } from '../auth/types';\nimport { ConfigClusterLocator } from './ConfigClusterLocator';\nimport { GkeClusterLocator } from './GkeClusterLocator';\nimport { CatalogClusterLocator } from './CatalogClusterLocator';\nimport { LocalKubectlProxyClusterLocator } from './LocalKubectlProxyLocator';\nimport {\n  AuthService,\n  BackstageCredentials,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\n\nclass CombinedClustersSupplier implements KubernetesClustersSupplier {\n  constructor(\n    readonly clusterSuppliers: KubernetesClustersSupplier[],\n    readonly logger: LoggerService,\n  ) {}\n\n  async getClusters(options: {\n    credentials: BackstageCredentials;\n  }): Promise<ClusterDetails[]> {\n    const clusters = await Promise.all(\n      this.clusterSuppliers.map(supplier => supplier.getClusters(options)),\n    )\n      .then(res => {\n        return res.flat();\n      })\n      .catch(e => {\n        throw e;\n      });\n    return this.warnDuplicates(clusters);\n  }\n\n  private warnDuplicates(clusters: ClusterDetails[]): ClusterDetails[] {\n    const clusterNames = new Set<string>();\n    const duplicatedNames = new Set<string>();\n    for (const clusterName of clusters.map(c => c.name)) {\n      if (clusterNames.has(clusterName)) {\n        duplicatedNames.add(clusterName);\n      } else {\n        clusterNames.add(clusterName);\n      }\n    }\n    for (const clusterName of duplicatedNames) {\n      this.logger.warn(`Duplicate cluster name '${clusterName}'`);\n    }\n    return clusters;\n  }\n}\n\nexport const getCombinedClusterSupplier = (\n  rootConfig: Config,\n  catalogClient: CatalogApi,\n  authStrategy: AuthenticationStrategy,\n  logger: LoggerService,\n  refreshInterval: Duration | undefined = undefined,\n  auth: AuthService,\n): KubernetesClustersSupplier => {\n  const clusterSuppliers = rootConfig\n    .getConfigArray('kubernetes.clusterLocatorMethods')\n    .map(clusterLocatorMethod => {\n      const type = clusterLocatorMethod.getString('type');\n      switch (type) {\n        case 'catalog':\n          return CatalogClusterLocator.fromConfig(catalogClient, auth);\n        case 'localKubectlProxy':\n          return new LocalKubectlProxyClusterLocator();\n        case 'config':\n          return ConfigClusterLocator.fromConfig(\n            clusterLocatorMethod,\n            authStrategy,\n          );\n        case 'gke':\n          return GkeClusterLocator.fromConfig(\n            clusterLocatorMethod,\n            refreshInterval,\n          );\n        default:\n          throw new Error(\n            `Unsupported kubernetes.clusterLocatorMethods: \"${type}\"`,\n          );\n      }\n    });\n\n  return new CombinedClustersSupplier(clusterSuppliers, logger);\n};\n"],"names":["CatalogClusterLocator","LocalKubectlProxyClusterLocator","ConfigClusterLocator","GkeClusterLocator"],"mappings":";;;;;;;AA+BA,MAAM,wBAA+D,CAAA;AAAA,EACnE,WAAA,CACW,kBACA,MACT,EAAA;AAFS,IAAA,IAAA,CAAA,gBAAA,GAAA,gBAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GACR;AAAA,EAEH,MAAM,YAAY,OAEY,EAAA;AAC5B,IAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC7B,KAAK,gBAAiB,CAAA,GAAA,CAAI,cAAY,QAAS,CAAA,WAAA,CAAY,OAAO,CAAC,CAAA;AAAA,KACrE,CACG,KAAK,CAAO,GAAA,KAAA;AACX,MAAA,OAAO,IAAI,IAAK,EAAA,CAAA;AAAA,KACjB,CACA,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACV,MAAM,MAAA,CAAA,CAAA;AAAA,KACP,CAAA,CAAA;AACH,IAAO,OAAA,IAAA,CAAK,eAAe,QAAQ,CAAA,CAAA;AAAA,GACrC;AAAA,EAEQ,eAAe,QAA8C,EAAA;AACnE,IAAM,MAAA,YAAA,uBAAmB,GAAY,EAAA,CAAA;AACrC,IAAM,MAAA,eAAA,uBAAsB,GAAY,EAAA,CAAA;AACxC,IAAA,KAAA,MAAW,eAAe,QAAS,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,IAAI,CAAG,EAAA;AACnD,MAAI,IAAA,YAAA,CAAa,GAAI,CAAA,WAAW,CAAG,EAAA;AACjC,QAAA,eAAA,CAAgB,IAAI,WAAW,CAAA,CAAA;AAAA,OAC1B,MAAA;AACL,QAAA,YAAA,CAAa,IAAI,WAAW,CAAA,CAAA;AAAA,OAC9B;AAAA,KACF;AACA,IAAA,KAAA,MAAW,eAAe,eAAiB,EAAA;AACzC,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA2B,wBAAA,EAAA,WAAW,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,KAC5D;AACA,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AACF,CAAA;AAEa,MAAA,0BAAA,GAA6B,CACxC,UACA,EAAA,aAAA,EACA,cACA,MACA,EAAA,eAAA,GAAwC,QACxC,IAC+B,KAAA;AAC/B,EAAA,MAAM,mBAAmB,UACtB,CAAA,cAAA,CAAe,kCAAkC,CAAA,CACjD,IAAI,CAAwB,oBAAA,KAAA;AAC3B,IAAM,MAAA,IAAA,GAAO,oBAAqB,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AAClD,IAAA,QAAQ,IAAM;AAAA,MACZ,KAAK,SAAA;AACH,QAAO,OAAAA,2CAAA,CAAsB,UAAW,CAAA,aAAA,EAAe,IAAI,CAAA,CAAA;AAAA,MAC7D,KAAK,mBAAA;AACH,QAAA,OAAO,IAAIC,wDAAgC,EAAA,CAAA;AAAA,MAC7C,KAAK,QAAA;AACH,QAAA,OAAOC,yCAAqB,CAAA,UAAA;AAAA,UAC1B,oBAAA;AAAA,UACA,YAAA;AAAA,SACF,CAAA;AAAA,MACF,KAAK,KAAA;AACH,QAAA,OAAOC,mCAAkB,CAAA,UAAA;AAAA,UACvB,oBAAA;AAAA,UACA,eAAA;AAAA,SACF,CAAA;AAAA,MACF;AACE,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,kDAAkD,IAAI,CAAA,CAAA,CAAA;AAAA,SACxD,CAAA;AAAA,KACJ;AAAA,GACD,CAAA,CAAA;AAEH,EAAO,OAAA,IAAI,wBAAyB,CAAA,gBAAA,EAAkB,MAAM,CAAA,CAAA;AAC9D;;;;"}