@backstage/plugin-catalog-backend-module-gcp 0.0.0-nightly-20230728021812

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# @backstage/plugin-catalog-backend-module-gcp
+
+## 0.0.0-nightly-20230728021812
+
+### Minor Changes
+
+- 290eff6692aa: Added GCP catalog plugin with GKE provider
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.0.0-nightly-20230728021812
+  - @backstage/backend-plugin-api@0.0.0-nightly-20230728021812
+  - @backstage/backend-tasks@0.0.0-nightly-20230728021812
+  - @backstage/config@1.0.8
+  - @backstage/plugin-catalog-node@0.0.0-nightly-20230728021812
+  - @backstage/plugin-kubernetes-common@0.6.5

package/README.md

@@ -0,0 +1,41 @@
+# Catalog Backend Module for GCP
+
+This is an extension module to the plugin-catalog-backend plugin, containing catalog processors and providers to ingest GCP resources as `Resource` kind entities.
+
+## installation
+
+Register the plugin in `catalog.ts``
+
+```typescript
+import { GkeEntityProvider } from '@backstage/plugin-catalog-backend-module-gcp';
+
+...
+
+builder.addEntityProvider(
+  GkeEntityProvider.fromConfig({
+    logger: env.logger,
+    scheduler: env.scheduler,
+    config: env.config
+  })
+);
+```
+
+Update `app-config.yaml` as follows:
+
+```yaml
+catalog:
+  providers:
+    gcp:
+      gke:
+        parents:
+          # consult https://cloud.google.com/kubernetes-engine/docs/ for valid values
+          # list all clusters in the project
+          - 'projects/some-project/locations/-'
+          # list all clusters in the region, in the project
+          - 'projects/some-other-project/locations/some-region'
+        schedule: # optional; same options as in TaskScheduleDefinition
+          # supports cron, ISO duration, "human duration" as used in code
+          frequency: { minutes: 30 }
+          # supports ISO duration, "human duration" as used in code
+          timeout: { minutes: 3 }
+```

package/alpha/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/plugin-catalog-backend-module-gcp",
+  "version": "0.0.0-nightly-20230728021812",
+  "main": "../dist/alpha.cjs.js",
+  "types": "../dist/alpha.d.ts"
+}

package/config.d.ts

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TaskScheduleDefinitionConfig } from '@backstage/backend-tasks';
+
+export interface Config {
+  catalog?: {
+    /**
+     * List of provider-specific options and attributes
+     */
+    providers?: {
+      /**
+       * GCPCatalogModuleConfig configuration
+       */
+      gcp?: {
+        /**
+         * Config for GKE clusters
+         */
+        gke?: {
+          /**
+           * Locations to list clusters from
+           */
+          parents: string[];
+          /**
+           * (Optional) TaskScheduleDefinition for the refresh.
+           */
+          schedule: TaskScheduleDefinitionConfig;
+        };
+      };
+    };
+  };
+}

package/dist/alpha.cjs.js

@@ -0,0 +1,3 @@
+'use strict';
+
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/alpha.d.ts

@@ -0,0 +1 @@
+

package/dist/index.cjs.js

@@ -0,0 +1,204 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendTasks = require('@backstage/backend-tasks');
+var container = require('@google-cloud/container');
+var pluginKubernetesCommon = require('@backstage/plugin-kubernetes-common');
+var backendCommon = require('@backstage/backend-common');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) 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__*/_interopNamespace(container);
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class GkeEntityProvider {
+  constructor(logger, taskRunner, gkeParents, clusterManagerClient) {
+    __publicField(this, "logger");
+    __publicField(this, "scheduleFn");
+    __publicField(this, "gkeParents");
+    __publicField(this, "clusterManagerClient");
+    __publicField(this, "connection");
+    this.logger = logger;
+    this.scheduleFn = this.createScheduleFn(taskRunner);
+    this.gkeParents = gkeParents;
+    this.clusterManagerClient = clusterManagerClient;
+  }
+  static fromConfig({
+    logger,
+    scheduler,
+    config
+  }) {
+    return GkeEntityProvider.fromConfigWithClient({
+      logger,
+      scheduler,
+      config,
+      clusterManagerClient: new container__namespace.v1.ClusterManagerClient()
+    });
+  }
+  static fromConfigWithClient({
+    logger,
+    scheduler,
+    config,
+    clusterManagerClient
+  }) {
+    const gkeProviderConfig = config.getConfig("catalog.providers.gcp.gke");
+    const schedule = backendTasks.readTaskScheduleDefinitionFromConfig(
+      gkeProviderConfig.getConfig("schedule")
+    );
+    return new GkeEntityProvider(
+      logger,
+      scheduler.createScheduledTaskRunner(schedule),
+      gkeProviderConfig.getStringArray("parents"),
+      clusterManagerClient
+    );
+  }
+  getProviderName() {
+    return `gcp-gke`;
+  }
+  async connect(connection) {
+    this.connection = connection;
+    await this.scheduleFn();
+  }
+  filterOutUndefinedDeferredEntity(e) {
+    return e !== void 0;
+  }
+  filterOutUndefinedCluster(c) {
+    return c !== void 0 && c !== null;
+  }
+  clusterToResource(cluster) {
+    var _a;
+    const location = `${this.getProviderName()}:${cluster.location}`;
+    if (!cluster.name || !cluster.selfLink || !location || !cluster.endpoint) {
+      this.logger.warn(
+        `ignoring partial cluster, one of name=${cluster.name}, endpoint=${cluster.endpoint}, selfLink=${cluster.selfLink} or location=${cluster.location} is missing`
+      );
+      return void 0;
+    }
+    return {
+      locationKey: location,
+      entity: {
+        apiVersion: "backstage.io/v1alpha1",
+        kind: "Resource",
+        metadata: {
+          annotations: {
+            [pluginKubernetesCommon.ANNOTATION_KUBERNETES_API_SERVER]: cluster.endpoint,
+            [pluginKubernetesCommon.ANNOTATION_KUBERNETES_API_SERVER_CA]: ((_a = cluster.masterAuth) == null ? void 0 : _a.clusterCaCertificate) || "",
+            [pluginKubernetesCommon.ANNOTATION_KUBERNETES_AUTH_PROVIDER]: "google",
+            "backstage.io/managed-by-location": location,
+            "backstage.io/managed-by-origin-location": location
+          },
+          name: cluster.name,
+          namespace: "default"
+        },
+        spec: {
+          type: "kubernetes-cluster",
+          owner: "unknown"
+        }
+      }
+    };
+  }
+  createScheduleFn(taskRunner) {
+    return async () => {
+      const taskId = `${this.getProviderName()}:refresh`;
+      return taskRunner.run({
+        id: taskId,
+        fn: async () => {
+          try {
+            await this.refresh();
+          } catch (error) {
+            this.logger.error(error);
+          }
+        }
+      });
+    };
+  }
+  async getClusters() {
+    const clusters = await Promise.all(
+      this.gkeParents.map(async (parent) => {
+        var _a, _b;
+        const request = {
+          parent
+        };
+        const [response] = await this.clusterManagerClient.listClusters(
+          request
+        );
+        return (_b = (_a = response.clusters) == null ? void 0 : _a.filter(this.filterOutUndefinedCluster)) != null ? _b : [];
+      })
+    );
+    return clusters.flat();
+  }
+  async refresh() {
+    var _a;
+    if (!this.connection) {
+      throw new Error("Not initialized");
+    }
+    this.logger.info("Discovering GKE clusters");
+    let clusters;
+    try {
+      clusters = await this.getClusters();
+    } catch (e) {
+      this.logger.error("error fetching GKE clusters", e);
+      return;
+    }
+    const resources = (_a = clusters.map((c) => this.clusterToResource(c)).filter(this.filterOutUndefinedDeferredEntity)) != null ? _a : [];
+    this.logger.info(
+      `Ingesting GKE clusters [${resources.map((r) => r.entity.metadata.name).join(", ")}]`
+    );
+    await this.connection.applyMutation({
+      type: "full",
+      entities: resources
+    });
+  }
+}
+
+const catalogModuleGcpGkeEntityProvider = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "gcpGkeEntityProvider",
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.coreServices.config,
+        catalog: alpha.catalogProcessingExtensionPoint,
+        logger: backendPluginApi.coreServices.logger,
+        scheduler: backendPluginApi.coreServices.scheduler
+      },
+      async init({ config, catalog, logger, scheduler }) {
+        catalog.addEntityProvider(
+          GkeEntityProvider.fromConfig({
+            logger: backendCommon.loggerToWinstonLogger(logger),
+            scheduler,
+            config
+          })
+        );
+      }
+    });
+  }
+});
+
+exports.GkeEntityProvider = GkeEntityProvider;
+exports.catalogModuleGcpGkeEntityProvider = catalogModuleGcpGkeEntityProvider;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/providers/GkeEntityProvider.ts","../src/module/catalogModuleGcpGkeEntityProvider.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 */\nimport {\n  TaskRunner,\n  readTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-tasks';\nimport {\n  DeferredEntity,\n  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\n\nimport { Logger } from 'winston';\nimport * as container from '@google-cloud/container';\nimport {\n  ANNOTATION_KUBERNETES_API_SERVER,\n  ANNOTATION_KUBERNETES_API_SERVER_CA,\n  ANNOTATION_KUBERNETES_AUTH_PROVIDER,\n} from '@backstage/plugin-kubernetes-common';\nimport { Config } from '@backstage/config';\nimport { SchedulerService } from '@backstage/backend-plugin-api';\n\n/**\n * Catalog provider to ingest GKE clusters\n *\n * @public\n */\nexport class GkeEntityProvider implements EntityProvider {\n  private readonly logger: Logger;\n  private readonly scheduleFn: () => Promise<void>;\n  private readonly gkeParents: string[];\n  private readonly clusterManagerClient: container.v1.ClusterManagerClient;\n  private connection?: EntityProviderConnection;\n\n  private constructor(\n    logger: Logger,\n    taskRunner: TaskRunner,\n    gkeParents: string[],\n    clusterManagerClient: container.v1.ClusterManagerClient,\n  ) {\n    this.logger = logger;\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n    this.gkeParents = gkeParents;\n    this.clusterManagerClient = clusterManagerClient;\n  }\n\n  public static fromConfig({\n    logger,\n    scheduler,\n    config,\n  }: {\n    logger: Logger;\n    scheduler: SchedulerService;\n    config: Config;\n  }) {\n    return GkeEntityProvider.fromConfigWithClient({\n      logger,\n      scheduler: scheduler,\n      config,\n      clusterManagerClient: new container.v1.ClusterManagerClient(),\n    });\n  }\n\n  public static fromConfigWithClient({\n    logger,\n    scheduler,\n    config,\n    clusterManagerClient,\n  }: {\n    logger: Logger;\n    scheduler: SchedulerService;\n    config: Config;\n    clusterManagerClient: container.v1.ClusterManagerClient;\n  }) {\n    const gkeProviderConfig = config.getConfig('catalog.providers.gcp.gke');\n    const schedule = readTaskScheduleDefinitionFromConfig(\n      gkeProviderConfig.getConfig('schedule'),\n    );\n    return new GkeEntityProvider(\n      logger,\n      scheduler.createScheduledTaskRunner(schedule),\n      gkeProviderConfig.getStringArray('parents'),\n      clusterManagerClient,\n    );\n  }\n\n  getProviderName(): string {\n    return `gcp-gke`;\n  }\n\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    await this.scheduleFn();\n  }\n\n  private filterOutUndefinedDeferredEntity(\n    e: DeferredEntity | undefined,\n  ): e is DeferredEntity {\n    return e !== undefined;\n  }\n\n  private filterOutUndefinedCluster(\n    c: container.protos.google.container.v1.ICluster | null | undefined,\n  ): c is container.protos.google.container.v1.ICluster {\n    return c !== undefined && c !== null;\n  }\n\n  private clusterToResource(\n    cluster: container.protos.google.container.v1.ICluster,\n  ): DeferredEntity | undefined {\n    const location = `${this.getProviderName()}:${cluster.location}`;\n\n    if (!cluster.name || !cluster.selfLink || !location || !cluster.endpoint) {\n      this.logger.warn(\n        `ignoring partial cluster, one of name=${cluster.name}, endpoint=${cluster.endpoint}, selfLink=${cluster.selfLink} or location=${cluster.location} is missing`,\n      );\n      return undefined;\n    }\n\n    // TODO fix location type\n    return {\n      locationKey: location,\n      entity: {\n        apiVersion: 'backstage.io/v1alpha1',\n        kind: 'Resource',\n        metadata: {\n          annotations: {\n            [ANNOTATION_KUBERNETES_API_SERVER]: cluster.endpoint,\n            [ANNOTATION_KUBERNETES_API_SERVER_CA]:\n              cluster.masterAuth?.clusterCaCertificate || '',\n            [ANNOTATION_KUBERNETES_AUTH_PROVIDER]: 'google',\n            'backstage.io/managed-by-location': location,\n            'backstage.io/managed-by-origin-location': location,\n          },\n          name: cluster.name,\n          namespace: 'default',\n        },\n        spec: {\n          type: 'kubernetes-cluster',\n          owner: 'unknown',\n        },\n      },\n    };\n  }\n\n  private createScheduleFn(taskRunner: TaskRunner): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return taskRunner.run({\n        id: taskId,\n        fn: async () => {\n          try {\n            await this.refresh();\n          } catch (error) {\n            this.logger.error(error);\n          }\n        },\n      });\n    };\n  }\n\n  private async getClusters(): Promise<\n    container.protos.google.container.v1.ICluster[]\n  > {\n    const clusters = await Promise.all(\n      this.gkeParents.map(async parent => {\n        const request = {\n          parent: parent,\n        };\n        const [response] = await this.clusterManagerClient.listClusters(\n          request,\n        );\n        return response.clusters?.filter(this.filterOutUndefinedCluster) ?? [];\n      }),\n    );\n    return clusters.flat();\n  }\n\n  async refresh() {\n    if (!this.connection) {\n      throw new Error('Not initialized');\n    }\n\n    this.logger.info('Discovering GKE clusters');\n\n    let clusters: container.protos.google.container.v1.ICluster[];\n\n    try {\n      clusters = await this.getClusters();\n    } catch (e) {\n      this.logger.error('error fetching GKE clusters', e);\n      return;\n    }\n    const resources =\n      clusters\n        .map(c => this.clusterToResource(c))\n        .filter(this.filterOutUndefinedDeferredEntity) ?? [];\n\n    this.logger.info(\n      `Ingesting GKE clusters [${resources\n        .map(r => r.entity.metadata.name)\n        .join(', ')}]`,\n    );\n\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: resources,\n    });\n  }\n}\n","/*\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 { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { GkeEntityProvider } from '../providers/GkeEntityProvider';\n\n/**\n * Registers the GcpGkeEntityProvider with the catalog processing extension point.\n *\n * @public\n */\nexport const catalogModuleGcpGkeEntityProvider = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'gcpGkeEntityProvider',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.config,\n        catalog: catalogProcessingExtensionPoint,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n      },\n      async init({ config, catalog, logger, scheduler }) {\n        catalog.addEntityProvider(\n          GkeEntityProvider.fromConfig({\n            logger: loggerToWinstonLogger(logger),\n            scheduler,\n            config,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["container","readTaskScheduleDefinitionFromConfig","ANNOTATION_KUBERNETES_API_SERVER","ANNOTATION_KUBERNETES_API_SERVER_CA","ANNOTATION_KUBERNETES_AUTH_PROVIDER","createBackendModule","coreServices","catalogProcessingExtensionPoint","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCO,MAAM,iBAA4C,CAAA;AAAA,EAO/C,WACN,CAAA,MAAA,EACA,UACA,EAAA,UAAA,EACA,oBACA,EAAA;AAXF,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,sBAAA,CAAA,CAAA;AACjB,IAAQ,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAQN,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAClD,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,IAAA,CAAK,oBAAuB,GAAA,oBAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,OAAc,UAAW,CAAA;AAAA,IACvB,MAAA;AAAA,IACA,SAAA;AAAA,IACA,MAAA;AAAA,GAKC,EAAA;AACD,IAAA,OAAO,kBAAkB,oBAAqB,CAAA;AAAA,MAC5C,MAAA;AAAA,MACA,SAAA;AAAA,MACA,MAAA;AAAA,MACA,oBAAsB,EAAA,IAAIA,oBAAU,CAAA,EAAA,CAAG,oBAAqB,EAAA;AAAA,KAC7D,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,OAAc,oBAAqB,CAAA;AAAA,IACjC,MAAA;AAAA,IACA,SAAA;AAAA,IACA,MAAA;AAAA,IACA,oBAAA;AAAA,GAMC,EAAA;AACD,IAAM,MAAA,iBAAA,GAAoB,MAAO,CAAA,SAAA,CAAU,2BAA2B,CAAA,CAAA;AACtE,IAAA,MAAM,QAAW,GAAAC,iDAAA;AAAA,MACf,iBAAA,CAAkB,UAAU,UAAU,CAAA;AAAA,KACxC,CAAA;AACA,IAAA,OAAO,IAAI,iBAAA;AAAA,MACT,MAAA;AAAA,MACA,SAAA,CAAU,0BAA0B,QAAQ,CAAA;AAAA,MAC5C,iBAAA,CAAkB,eAAe,SAAS,CAAA;AAAA,MAC1C,oBAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,OAAA,CAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEQ,iCACN,CACqB,EAAA;AACrB,IAAA,OAAO,CAAM,KAAA,KAAA,CAAA,CAAA;AAAA,GACf;AAAA,EAEQ,0BACN,CACoD,EAAA;AACpD,IAAO,OAAA,CAAA,KAAM,UAAa,CAAM,KAAA,IAAA,CAAA;AAAA,GAClC;AAAA,EAEQ,kBACN,OAC4B,EAAA;AA1HhC,IAAA,IAAA,EAAA,CAAA;AA2HI,IAAA,MAAM,WAAW,CAAG,EAAA,IAAA,CAAK,iBAAiB,CAAA,CAAA,EAAI,QAAQ,QAAQ,CAAA,CAAA,CAAA;AAE9D,IAAI,IAAA,CAAC,OAAQ,CAAA,IAAA,IAAQ,CAAC,OAAA,CAAQ,YAAY,CAAC,QAAA,IAAY,CAAC,OAAA,CAAQ,QAAU,EAAA;AACxE,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAA,sCAAA,EAAyC,OAAQ,CAAA,IAAI,CAAc,WAAA,EAAA,OAAA,CAAQ,QAAQ,CAAA,WAAA,EAAc,OAAQ,CAAA,QAAQ,CAAgB,aAAA,EAAA,OAAA,CAAQ,QAAQ,CAAA,WAAA,CAAA;AAAA,OACnJ,CAAA;AACA,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AAGA,IAAO,OAAA;AAAA,MACL,WAAa,EAAA,QAAA;AAAA,MACb,MAAQ,EAAA;AAAA,QACN,UAAY,EAAA,uBAAA;AAAA,QACZ,IAAM,EAAA,UAAA;AAAA,QACN,QAAU,EAAA;AAAA,UACR,WAAa,EAAA;AAAA,YACX,CAACC,uDAAgC,GAAG,OAAQ,CAAA,QAAA;AAAA,YAC5C,CAACC,0DAAmC,GAAA,CAAA,CAClC,EAAQ,GAAA,OAAA,CAAA,UAAA,KAAR,mBAAoB,oBAAwB,KAAA,EAAA;AAAA,YAC9C,CAACC,0DAAmC,GAAG,QAAA;AAAA,YACvC,kCAAoC,EAAA,QAAA;AAAA,YACpC,yCAA2C,EAAA,QAAA;AAAA,WAC7C;AAAA,UACA,MAAM,OAAQ,CAAA,IAAA;AAAA,UACd,SAAW,EAAA,SAAA;AAAA,SACb;AAAA,QACA,IAAM,EAAA;AAAA,UACJ,IAAM,EAAA,oBAAA;AAAA,UACN,KAAO,EAAA,SAAA;AAAA,SACT;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEQ,iBAAiB,UAA6C,EAAA;AACpE,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAI,IAAA;AACF,YAAA,MAAM,KAAK,OAAQ,EAAA,CAAA;AAAA,mBACZ,KAAO,EAAA;AACd,YAAK,IAAA,CAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAAA,WACzB;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,WAEZ,GAAA;AACA,IAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC7B,IAAK,CAAA,UAAA,CAAW,GAAI,CAAA,OAAM,MAAU,KAAA;AAlL1C,QAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAmLQ,QAAA,MAAM,OAAU,GAAA;AAAA,UACd,MAAA;AAAA,SACF,CAAA;AACA,QAAA,MAAM,CAAC,QAAQ,CAAI,GAAA,MAAM,KAAK,oBAAqB,CAAA,YAAA;AAAA,UACjD,OAAA;AAAA,SACF,CAAA;AACA,QAAA,OAAA,CAAO,oBAAS,QAAT,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAmB,OAAO,IAAK,CAAA,yBAAA,CAAA,KAA/B,YAA6D,EAAC,CAAA;AAAA,OACtE,CAAA;AAAA,KACH,CAAA;AACA,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAM,OAAU,GAAA;AA/LlB,IAAA,IAAA,EAAA,CAAA;AAgMI,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,0BAA0B,CAAA,CAAA;AAE3C,IAAI,IAAA,QAAA,CAAA;AAEJ,IAAI,IAAA;AACF,MAAW,QAAA,GAAA,MAAM,KAAK,WAAY,EAAA,CAAA;AAAA,aAC3B,CAAG,EAAA;AACV,MAAK,IAAA,CAAA,MAAA,CAAO,KAAM,CAAA,6BAAA,EAA+B,CAAC,CAAA,CAAA;AAClD,MAAA,OAAA;AAAA,KACF;AACA,IAAA,MAAM,SACJ,GAAA,CAAA,EAAA,GAAA,QAAA,CACG,GAAI,CAAA,CAAA,CAAA,KAAK,KAAK,iBAAkB,CAAA,CAAC,CAAC,CAAA,CAClC,MAAO,CAAA,IAAA,CAAK,gCAAgC,CAAA,KAF/C,YAEoD,EAAC,CAAA;AAEvD,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAA,wBAAA,EAA2B,SACxB,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,MAAO,CAAA,QAAA,CAAS,IAAI,CAAA,CAC/B,IAAK,CAAA,IAAI,CAAC,CAAA,CAAA,CAAA;AAAA,KACf,CAAA;AAEA,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAU,EAAA,SAAA;AAAA,KACX,CAAA,CAAA;AAAA,GACH;AACF;;ACjMO,MAAM,oCAAoCC,oCAAoB,CAAA;AAAA,EACnE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,sBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQD,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,OAAS,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACN,kBAAkB,UAAW,CAAA;AAAA,YAC3B,MAAA,EAAQE,oCAAsB,MAAM,CAAA;AAAA,YACpC,SAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+import { EntityProvider, EntityProviderConnection } from '@backstage/plugin-catalog-node';
+import { Logger } from 'winston';
+import * as container from '@google-cloud/container';
+import { Config } from '@backstage/config';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { SchedulerService } from '@backstage/backend-plugin-api';
+
+/**
+ * Catalog provider to ingest GKE clusters
+ *
+ * @public
+ */
+declare class GkeEntityProvider implements EntityProvider {
+    private readonly logger;
+    private readonly scheduleFn;
+    private readonly gkeParents;
+    private readonly clusterManagerClient;
+    private connection?;
+    private constructor();
+    static fromConfig({ logger, scheduler, config, }: {
+        logger: Logger;
+        scheduler: SchedulerService;
+        config: Config;
+    }): GkeEntityProvider;
+    static fromConfigWithClient({ logger, scheduler, config, clusterManagerClient, }: {
+        logger: Logger;
+        scheduler: SchedulerService;
+        config: Config;
+        clusterManagerClient: container.v1.ClusterManagerClient;
+    }): GkeEntityProvider;
+    getProviderName(): string;
+    connect(connection: EntityProviderConnection): Promise<void>;
+    private filterOutUndefinedDeferredEntity;
+    private filterOutUndefinedCluster;
+    private clusterToResource;
+    private createScheduleFn;
+    private getClusters;
+    refresh(): Promise<void>;
+}
+
+/**
+ * Registers the GcpGkeEntityProvider with the catalog processing extension point.
+ *
+ * @public
+ */
+declare const catalogModuleGcpGkeEntityProvider: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { GkeEntityProvider, catalogModuleGcpGkeEntityProvider };

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@backstage/plugin-catalog-backend-module-gcp",
+  "description": "A Backstage catalog backend module that helps integrate towards GCP",
+  "version": "0.0.0-nightly-20230728021812",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./alpha": {
+      "require": "./dist/alpha.cjs.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/catalog-backend-module-gcp"
+  },
+  "keywords": [
+    "backstage"
+  ],
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "clean": "backstage-cli package clean"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20230728021812",
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20230728021812",
+    "@backstage/backend-tasks": "^0.0.0-nightly-20230728021812",
+    "@backstage/config": "^1.0.8",
+    "@backstage/plugin-catalog-node": "^0.0.0-nightly-20230728021812",
+    "@backstage/plugin-kubernetes-common": "^0.6.5",
+    "@google-cloud/container": "^4.15.0",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20230728021812",
+    "@backstage/cli": "^0.0.0-nightly-20230728021812"
+  },
+  "files": [
+    "config.d.ts",
+    "dist",
+    "alpha"
+  ],
+  "configSchema": "config.d.ts"
+}