@backstage/plugin-catalog-backend-module-gcp 0.3.2-next.1 → 0.3.2

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @backstage/plugin-catalog-backend-module-gcp
 
+## 0.3.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/config@1.3.0
+  - @backstage/plugin-kubernetes-common@0.9.0
+  - @backstage/plugin-catalog-node@1.14.0
+  - @backstage/backend-plugin-api@1.0.2
+  - @backstage/catalog-model@1.7.1
+
+## 0.3.2-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.14.0-next.2
+  - @backstage/backend-plugin-api@1.0.2-next.2
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/plugin-kubernetes-common@0.9.0-next.0
+
 ## 0.3.2-next.1
 
 ### Patch Changes

package/dist/module/catalogModuleGcpGkeEntityProvider.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"catalogModuleGcpGkeEntityProvider.cjs.js","sources":["../../src/module/catalogModuleGcpGkeEntityProvider.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  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: 'gcp-gke-entity-provider',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\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,\n            scheduler,\n            config,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","coreServices","catalogProcessingExtensionPoint","GkeEntityProvider"],"mappings":";;;;;;AA4BO,MAAM,oCAAoCA,oCAAoB,CAAA;AAAA,EACnE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,yBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;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,UACNE,oCAAkB,UAAW,CAAA;AAAA,YAC3B,MAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
+{"version":3,"file":"catalogModuleGcpGkeEntityProvider.cjs.js","sources":["../../src/module/catalogModuleGcpGkeEntityProvider.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  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: 'gcp-gke-entity-provider',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\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,\n            scheduler,\n            config,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","coreServices","catalogProcessingExtensionPoint","GkeEntityProvider"],"mappings":";;;;;;AA4BO,MAAM,oCAAoCA,oCAAoB,CAAA;AAAA,EACnE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,yBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQD,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,OAAS,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACNE,oCAAkB,UAAW,CAAA;AAAA,YAC3B,MAAA;AAAA,YACA,SAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/dist/providers/GkeEntityProvider.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"GkeEntityProvider.cjs.js","sources":["../../src/providers/GkeEntityProvider.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  DeferredEntity,\n  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\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  ANNOTATION_KUBERNETES_DASHBOARD_APP,\n  ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS,\n} from '@backstage/plugin-kubernetes-common';\nimport { Config } from '@backstage/config';\nimport {\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n  readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport {\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n} from '@backstage/catalog-model';\n\n/**\n * Catalog provider to ingest GKE clusters\n *\n * @public\n */\nexport class GkeEntityProvider implements EntityProvider {\n  private readonly logger: LoggerService;\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: LoggerService,\n    taskRunner: SchedulerServiceTaskRunner,\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: LoggerService;\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: LoggerService;\n    scheduler: SchedulerService;\n    config: Config;\n    clusterManagerClient: container.v1.ClusterManagerClient;\n  }) {\n    const gkeProviderConfig = config.getConfig('catalog.providers.gcp.gke');\n    const schedule = readSchedulerServiceTaskScheduleDefinitionFromConfig(\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    project: string,\n  ): DeferredEntity | undefined {\n    const location = `${this.getProviderName()}:${cluster.location}`;\n\n    if (\n      !cluster.name ||\n      !cluster.selfLink ||\n      !cluster.endpoint ||\n      !cluster.location\n    ) {\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]: `https://${cluster.endpoint}`,\n            [ANNOTATION_KUBERNETES_API_SERVER_CA]:\n              cluster.masterAuth?.clusterCaCertificate || '',\n            [ANNOTATION_KUBERNETES_AUTH_PROVIDER]: 'google',\n            [ANNOTATION_KUBERNETES_DASHBOARD_APP]: 'gke',\n            [ANNOTATION_LOCATION]: location,\n            [ANNOTATION_ORIGIN_LOCATION]: location,\n            [ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS]: JSON.stringify({\n              projectId: project,\n              region: cluster.location,\n              clusterName: cluster.name,\n            }),\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(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => 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<DeferredEntity[]> {\n    const clusters = await Promise.all(\n      this.gkeParents.map(async parent => {\n        const project = parent.split('/')[1];\n        const request = {\n          parent: parent,\n        };\n        const [response] = await this.clusterManagerClient.listClusters(\n          request,\n        );\n        return (\n          response.clusters\n            ?.filter(this.filterOutUndefinedCluster)\n            .map(c => this.clusterToResource(c, project))\n            .filter(this.filterOutUndefinedDeferredEntity) ?? []\n        );\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 resources: DeferredEntity[];\n\n    try {\n      resources = await this.getClusters();\n    } catch (e) {\n      this.logger.error('error fetching GKE clusters', e);\n      return;\n    }\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"],"names":["container","readSchedulerServiceTaskScheduleDefinitionFromConfig","ANNOTATION_KUBERNETES_API_SERVER","ANNOTATION_KUBERNETES_API_SERVER_CA","ANNOTATION_KUBERNETES_AUTH_PROVIDER","ANNOTATION_KUBERNETES_DASHBOARD_APP","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CO,MAAM,iBAA4C,CAAA;AAAA,EACtC,MAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,oBAAA,CAAA;AAAA,EACT,UAAA,CAAA;AAAA,EAEA,WACN,CAAA,MAAA,EACA,UACA,EAAA,UAAA,EACA,oBACA,EAAA;AACA,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,qEAAA;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,iBAAA,CACN,SACA,OAC4B,EAAA;AAC5B,IAAA,MAAM,WAAW,CAAG,EAAA,IAAA,CAAK,iBAAiB,CAAA,CAAA,EAAI,QAAQ,QAAQ,CAAA,CAAA,CAAA;AAE9D,IACE,IAAA,CAAC,OAAQ,CAAA,IAAA,IACT,CAAC,OAAA,CAAQ,QACT,IAAA,CAAC,OAAQ,CAAA,QAAA,IACT,CAAC,OAAA,CAAQ,QACT,EAAA;AACA,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,CAAA,QAAA,EAAW,QAAQ,QAAQ,CAAA,CAAA;AAAA,YAC/D,CAACC,0DAAmC,GAClC,OAAA,CAAQ,YAAY,oBAAwB,IAAA,EAAA;AAAA,YAC9C,CAACC,0DAAmC,GAAG,QAAA;AAAA,YACvC,CAACC,0DAAmC,GAAG,KAAA;AAAA,YACvC,CAACC,gCAAmB,GAAG,QAAA;AAAA,YACvB,CAACC,uCAA0B,GAAG,QAAA;AAAA,YAC9B,CAACC,iEAA0C,GAAG,IAAA,CAAK,SAAU,CAAA;AAAA,cAC3D,SAAW,EAAA,OAAA;AAAA,cACX,QAAQ,OAAQ,CAAA,QAAA;AAAA,cAChB,aAAa,OAAQ,CAAA,IAAA;AAAA,aACtB,CAAA;AAAA,WACH;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,iBACN,UACqB,EAAA;AACrB,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,WAAyC,GAAA;AACrD,IAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC7B,IAAK,CAAA,UAAA,CAAW,GAAI,CAAA,OAAM,MAAU,KAAA;AAClC,QAAA,MAAM,OAAU,GAAA,MAAA,CAAO,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA,CAAA;AACnC,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,OACE,SAAS,QACL,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA,CACtC,IAAI,CAAK,CAAA,KAAA,IAAA,CAAK,iBAAkB,CAAA,CAAA,EAAG,OAAO,CAAC,CAAA,CAC3C,OAAO,IAAK,CAAA,gCAAgC,KAAK,EAAC,CAAA;AAAA,OAExD,CAAA;AAAA,KACH,CAAA;AACA,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAM,OAAU,GAAA;AACd,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,SAAA,CAAA;AAEJ,IAAI,IAAA;AACF,MAAY,SAAA,GAAA,MAAM,KAAK,WAAY,EAAA,CAAA;AAAA,aAC5B,CAAG,EAAA;AACV,MAAK,IAAA,CAAA,MAAA,CAAO,KAAM,CAAA,6BAAA,EAA+B,CAAC,CAAA,CAAA;AAClD,MAAA,OAAA;AAAA,KACF;AAEA,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;;;;"}
+{"version":3,"file":"GkeEntityProvider.cjs.js","sources":["../../src/providers/GkeEntityProvider.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  DeferredEntity,\n  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\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  ANNOTATION_KUBERNETES_DASHBOARD_APP,\n  ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS,\n} from '@backstage/plugin-kubernetes-common';\nimport { Config } from '@backstage/config';\nimport {\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n  readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport {\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n} from '@backstage/catalog-model';\n\n/**\n * Catalog provider to ingest GKE clusters\n *\n * @public\n */\nexport class GkeEntityProvider implements EntityProvider {\n  private readonly logger: LoggerService;\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: LoggerService,\n    taskRunner: SchedulerServiceTaskRunner,\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: LoggerService;\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: LoggerService;\n    scheduler: SchedulerService;\n    config: Config;\n    clusterManagerClient: container.v1.ClusterManagerClient;\n  }) {\n    const gkeProviderConfig = config.getConfig('catalog.providers.gcp.gke');\n    const schedule = readSchedulerServiceTaskScheduleDefinitionFromConfig(\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    project: string,\n  ): DeferredEntity | undefined {\n    const location = `${this.getProviderName()}:${cluster.location}`;\n\n    if (\n      !cluster.name ||\n      !cluster.selfLink ||\n      !cluster.endpoint ||\n      !cluster.location\n    ) {\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]: `https://${cluster.endpoint}`,\n            [ANNOTATION_KUBERNETES_API_SERVER_CA]:\n              cluster.masterAuth?.clusterCaCertificate || '',\n            [ANNOTATION_KUBERNETES_AUTH_PROVIDER]: 'google',\n            [ANNOTATION_KUBERNETES_DASHBOARD_APP]: 'gke',\n            [ANNOTATION_LOCATION]: location,\n            [ANNOTATION_ORIGIN_LOCATION]: location,\n            [ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS]: JSON.stringify({\n              projectId: project,\n              region: cluster.location,\n              clusterName: cluster.name,\n            }),\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(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => 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<DeferredEntity[]> {\n    const clusters = await Promise.all(\n      this.gkeParents.map(async parent => {\n        const project = parent.split('/')[1];\n        const request = {\n          parent: parent,\n        };\n        const [response] = await this.clusterManagerClient.listClusters(\n          request,\n        );\n        return (\n          response.clusters\n            ?.filter(this.filterOutUndefinedCluster)\n            .map(c => this.clusterToResource(c, project))\n            .filter(this.filterOutUndefinedDeferredEntity) ?? []\n        );\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 resources: DeferredEntity[];\n\n    try {\n      resources = await this.getClusters();\n    } catch (e) {\n      this.logger.error('error fetching GKE clusters', e);\n      return;\n    }\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"],"names":["container","readSchedulerServiceTaskScheduleDefinitionFromConfig","ANNOTATION_KUBERNETES_API_SERVER","ANNOTATION_KUBERNETES_API_SERVER_CA","ANNOTATION_KUBERNETES_AUTH_PROVIDER","ANNOTATION_KUBERNETES_DASHBOARD_APP","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CO,MAAM,iBAA4C,CAAA;AAAA,EACtC,MAAA;AAAA,EACA,UAAA;AAAA,EACA,UAAA;AAAA,EACA,oBAAA;AAAA,EACT,UAAA;AAAA,EAEA,WACN,CAAA,MAAA,EACA,UACA,EAAA,UAAA,EACA,oBACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA;AACd,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA;AAClD,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAA,IAAA,CAAK,oBAAuB,GAAA,oBAAA;AAAA;AAC9B,EAEA,OAAc,UAAW,CAAA;AAAA,IACvB,MAAA;AAAA,IACA,SAAA;AAAA,IACA;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;AAAA,KAC7D,CAAA;AAAA;AACH,EAEA,OAAc,oBAAqB,CAAA;AAAA,IACjC,MAAA;AAAA,IACA,SAAA;AAAA,IACA,MAAA;AAAA,IACA;AAAA,GAMC,EAAA;AACD,IAAM,MAAA,iBAAA,GAAoB,MAAO,CAAA,SAAA,CAAU,2BAA2B,CAAA;AACtE,IAAA,MAAM,QAAW,GAAAC,qEAAA;AAAA,MACf,iBAAA,CAAkB,UAAU,UAAU;AAAA,KACxC;AACA,IAAA,OAAO,IAAI,iBAAA;AAAA,MACT,MAAA;AAAA,MACA,SAAA,CAAU,0BAA0B,QAAQ,CAAA;AAAA,MAC5C,iBAAA,CAAkB,eAAe,SAAS,CAAA;AAAA,MAC1C;AAAA,KACF;AAAA;AACF,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,OAAA,CAAA;AAAA;AACT,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA;AAAA;AACxB,EAEQ,iCACN,CACqB,EAAA;AACrB,IAAA,OAAO,CAAM,KAAA,KAAA,CAAA;AAAA;AACf,EAEQ,0BACN,CACoD,EAAA;AACpD,IAAO,OAAA,CAAA,KAAM,UAAa,CAAM,KAAA,IAAA;AAAA;AAClC,EAEQ,iBAAA,CACN,SACA,OAC4B,EAAA;AAC5B,IAAA,MAAM,WAAW,CAAG,EAAA,IAAA,CAAK,iBAAiB,CAAA,CAAA,EAAI,QAAQ,QAAQ,CAAA,CAAA;AAE9D,IACE,IAAA,CAAC,OAAQ,CAAA,IAAA,IACT,CAAC,OAAA,CAAQ,QACT,IAAA,CAAC,OAAQ,CAAA,QAAA,IACT,CAAC,OAAA,CAAQ,QACT,EAAA;AACA,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;AAAA,OACnJ;AACA,MAAO,OAAA,KAAA,CAAA;AAAA;AAIT,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,CAAA,QAAA,EAAW,QAAQ,QAAQ,CAAA,CAAA;AAAA,YAC/D,CAACC,0DAAmC,GAClC,OAAA,CAAQ,YAAY,oBAAwB,IAAA,EAAA;AAAA,YAC9C,CAACC,0DAAmC,GAAG,QAAA;AAAA,YACvC,CAACC,0DAAmC,GAAG,KAAA;AAAA,YACvC,CAACC,gCAAmB,GAAG,QAAA;AAAA,YACvB,CAACC,uCAA0B,GAAG,QAAA;AAAA,YAC9B,CAACC,iEAA0C,GAAG,IAAA,CAAK,SAAU,CAAA;AAAA,cAC3D,SAAW,EAAA,OAAA;AAAA,cACX,QAAQ,OAAQ,CAAA,QAAA;AAAA,cAChB,aAAa,OAAQ,CAAA;AAAA,aACtB;AAAA,WACH;AAAA,UACA,MAAM,OAAQ,CAAA,IAAA;AAAA,UACd,SAAW,EAAA;AAAA,SACb;AAAA,QACA,IAAM,EAAA;AAAA,UACJ,IAAM,EAAA,oBAAA;AAAA,UACN,KAAO,EAAA;AAAA;AACT;AACF,KACF;AAAA;AACF,EAEQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,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;AAAA,mBACZ,KAAO,EAAA;AACd,YAAK,IAAA,CAAA,MAAA,CAAO,MAAM,KAAK,CAAA;AAAA;AACzB;AACF,OACD,CAAA;AAAA,KACH;AAAA;AACF,EAEA,MAAc,WAAyC,GAAA;AACrD,IAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC7B,IAAK,CAAA,UAAA,CAAW,GAAI,CAAA,OAAM,MAAU,KAAA;AAClC,QAAA,MAAM,OAAU,GAAA,MAAA,CAAO,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACnC,QAAA,MAAM,OAAU,GAAA;AAAA,UACd;AAAA,SACF;AACA,QAAA,MAAM,CAAC,QAAQ,CAAI,GAAA,MAAM,KAAK,oBAAqB,CAAA,YAAA;AAAA,UACjD;AAAA,SACF;AACA,QAAA,OACE,SAAS,QACL,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA,CACtC,IAAI,CAAK,CAAA,KAAA,IAAA,CAAK,iBAAkB,CAAA,CAAA,EAAG,OAAO,CAAC,CAAA,CAC3C,OAAO,IAAK,CAAA,gCAAgC,KAAK,EAAC;AAAA,OAExD;AAAA,KACH;AACA,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AACvB,EAEA,MAAM,OAAU,GAAA;AACd,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA;AAAA;AAGnC,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,0BAA0B,CAAA;AAE3C,IAAI,IAAA,SAAA;AAEJ,IAAI,IAAA;AACF,MAAY,SAAA,GAAA,MAAM,KAAK,WAAY,EAAA;AAAA,aAC5B,CAAG,EAAA;AACV,MAAK,IAAA,CAAA,MAAA,CAAO,KAAM,CAAA,6BAAA,EAA+B,CAAC,CAAA;AAClD,MAAA;AAAA;AAGF,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;AAAA,KACf;AAEA,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAU,EAAA;AAAA,KACX,CAAA;AAAA;AAEL;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-gcp",
-  "version": "0.3.2-next.1",
+  "version": "0.3.2",
   "description": "A Backstage catalog backend module that helps integrate towards GCP",
   "backstage": {
     "role": "backend-plugin-module",
@@ -36,10 +36,19 @@
   },
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ],
+      "alpha": [
+        "dist/alpha.d.ts"
+      ]
+    }
+  },
   "files": [
     "config.d.ts",
-    "dist",
-    "alpha"
+    "dist"
   ],
   "scripts": {
     "build": "backstage-cli package build",
@@ -51,16 +60,16 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.0.2-next.1",
-    "@backstage/catalog-model": "1.7.0",
-    "@backstage/config": "1.2.0",
-    "@backstage/plugin-catalog-node": "1.14.0-next.1",
-    "@backstage/plugin-kubernetes-common": "0.9.0-next.0",
+    "@backstage/backend-plugin-api": "^1.0.2",
+    "@backstage/catalog-model": "^1.7.1",
+    "@backstage/config": "^1.3.0",
+    "@backstage/plugin-catalog-node": "^1.14.0",
+    "@backstage/plugin-kubernetes-common": "^0.9.0",
     "@google-cloud/container": "^5.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.0.3-next.1",
-    "@backstage/cli": "0.29.0-next.1"
+    "@backstage/backend-test-utils": "^1.1.0",
+    "@backstage/cli": "^0.29.0"
   },
   "configSchema": "config.d.ts"
 }

package/alpha/package.json

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