@backstage-community/plugin-ocm-backend 5.2.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"ManagedClusterProvider.cjs.js","sources":["../../src/providers/ManagedClusterProvider.ts"],"sourcesContent":["/*\n * Copyright 2024 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 type {\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\nimport {\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n  ResourceEntity,\n} from '@backstage/catalog-model';\nimport type { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport type {\n  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\n\nimport { CustomObjectsApi } from '@kubernetes/client-node';\n\nimport {\n  ANNOTATION_CLUSTER_ID,\n  ANNOTATION_PROVIDER_ID,\n} from '@backstage-community/plugin-ocm-common';\n\nimport {\n  ANNOTATION_KUBERNETES_API_SERVER,\n  CONSOLE_CLAIM,\n  HUB_CLUSTER_NAME_IN_OCM,\n} from '../constants';\nimport { readOcmConfigs } from '../helpers/config';\nimport {\n  getManagedCluster,\n  hubApiClient,\n  listManagedClusters,\n} from '../helpers/kubernetes';\nimport { getClaim, translateOCMToResource } from '../helpers/parser';\n\n/**\n * Provides OpenShift cluster resource entities from Open Cluster Management.\n */\nexport class ManagedClusterProvider implements EntityProvider {\n  protected readonly client: CustomObjectsApi;\n  protected readonly hubResourceName: string;\n  protected readonly id: string;\n  protected readonly owner: string;\n  protected readonly logger: LoggerService;\n  private readonly scheduleFn: () => Promise<void>;\n  protected connection?: EntityProviderConnection;\n\n  protected constructor(\n    client: CustomObjectsApi,\n    hubResourceName: string,\n    id: string,\n    deps: { logger: LoggerService },\n    owner: string,\n    taskRunner: SchedulerServiceTaskRunner,\n  ) {\n    this.client = client;\n    this.hubResourceName = hubResourceName;\n    this.id = id;\n    this.logger = deps.logger;\n    this.owner = owner;\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n  }\n\n  static fromConfig(\n    deps: {\n      config: Config;\n      logger: LoggerService;\n    },\n    options:\n      | { schedule: SchedulerServiceTaskRunner }\n      | { scheduler: SchedulerService },\n  ) {\n    const { config, logger } = deps;\n\n    return readOcmConfigs(config).map(providerConfig => {\n      const client = hubApiClient(providerConfig, logger);\n      let taskRunner;\n      if ('scheduler' in options && providerConfig.schedule) {\n        // Create a scheduled task runner using the provided scheduler and schedule configuration\n        taskRunner = options.scheduler.createScheduledTaskRunner(\n          providerConfig.schedule,\n        );\n      } else if ('schedule' in options) {\n        // Use the provided schedule directly\n        taskRunner = options.schedule;\n      } else {\n        throw new InputError(\n          `No schedule provided via config for OCMProvider:${providerConfig.id}.`,\n        );\n      }\n\n      return new ManagedClusterProvider(\n        client,\n        providerConfig.hubResourceName,\n        providerConfig.id,\n        deps,\n        providerConfig.owner,\n        taskRunner,\n      );\n    });\n  }\n  public async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    await this.scheduleFn();\n  }\n\n  private createScheduleFn(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => Promise<void> {\n    return async () => {\n      return taskRunner.run({\n        id: `run_ocm_refresh_${this.getProviderName()}`,\n        fn: async () => {\n          try {\n            await this.run();\n          } catch (error: any) {\n            // Ensure that we don't log any sensitive internal data:\n            this.logger.error(\n              'Error while syncing cluster resources from Open Cluster Management',\n              {\n                // Default Error properties:\n                name: error.name,\n                message: error.message,\n                stack: error.stack,\n                // Additional status code if available:\n                status: error.response?.status,\n              },\n            );\n          }\n        },\n      });\n    };\n  }\n\n  getProviderName(): string {\n    return `ocm-managed-cluster:${this.id}`;\n  }\n\n  async run(): Promise<void> {\n    if (!this.connection) {\n      throw new Error('Not initialized');\n    }\n\n    this.logger.info(\n      `Providing OpenShift cluster resources from Open Cluster Management`,\n    );\n    const hubConsole = getClaim(\n      await getManagedCluster(this.client, HUB_CLUSTER_NAME_IN_OCM),\n      CONSOLE_CLAIM,\n    );\n\n    const resources: ResourceEntity[] = (\n      await listManagedClusters(this.client)\n    ).items.map(i => {\n      const normalizedName = translateOCMToResource(\n        i.metadata!.name!,\n        this.hubResourceName,\n      );\n\n      return {\n        kind: 'Resource',\n        apiVersion: 'backstage.io/v1beta1',\n        metadata: {\n          name: normalizedName,\n          annotations: {\n            /**\n             * Can also be pulled from ManagedClusterInfo on .spec.masterEndpoint (details in discussion: https://github.com/janus-idp/backstage-plugins/pull/94#discussion_r1093228858)\n             */\n            [ANNOTATION_KUBERNETES_API_SERVER]:\n              i.spec?.managedClusterClientConfigs?.[0]?.url,\n            [ANNOTATION_CLUSTER_ID]: i.metadata?.labels?.clusterID!,\n            [ANNOTATION_LOCATION]: this.getProviderName(),\n            [ANNOTATION_ORIGIN_LOCATION]: this.getProviderName(),\n            [ANNOTATION_PROVIDER_ID]: this.id,\n          },\n          links: [\n            {\n              url: getClaim(i, CONSOLE_CLAIM),\n              title: 'OpenShift Console',\n              icon: 'dashboard',\n            },\n            {\n              url: `${hubConsole}/multicloud/infrastructure/clusters/details/${\n                i.metadata!.name\n              }/`,\n              title: 'OCM Console',\n            },\n            {\n              url: `https://console.redhat.com/openshift/details/s/${\n                i.metadata!.labels!.clusterID\n              }`,\n              title: 'OpenShift Cluster Manager',\n            },\n          ],\n        },\n        spec: {\n          owner: this.owner,\n          type: 'kubernetes-cluster',\n        },\n      };\n    });\n\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: resources.map(entity => ({\n        entity,\n        locationKey: this.getProviderName(),\n      })),\n    });\n  }\n}\n"],"names":["config","readOcmConfigs","hubApiClient","InputError","getClaim","getManagedCluster","HUB_CLUSTER_NAME_IN_OCM","CONSOLE_CLAIM","listManagedClusters","translateOCMToResource","ANNOTATION_KUBERNETES_API_SERVER","ANNOTATION_CLUSTER_ID","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","ANNOTATION_PROVIDER_ID"],"mappings":";;;;;;;;;;AAwDO,MAAM,sBAAiD,CAAA;AAAA,EACzC,MAAA,CAAA;AAAA,EACA,eAAA,CAAA;AAAA,EACA,EAAA,CAAA;AAAA,EACA,KAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACF,UAAA,CAAA;AAAA,EACP,UAAA,CAAA;AAAA,EAEA,YACR,MACA,EAAA,eAAA,EACA,EACA,EAAA,IAAA,EACA,OACA,UACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,eAAkB,GAAA,eAAA,CAAA;AACvB,IAAA,IAAA,CAAK,EAAK,GAAA,EAAA,CAAA;AACV,IAAA,IAAA,CAAK,SAAS,IAAK,CAAA,MAAA,CAAA;AACnB,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA;AACb,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,OAAO,UACL,CAAA,IAAA,EAIA,OAGA,EAAA;AACA,IAAM,MAAA,UAAEA,QAAQ,EAAA,MAAA,EAAW,GAAA,IAAA,CAAA;AAE3B,IAAA,OAAOC,qBAAe,CAAAD,QAAM,CAAE,CAAA,GAAA,CAAI,CAAkB,cAAA,KAAA;AAClD,MAAM,MAAA,MAAA,GAASE,uBAAa,CAAA,cAAA,EAAgB,MAAM,CAAA,CAAA;AAClD,MAAI,IAAA,UAAA,CAAA;AACJ,MAAI,IAAA,WAAA,IAAe,OAAW,IAAA,cAAA,CAAe,QAAU,EAAA;AAErD,QAAA,UAAA,GAAa,QAAQ,SAAU,CAAA,yBAAA;AAAA,UAC7B,cAAe,CAAA,QAAA;AAAA,SACjB,CAAA;AAAA,OACF,MAAA,IAAW,cAAc,OAAS,EAAA;AAEhC,QAAA,UAAA,GAAa,OAAQ,CAAA,QAAA,CAAA;AAAA,OAChB,MAAA;AACL,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,gDAAA,EAAmD,eAAe,EAAE,CAAA,CAAA,CAAA;AAAA,SACtE,CAAA;AAAA,OACF;AAEA,MAAA,OAAO,IAAI,sBAAA;AAAA,QACT,MAAA;AAAA,QACA,cAAe,CAAA,eAAA;AAAA,QACf,cAAe,CAAA,EAAA;AAAA,QACf,IAAA;AAAA,QACA,cAAe,CAAA,KAAA;AAAA,QACf,UAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EACA,MAAa,QAAQ,UAAqD,EAAA;AACxE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,CAAA,gBAAA,EAAmB,IAAK,CAAA,eAAA,EAAiB,CAAA,CAAA;AAAA,QAC7C,IAAI,YAAY;AACd,UAAI,IAAA;AACF,YAAA,MAAM,KAAK,GAAI,EAAA,CAAA;AAAA,mBACR,KAAY,EAAA;AAEnB,YAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,cACV,oEAAA;AAAA,cACA;AAAA;AAAA,gBAEE,MAAM,KAAM,CAAA,IAAA;AAAA,gBACZ,SAAS,KAAM,CAAA,OAAA;AAAA,gBACf,OAAO,KAAM,CAAA,KAAA;AAAA;AAAA,gBAEb,MAAA,EAAQ,MAAM,QAAU,EAAA,MAAA;AAAA,eAC1B;AAAA,aACF,CAAA;AAAA,WACF;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,oBAAA,EAAuB,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,GACvC;AAAA,EAEA,MAAM,GAAqB,GAAA;AACzB,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAA,kEAAA,CAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,UAAa,GAAAC,eAAA;AAAA,MACjB,MAAMC,4BAAA,CAAkB,IAAK,CAAA,MAAA,EAAQC,iCAAuB,CAAA;AAAA,MAC5DC,uBAAA;AAAA,KACF,CAAA;AAEA,IAAM,MAAA,SAAA,GAAA,CACJ,MAAMC,8BAAoB,CAAA,IAAA,CAAK,MAAM,CACrC,EAAA,KAAA,CAAM,IAAI,CAAK,CAAA,KAAA;AACf,MAAA,MAAM,cAAiB,GAAAC,6BAAA;AAAA,QACrB,EAAE,QAAU,CAAA,IAAA;AAAA,QACZ,IAAK,CAAA,eAAA;AAAA,OACP,CAAA;AAEA,MAAO,OAAA;AAAA,QACL,IAAM,EAAA,UAAA;AAAA,QACN,UAAY,EAAA,sBAAA;AAAA,QACZ,QAAU,EAAA;AAAA,UACR,IAAM,EAAA,cAAA;AAAA,UACN,WAAa,EAAA;AAAA;AAAA;AAAA;AAAA,YAIX,CAACC,0CAAgC,GAC/B,EAAE,IAAM,EAAA,2BAAA,GAA8B,CAAC,CAAG,EAAA,GAAA;AAAA,YAC5C,CAACC,qCAAqB,GAAG,CAAA,CAAE,UAAU,MAAQ,EAAA,SAAA;AAAA,YAC7C,CAACC,gCAAmB,GAAG,IAAA,CAAK,eAAgB,EAAA;AAAA,YAC5C,CAACC,uCAA0B,GAAG,IAAA,CAAK,eAAgB,EAAA;AAAA,YACnD,CAACC,sCAAsB,GAAG,IAAK,CAAA,EAAA;AAAA,WACjC;AAAA,UACA,KAAO,EAAA;AAAA,YACL;AAAA,cACE,GAAA,EAAKV,eAAS,CAAA,CAAA,EAAGG,uBAAa,CAAA;AAAA,cAC9B,KAAO,EAAA,mBAAA;AAAA,cACP,IAAM,EAAA,WAAA;AAAA,aACR;AAAA,YACA;AAAA,cACE,KAAK,CAAG,EAAA,UAAU,CAChB,4CAAA,EAAA,CAAA,CAAE,SAAU,IACd,CAAA,CAAA,CAAA;AAAA,cACA,KAAO,EAAA,aAAA;AAAA,aACT;AAAA,YACA;AAAA,cACE,GAAK,EAAA,CAAA,+CAAA,EACH,CAAE,CAAA,QAAA,CAAU,OAAQ,SACtB,CAAA,CAAA;AAAA,cACA,KAAO,EAAA,2BAAA;AAAA,aACT;AAAA,WACF;AAAA,SACF;AAAA,QACA,IAAM,EAAA;AAAA,UACJ,OAAO,IAAK,CAAA,KAAA;AAAA,UACZ,IAAM,EAAA,oBAAA;AAAA,SACR;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,SAAU,CAAA,GAAA,CAAI,CAAW,MAAA,MAAA;AAAA,QACjC,MAAA;AAAA,QACA,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,OAClC,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/providers/module.cjs.js

@@ -0,0 +1,38 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+var ManagedClusterProvider = require('./ManagedClusterProvider.cjs.js');
+
+const catalogModuleOCMEntityProvider = backendPluginApi.createBackendModule({
+  moduleId: "catalog-backend-module-ocm",
+  pluginId: "catalog",
+  register(env) {
+    env.registerInit({
+      deps: {
+        catalog: alpha.catalogProcessingExtensionPoint,
+        config: backendPluginApi.coreServices.rootConfig,
+        logger: backendPluginApi.coreServices.logger,
+        scheduler: backendPluginApi.coreServices.scheduler
+      },
+      async init({ catalog, config, logger, scheduler }) {
+        catalog.addEntityProvider(
+          ManagedClusterProvider.ManagedClusterProvider.fromConfig(
+            { config, logger },
+            {
+              schedule: scheduler.createScheduledTaskRunner({
+                frequency: { hours: 1 },
+                timeout: { minutes: 15 },
+                initialDelay: { seconds: 15 }
+              }),
+              scheduler
+            }
+          )
+        );
+      }
+    });
+  }
+});
+
+exports.catalogModuleOCMEntityProvider = catalogModuleOCMEntityProvider;
+//# sourceMappingURL=module.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"module.cjs.js","sources":["../../src/providers/module.ts"],"sourcesContent":["/*\n * Copyright 2024 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';\n\nimport { ManagedClusterProvider } from './ManagedClusterProvider';\n\nexport const catalogModuleOCMEntityProvider = createBackendModule({\n  moduleId: 'catalog-backend-module-ocm',\n  pluginId: 'catalog',\n  register(env) {\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n      },\n      async init({ catalog, config, logger, scheduler }) {\n        catalog.addEntityProvider(\n          ManagedClusterProvider.fromConfig(\n            { config, logger },\n            {\n              schedule: scheduler.createScheduledTaskRunner({\n                frequency: { hours: 1 },\n                timeout: { minutes: 15 },\n                initialDelay: { seconds: 15 },\n              }),\n              scheduler: scheduler,\n            },\n          ),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","coreServices","ManagedClusterProvider"],"mappings":";;;;;;AAwBO,MAAM,iCAAiCA,oCAAoB,CAAA;AAAA,EAChE,QAAU,EAAA,4BAAA;AAAA,EACV,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,SAAS,MAAQ,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACNC,6CAAuB,CAAA,UAAA;AAAA,YACrB,EAAE,QAAQ,MAAO,EAAA;AAAA,YACjB;AAAA,cACE,QAAA,EAAU,UAAU,yBAA0B,CAAA;AAAA,gBAC5C,SAAA,EAAW,EAAE,KAAA,EAAO,CAAE,EAAA;AAAA,gBACtB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,gBACvB,YAAA,EAAc,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,eAC7B,CAAA;AAAA,cACD,SAAA;AAAA,aACF;AAAA,WACF;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/schema/openapi.generated.cjs.js

@@ -0,0 +1,301 @@
+'use strict';
+
+var backendOpenapiUtils = require('@backstage/backend-openapi-utils');
+
+const spec = {
+  openapi: "3.0.0",
+  info: {
+    title: "OCM Plugin API",
+    version: "latest",
+    description: "The Open Cluster Management (OCM) plugin integrates your Backstage instance with OCM."
+  },
+  servers: [
+    {
+      url: "{protocol}://{host}:{port}/{basePath}",
+      variables: {
+        protocol: {
+          enum: ["http", "https"],
+          default: "http"
+        },
+        host: {
+          default: "localhost"
+        },
+        port: {
+          default: "7007"
+        },
+        basePath: {
+          default: "api/ocm"
+        }
+      }
+    }
+  ],
+  paths: {
+    "/status/{providerId}/{clusterName}": {
+      get: {
+        summary: "Get the status of a specific cluster",
+        description: "Retrieve the status of a specific cluster on a given hub.",
+        parameters: [
+          {
+            name: "providerId",
+            in: "path",
+            required: true,
+            description: "The ID of the OCM provider",
+            schema: {
+              type: "string"
+            }
+          },
+          {
+            name: "clusterName",
+            in: "path",
+            required: true,
+            description: "The name of the cluster",
+            schema: {
+              type: "string"
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "Cluster status retrieved successfully",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/Cluster"
+                }
+              }
+            }
+          },
+          "403": {
+            description: "Unauthorized"
+          },
+          "404": {
+            description: "Hub not found"
+          }
+        },
+        security: [
+          {},
+          {
+            JWT: []
+          }
+        ]
+      }
+    },
+    "/status": {
+      get: {
+        summary: "Get the status of all clusters",
+        description: "Retrieve the status of all clusters across all hubs.",
+        responses: {
+          "200": {
+            description: "Clusters status retrieved successfully",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    $ref: "#/components/schemas/ClusterOverview"
+                  }
+                }
+              }
+            }
+          },
+          "403": {
+            description: "Unauthorized"
+          }
+        },
+        security: [
+          {},
+          {
+            JWT: []
+          }
+        ]
+      }
+    }
+  },
+  components: {
+    schemas: {
+      ClusterStatus: {
+        type: "object",
+        properties: {
+          available: {
+            type: "boolean",
+            description: "Indicates if the cluster is available"
+          },
+          reason: {
+            type: "string",
+            description: "Optional reason why the cluster is not available or as problems"
+          }
+        },
+        required: ["available"]
+      },
+      ClusterUpdate: {
+        type: "object",
+        properties: {
+          available: {
+            type: "boolean",
+            description: "Indicates if an update is available"
+          },
+          version: {
+            type: "string",
+            description: "Version of the available update"
+          },
+          url: {
+            type: "string",
+            description: "URL for the update"
+          }
+        }
+      },
+      ClusterNodesStatus: {
+        type: "object",
+        properties: {
+          status: {
+            type: "string",
+            description: "Status of the node"
+          },
+          type: {
+            type: "string",
+            description: "Type of the node"
+          }
+        }
+      },
+      ClusterDetails: {
+        type: "object",
+        properties: {
+          consoleUrl: {
+            type: "string",
+            description: "URL for the cluster console"
+          },
+          kubernetesVersion: {
+            type: "string",
+            description: "Version of Kubernetes"
+          },
+          oauthUrl: {
+            type: "string",
+            description: "OAuth URL for the cluster"
+          },
+          openshiftId: {
+            type: "string",
+            description: "ID of the OpenShift cluster"
+          },
+          openshiftVersion: {
+            type: "string",
+            description: "Version of OpenShift running in the cluster"
+          },
+          platform: {
+            type: "string",
+            description: "Platform of the cluster"
+          },
+          region: {
+            type: "string",
+            description: "Region where the cluster is located"
+          },
+          allocatableResources: {
+            type: "object",
+            description: "Resources that are allocatable in the cluster",
+            properties: {
+              cpuCores: {
+                type: "number",
+                description: "Number of CPU cores allocatable"
+              },
+              memorySize: {
+                type: "string",
+                description: "Size of allocatable memory"
+              },
+              numberOfPods: {
+                type: "number",
+                description: "Number of allocatable pods"
+              }
+            }
+          },
+          availableResources: {
+            type: "object",
+            description: "Resources that are available in the cluster",
+            properties: {
+              cpuCores: {
+                type: "number",
+                description: "Number of CPU cores available"
+              },
+              memorySize: {
+                type: "string",
+                description: "Size of available memory"
+              },
+              numberOfPods: {
+                type: "number",
+                description: "Number of available pods"
+              }
+            }
+          },
+          update: {
+            $ref: "#/components/schemas/ClusterUpdate"
+          },
+          status: {
+            $ref: "#/components/schemas/ClusterStatus"
+          }
+        }
+      },
+      Cluster: {
+        allOf: [
+          {
+            $ref: "#/components/schemas/ClusterBase"
+          },
+          {
+            $ref: "#/components/schemas/ClusterDetails"
+          }
+        ]
+      },
+      ClusterBase: {
+        type: "object",
+        properties: {
+          name: {
+            type: "string",
+            description: "The name of the cluster"
+          }
+        }
+      },
+      ClusterOverview: {
+        allOf: [
+          {
+            $ref: "#/components/schemas/ClusterBase"
+          },
+          {
+            type: "object",
+            properties: {
+              status: {
+                $ref: "#/components/schemas/ClusterStatus"
+              },
+              update: {
+                $ref: "#/components/schemas/ClusterUpdate"
+              },
+              platform: {
+                type: "string",
+                description: "Platform of the cluster"
+              },
+              openshiftVersion: {
+                type: "string",
+                description: "Version of OpenShift running in the cluster"
+              },
+              nodes: {
+                type: "array",
+                items: {
+                  $ref: "#/components/schemas/ClusterNodesStatus"
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    securitySchemes: {
+      JWT: {
+        type: "http",
+        scheme: "bearer",
+        bearerFormat: "JWT",
+        description: "Backstage Permissions Framework JWT"
+      }
+    }
+  }
+};
+const createOpenApiRouter = async (options) => backendOpenapiUtils.createValidatedOpenApiRouter(spec, options);
+
+exports.createOpenApiRouter = createOpenApiRouter;
+exports.spec = spec;
+//# sourceMappingURL=openapi.generated.cjs.js.map

package/dist/schema/openapi.generated.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.generated.cjs.js","sources":["../../src/schema/openapi.generated.ts"],"sourcesContent":["/*\n * Copyright 2024 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\n// ******************************************************************\n// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *\n// ******************************************************************\nimport { createValidatedOpenApiRouter } from '@backstage/backend-openapi-utils';\n\nexport const spec = {\n  openapi: '3.0.0',\n  info: {\n    title: 'OCM Plugin API',\n    version: 'latest',\n    description:\n      'The Open Cluster Management (OCM) plugin integrates your Backstage instance with OCM.',\n  },\n  servers: [\n    {\n      url: '{protocol}://{host}:{port}/{basePath}',\n      variables: {\n        protocol: {\n          enum: ['http', 'https'],\n          default: 'http',\n        },\n        host: {\n          default: 'localhost',\n        },\n        port: {\n          default: '7007',\n        },\n        basePath: {\n          default: 'api/ocm',\n        },\n      },\n    },\n  ],\n  paths: {\n    '/status/{providerId}/{clusterName}': {\n      get: {\n        summary: 'Get the status of a specific cluster',\n        description:\n          'Retrieve the status of a specific cluster on a given hub.',\n        parameters: [\n          {\n            name: 'providerId',\n            in: 'path',\n            required: true,\n            description: 'The ID of the OCM provider',\n            schema: {\n              type: 'string',\n            },\n          },\n          {\n            name: 'clusterName',\n            in: 'path',\n            required: true,\n            description: 'The name of the cluster',\n            schema: {\n              type: 'string',\n            },\n          },\n        ],\n        responses: {\n          '200': {\n            description: 'Cluster status retrieved successfully',\n            content: {\n              'application/json': {\n                schema: {\n                  $ref: '#/components/schemas/Cluster',\n                },\n              },\n            },\n          },\n          '403': {\n            description: 'Unauthorized',\n          },\n          '404': {\n            description: 'Hub not found',\n          },\n        },\n        security: [\n          {},\n          {\n            JWT: [],\n          },\n        ],\n      },\n    },\n    '/status': {\n      get: {\n        summary: 'Get the status of all clusters',\n        description: 'Retrieve the status of all clusters across all hubs.',\n        responses: {\n          '200': {\n            description: 'Clusters status retrieved successfully',\n            content: {\n              'application/json': {\n                schema: {\n                  type: 'array',\n                  items: {\n                    $ref: '#/components/schemas/ClusterOverview',\n                  },\n                },\n              },\n            },\n          },\n          '403': {\n            description: 'Unauthorized',\n          },\n        },\n        security: [\n          {},\n          {\n            JWT: [],\n          },\n        ],\n      },\n    },\n  },\n  components: {\n    schemas: {\n      ClusterStatus: {\n        type: 'object',\n        properties: {\n          available: {\n            type: 'boolean',\n            description: 'Indicates if the cluster is available',\n          },\n          reason: {\n            type: 'string',\n            description:\n              'Optional reason why the cluster is not available or as problems',\n          },\n        },\n        required: ['available'],\n      },\n      ClusterUpdate: {\n        type: 'object',\n        properties: {\n          available: {\n            type: 'boolean',\n            description: 'Indicates if an update is available',\n          },\n          version: {\n            type: 'string',\n            description: 'Version of the available update',\n          },\n          url: {\n            type: 'string',\n            description: 'URL for the update',\n          },\n        },\n      },\n      ClusterNodesStatus: {\n        type: 'object',\n        properties: {\n          status: {\n            type: 'string',\n            description: 'Status of the node',\n          },\n          type: {\n            type: 'string',\n            description: 'Type of the node',\n          },\n        },\n      },\n      ClusterDetails: {\n        type: 'object',\n        properties: {\n          consoleUrl: {\n            type: 'string',\n            description: 'URL for the cluster console',\n          },\n          kubernetesVersion: {\n            type: 'string',\n            description: 'Version of Kubernetes',\n          },\n          oauthUrl: {\n            type: 'string',\n            description: 'OAuth URL for the cluster',\n          },\n          openshiftId: {\n            type: 'string',\n            description: 'ID of the OpenShift cluster',\n          },\n          openshiftVersion: {\n            type: 'string',\n            description: 'Version of OpenShift running in the cluster',\n          },\n          platform: {\n            type: 'string',\n            description: 'Platform of the cluster',\n          },\n          region: {\n            type: 'string',\n            description: 'Region where the cluster is located',\n          },\n          allocatableResources: {\n            type: 'object',\n            description: 'Resources that are allocatable in the cluster',\n            properties: {\n              cpuCores: {\n                type: 'number',\n                description: 'Number of CPU cores allocatable',\n              },\n              memorySize: {\n                type: 'string',\n                description: 'Size of allocatable memory',\n              },\n              numberOfPods: {\n                type: 'number',\n                description: 'Number of allocatable pods',\n              },\n            },\n          },\n          availableResources: {\n            type: 'object',\n            description: 'Resources that are available in the cluster',\n            properties: {\n              cpuCores: {\n                type: 'number',\n                description: 'Number of CPU cores available',\n              },\n              memorySize: {\n                type: 'string',\n                description: 'Size of available memory',\n              },\n              numberOfPods: {\n                type: 'number',\n                description: 'Number of available pods',\n              },\n            },\n          },\n          update: {\n            $ref: '#/components/schemas/ClusterUpdate',\n          },\n          status: {\n            $ref: '#/components/schemas/ClusterStatus',\n          },\n        },\n      },\n      Cluster: {\n        allOf: [\n          {\n            $ref: '#/components/schemas/ClusterBase',\n          },\n          {\n            $ref: '#/components/schemas/ClusterDetails',\n          },\n        ],\n      },\n      ClusterBase: {\n        type: 'object',\n        properties: {\n          name: {\n            type: 'string',\n            description: 'The name of the cluster',\n          },\n        },\n      },\n      ClusterOverview: {\n        allOf: [\n          {\n            $ref: '#/components/schemas/ClusterBase',\n          },\n          {\n            type: 'object',\n            properties: {\n              status: {\n                $ref: '#/components/schemas/ClusterStatus',\n              },\n              update: {\n                $ref: '#/components/schemas/ClusterUpdate',\n              },\n              platform: {\n                type: 'string',\n                description: 'Platform of the cluster',\n              },\n              openshiftVersion: {\n                type: 'string',\n                description: 'Version of OpenShift running in the cluster',\n              },\n              nodes: {\n                type: 'array',\n                items: {\n                  $ref: '#/components/schemas/ClusterNodesStatus',\n                },\n              },\n            },\n          },\n        ],\n      },\n    },\n    securitySchemes: {\n      JWT: {\n        type: 'http',\n        scheme: 'bearer',\n        bearerFormat: 'JWT',\n        description: 'Backstage Permissions Framework JWT',\n      },\n    },\n  },\n} as const;\nexport const createOpenApiRouter = async (\n  options?: Parameters<typeof createValidatedOpenApiRouter>['1'],\n) => createValidatedOpenApiRouter<typeof spec>(spec, options);\n"],"names":["createValidatedOpenApiRouter"],"mappings":";;;;AAqBO,MAAM,IAAO,GAAA;AAAA,EAClB,OAAS,EAAA,OAAA;AAAA,EACT,IAAM,EAAA;AAAA,IACJ,KAAO,EAAA,gBAAA;AAAA,IACP,OAAS,EAAA,QAAA;AAAA,IACT,WACE,EAAA,uFAAA;AAAA,GACJ;AAAA,EACA,OAAS,EAAA;AAAA,IACP;AAAA,MACE,GAAK,EAAA,uCAAA;AAAA,MACL,SAAW,EAAA;AAAA,QACT,QAAU,EAAA;AAAA,UACR,IAAA,EAAM,CAAC,MAAA,EAAQ,OAAO,CAAA;AAAA,UACtB,OAAS,EAAA,MAAA;AAAA,SACX;AAAA,QACA,IAAM,EAAA;AAAA,UACJ,OAAS,EAAA,WAAA;AAAA,SACX;AAAA,QACA,IAAM,EAAA;AAAA,UACJ,OAAS,EAAA,MAAA;AAAA,SACX;AAAA,QACA,QAAU,EAAA;AAAA,UACR,OAAS,EAAA,SAAA;AAAA,SACX;AAAA,OACF;AAAA,KACF;AAAA,GACF;AAAA,EACA,KAAO,EAAA;AAAA,IACL,oCAAsC,EAAA;AAAA,MACpC,GAAK,EAAA;AAAA,QACH,OAAS,EAAA,sCAAA;AAAA,QACT,WACE,EAAA,2DAAA;AAAA,QACF,UAAY,EAAA;AAAA,UACV;AAAA,YACE,IAAM,EAAA,YAAA;AAAA,YACN,EAAI,EAAA,MAAA;AAAA,YACJ,QAAU,EAAA,IAAA;AAAA,YACV,WAAa,EAAA,4BAAA;AAAA,YACb,MAAQ,EAAA;AAAA,cACN,IAAM,EAAA,QAAA;AAAA,aACR;AAAA,WACF;AAAA,UACA;AAAA,YACE,IAAM,EAAA,aAAA;AAAA,YACN,EAAI,EAAA,MAAA;AAAA,YACJ,QAAU,EAAA,IAAA;AAAA,YACV,WAAa,EAAA,yBAAA;AAAA,YACb,MAAQ,EAAA;AAAA,cACN,IAAM,EAAA,QAAA;AAAA,aACR;AAAA,WACF;AAAA,SACF;AAAA,QACA,SAAW,EAAA;AAAA,UACT,KAAO,EAAA;AAAA,YACL,WAAa,EAAA,uCAAA;AAAA,YACb,OAAS,EAAA;AAAA,cACP,kBAAoB,EAAA;AAAA,gBAClB,MAAQ,EAAA;AAAA,kBACN,IAAM,EAAA,8BAAA;AAAA,iBACR;AAAA,eACF;AAAA,aACF;AAAA,WACF;AAAA,UACA,KAAO,EAAA;AAAA,YACL,WAAa,EAAA,cAAA;AAAA,WACf;AAAA,UACA,KAAO,EAAA;AAAA,YACL,WAAa,EAAA,eAAA;AAAA,WACf;AAAA,SACF;AAAA,QACA,QAAU,EAAA;AAAA,UACR,EAAC;AAAA,UACD;AAAA,YACE,KAAK,EAAC;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,SAAW,EAAA;AAAA,MACT,GAAK,EAAA;AAAA,QACH,OAAS,EAAA,gCAAA;AAAA,QACT,WAAa,EAAA,sDAAA;AAAA,QACb,SAAW,EAAA;AAAA,UACT,KAAO,EAAA;AAAA,YACL,WAAa,EAAA,wCAAA;AAAA,YACb,OAAS,EAAA;AAAA,cACP,kBAAoB,EAAA;AAAA,gBAClB,MAAQ,EAAA;AAAA,kBACN,IAAM,EAAA,OAAA;AAAA,kBACN,KAAO,EAAA;AAAA,oBACL,IAAM,EAAA,sCAAA;AAAA,mBACR;AAAA,iBACF;AAAA,eACF;AAAA,aACF;AAAA,WACF;AAAA,UACA,KAAO,EAAA;AAAA,YACL,WAAa,EAAA,cAAA;AAAA,WACf;AAAA,SACF;AAAA,QACA,QAAU,EAAA;AAAA,UACR,EAAC;AAAA,UACD;AAAA,YACE,KAAK,EAAC;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,GACF;AAAA,EACA,UAAY,EAAA;AAAA,IACV,OAAS,EAAA;AAAA,MACP,aAAe,EAAA;AAAA,QACb,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,SAAW,EAAA;AAAA,YACT,IAAM,EAAA,SAAA;AAAA,YACN,WAAa,EAAA,uCAAA;AAAA,WACf;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,IAAM,EAAA,QAAA;AAAA,YACN,WACE,EAAA,iEAAA;AAAA,WACJ;AAAA,SACF;AAAA,QACA,QAAA,EAAU,CAAC,WAAW,CAAA;AAAA,OACxB;AAAA,MACA,aAAe,EAAA;AAAA,QACb,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,SAAW,EAAA;AAAA,YACT,IAAM,EAAA,SAAA;AAAA,YACN,WAAa,EAAA,qCAAA;AAAA,WACf;AAAA,UACA,OAAS,EAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,iCAAA;AAAA,WACf;AAAA,UACA,GAAK,EAAA;AAAA,YACH,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,oBAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,MACA,kBAAoB,EAAA;AAAA,QAClB,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,MAAQ,EAAA;AAAA,YACN,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,oBAAA;AAAA,WACf;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,kBAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,MACA,cAAgB,EAAA;AAAA,QACd,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,6BAAA;AAAA,WACf;AAAA,UACA,iBAAmB,EAAA;AAAA,YACjB,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,uBAAA;AAAA,WACf;AAAA,UACA,QAAU,EAAA;AAAA,YACR,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,2BAAA;AAAA,WACf;AAAA,UACA,WAAa,EAAA;AAAA,YACX,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,6BAAA;AAAA,WACf;AAAA,UACA,gBAAkB,EAAA;AAAA,YAChB,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,6CAAA;AAAA,WACf;AAAA,UACA,QAAU,EAAA;AAAA,YACR,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,yBAAA;AAAA,WACf;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,qCAAA;AAAA,WACf;AAAA,UACA,oBAAsB,EAAA;AAAA,YACpB,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,+CAAA;AAAA,YACb,UAAY,EAAA;AAAA,cACV,QAAU,EAAA;AAAA,gBACR,IAAM,EAAA,QAAA;AAAA,gBACN,WAAa,EAAA,iCAAA;AAAA,eACf;AAAA,cACA,UAAY,EAAA;AAAA,gBACV,IAAM,EAAA,QAAA;AAAA,gBACN,WAAa,EAAA,4BAAA;AAAA,eACf;AAAA,cACA,YAAc,EAAA;AAAA,gBACZ,IAAM,EAAA,QAAA;AAAA,gBACN,WAAa,EAAA,4BAAA;AAAA,eACf;AAAA,aACF;AAAA,WACF;AAAA,UACA,kBAAoB,EAAA;AAAA,YAClB,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,6CAAA;AAAA,YACb,UAAY,EAAA;AAAA,cACV,QAAU,EAAA;AAAA,gBACR,IAAM,EAAA,QAAA;AAAA,gBACN,WAAa,EAAA,+BAAA;AAAA,eACf;AAAA,cACA,UAAY,EAAA;AAAA,gBACV,IAAM,EAAA,QAAA;AAAA,gBACN,WAAa,EAAA,0BAAA;AAAA,eACf;AAAA,cACA,YAAc,EAAA;AAAA,gBACZ,IAAM,EAAA,QAAA;AAAA,gBACN,WAAa,EAAA,0BAAA;AAAA,eACf;AAAA,aACF;AAAA,WACF;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,IAAM,EAAA,oCAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,IAAM,EAAA,oCAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,MACA,OAAS,EAAA;AAAA,QACP,KAAO,EAAA;AAAA,UACL;AAAA,YACE,IAAM,EAAA,kCAAA;AAAA,WACR;AAAA,UACA;AAAA,YACE,IAAM,EAAA,qCAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,MACA,WAAa,EAAA;AAAA,QACX,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,IAAM,EAAA;AAAA,YACJ,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,yBAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,MACA,eAAiB,EAAA;AAAA,QACf,KAAO,EAAA;AAAA,UACL;AAAA,YACE,IAAM,EAAA,kCAAA;AAAA,WACR;AAAA,UACA;AAAA,YACE,IAAM,EAAA,QAAA;AAAA,YACN,UAAY,EAAA;AAAA,cACV,MAAQ,EAAA;AAAA,gBACN,IAAM,EAAA,oCAAA;AAAA,eACR;AAAA,cACA,MAAQ,EAAA;AAAA,gBACN,IAAM,EAAA,oCAAA;AAAA,eACR;AAAA,cACA,QAAU,EAAA;AAAA,gBACR,IAAM,EAAA,QAAA;AAAA,gBACN,WAAa,EAAA,yBAAA;AAAA,eACf;AAAA,cACA,gBAAkB,EAAA;AAAA,gBAChB,IAAM,EAAA,QAAA;AAAA,gBACN,WAAa,EAAA,6CAAA;AAAA,eACf;AAAA,cACA,KAAO,EAAA;AAAA,gBACL,IAAM,EAAA,OAAA;AAAA,gBACN,KAAO,EAAA;AAAA,kBACL,IAAM,EAAA,yCAAA;AAAA,iBACR;AAAA,eACF;AAAA,aACF;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,eAAiB,EAAA;AAAA,MACf,GAAK,EAAA;AAAA,QACH,IAAM,EAAA,MAAA;AAAA,QACN,MAAQ,EAAA,QAAA;AAAA,QACR,YAAc,EAAA,KAAA;AAAA,QACd,WAAa,EAAA,qCAAA;AAAA,OACf;AAAA,KACF;AAAA,GACF;AACF,EAAA;AACO,MAAM,mBAAsB,GAAA,OACjC,OACG,KAAAA,gDAAA,CAA0C,MAAM,OAAO;;;;;"}

package/dist/service/router.cjs.js

@@ -0,0 +1,125 @@
+'use strict';
+
+var rootHttpRouter = require('@backstage/backend-defaults/rootHttpRouter');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var errors = require('@backstage/errors');
+var pluginPermissionCommon = require('@backstage/plugin-permission-common');
+var pluginPermissionNode = require('@backstage/plugin-permission-node');
+var express = require('express');
+var pluginOcmCommon = require('@backstage-community/plugin-ocm-common');
+var config = require('../helpers/config.cjs.js');
+var kubernetes = require('../helpers/kubernetes.cjs.js');
+var parser = require('../helpers/parser.cjs.js');
+var openapi_generated = require('../schema/openapi.generated.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+
+async function createRouter(deps) {
+  const { config: config$1, logger, httpAuth, permissions } = deps;
+  const router = await openapi_generated.createOpenApiRouter();
+  const permissionsIntegrationRouter = pluginPermissionNode.createPermissionIntegrationRouter({
+    permissions: pluginOcmCommon.ocmEntityPermissions
+  });
+  router.use(express__default.default.json());
+  router.use(permissionsIntegrationRouter);
+  const clients = Object.fromEntries(
+    config.readOcmConfigs(config$1).map((provider) => [
+      provider.id,
+      {
+        client: kubernetes.hubApiClient(provider, logger),
+        hubResourceName: provider.hubResourceName
+      }
+    ])
+  );
+  const authorize = async (request, permission) => {
+    const decision = (await permissions.authorize([{ permission }], {
+      credentials: await httpAuth.credentials(request)
+    }))[0];
+    return decision;
+  };
+  router.get("/status/:providerId/:clusterName", async (request, response) => {
+    const decision = await authorize(request, pluginOcmCommon.ocmEntityReadPermission);
+    if (decision.result === pluginPermissionCommon.AuthorizeResult.DENY) {
+      throw new errors.NotAllowedError("Unauthorized");
+    }
+    const { clusterName, providerId } = request.params;
+    logger.debug(
+      `Incoming status request for ${clusterName} cluster on ${providerId} hub`
+    );
+    if (!clients.hasOwnProperty(providerId)) {
+      throw Object.assign(new Error("Hub not found"), {
+        statusCode: 404,
+        name: "HubNotFound"
+      });
+    }
+    const normalizedClusterName = parser.translateResourceToOCM(
+      clusterName,
+      clients[providerId].hubResourceName
+    );
+    const mc = await kubernetes.getManagedCluster(
+      clients[providerId].client,
+      normalizedClusterName
+    );
+    const mci = await kubernetes.getManagedClusterInfo(
+      clients[providerId].client,
+      normalizedClusterName
+    );
+    response.send({
+      name: clusterName,
+      ...parser.parseManagedCluster(mc),
+      ...parser.parseUpdateInfo(mci)
+    });
+  });
+  router.get("/status", async (request, response) => {
+    const decision = await authorize(request, pluginOcmCommon.ocmClusterReadPermission);
+    if (decision.result === pluginPermissionCommon.AuthorizeResult.DENY) {
+      throw new errors.NotAllowedError("Unauthorized");
+    }
+    logger.debug(`Incoming status request for all clusters`);
+    const allClusters = await Promise.all(
+      Object.values(clients).map(async (c) => {
+        const mcs = await kubernetes.listManagedClusters(c.client);
+        const mcis = await kubernetes.listManagedClusterInfos(c.client);
+        return mcs.items.map((mc) => {
+          const mci = mcis.items.find(
+            (info) => info.metadata?.name === mc.metadata.name
+          ) || {};
+          return {
+            name: parser.translateOCMToResource(mc.metadata.name, c.hubResourceName),
+            status: parser.parseClusterStatus(mc),
+            platform: parser.getClaim(mc, "platform.open-cluster-management.io"),
+            openshiftVersion: mc.metadata.labels?.openshiftVersion ?? parser.getClaim(mc, "version.openshift.io"),
+            nodes: parser.parseNodeStatus(mci),
+            ...parser.parseUpdateInfo(mci)
+          };
+        });
+      })
+    );
+    return response.send(allClusters.flat());
+  });
+  const middleware = rootHttpRouter.MiddlewareFactory.create({ logger, config: config$1 });
+  router.use(middleware.error());
+  return router;
+}
+const ocmPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "ocm",
+  register(env) {
+    env.registerInit({
+      deps: {
+        logger: backendPluginApi.coreServices.logger,
+        config: backendPluginApi.coreServices.rootConfig,
+        http: backendPluginApi.coreServices.httpRouter,
+        httpAuth: backendPluginApi.coreServices.httpAuth,
+        permissions: backendPluginApi.coreServices.permissions
+      },
+      async init({ config, logger, http, httpAuth, permissions }) {
+        http.use(await createRouter({ config, logger, httpAuth, permissions }));
+      }
+    });
+  }
+});
+
+exports.ocmPlugin = ocmPlugin;
+//# sourceMappingURL=router.cjs.js.map

package/dist/service/router.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.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 { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';\nimport {\n  coreServices,\n  createBackendPlugin,\n  HttpAuthService,\n  LoggerService,\n  PermissionsService,\n} from '@backstage/backend-plugin-api';\nimport type { Config } from '@backstage/config';\nimport { NotAllowedError } from '@backstage/errors';\nimport {\n  AuthorizeResult,\n  BasicPermission,\n} from '@backstage/plugin-permission-common';\nimport { createPermissionIntegrationRouter } from '@backstage/plugin-permission-node';\n\nimport express, { Request } from 'express';\n\nimport {\n  Cluster,\n  ClusterOverview,\n  ocmClusterReadPermission,\n  ocmEntityPermissions,\n  ocmEntityReadPermission,\n} from '@backstage-community/plugin-ocm-common';\n\nimport { readOcmConfigs } from '../helpers/config';\nimport {\n  getManagedCluster,\n  getManagedClusterInfo,\n  hubApiClient,\n  listManagedClusterInfos,\n  listManagedClusters,\n} from '../helpers/kubernetes';\nimport {\n  getClaim,\n  parseClusterStatus,\n  parseManagedCluster,\n  parseNodeStatus,\n  parseUpdateInfo,\n  translateOCMToResource,\n  translateResourceToOCM,\n} from '../helpers/parser';\nimport { createOpenApiRouter } from '../schema/openapi.generated';\nimport { ManagedClusterInfo } from '../types';\n\nasync function createRouter(deps: {\n  config: Config;\n  logger: LoggerService;\n  httpAuth: HttpAuthService;\n  permissions: PermissionsService;\n}) {\n  const { config, logger, httpAuth, permissions } = deps;\n  const router = await createOpenApiRouter();\n\n  const permissionsIntegrationRouter = createPermissionIntegrationRouter({\n    permissions: ocmEntityPermissions,\n  });\n\n  router.use(express.json());\n  router.use(permissionsIntegrationRouter);\n\n  const clients = Object.fromEntries(\n    readOcmConfigs(config).map(provider => [\n      provider.id,\n      {\n        client: hubApiClient(provider, logger),\n        hubResourceName: provider.hubResourceName,\n      },\n    ]),\n  );\n\n  const authorize = async (request: Request, permission: BasicPermission) => {\n    const decision = (\n      await permissions.authorize([{ permission: permission }], {\n        credentials: await httpAuth.credentials(request),\n      })\n    )[0];\n\n    return decision;\n  };\n\n  router.get('/status/:providerId/:clusterName', async (request, response) => {\n    const decision = await authorize(request, ocmEntityReadPermission);\n\n    if (decision.result === AuthorizeResult.DENY) {\n      throw new NotAllowedError('Unauthorized');\n    }\n\n    const { clusterName, providerId } = request.params;\n    logger.debug(\n      `Incoming status request for ${clusterName} cluster on ${providerId} hub`,\n    );\n\n    if (!clients.hasOwnProperty(providerId)) {\n      throw Object.assign(new Error('Hub not found'), {\n        statusCode: 404,\n        name: 'HubNotFound',\n      });\n    }\n\n    const normalizedClusterName = translateResourceToOCM(\n      clusterName,\n      clients[providerId].hubResourceName,\n    );\n\n    const mc = await getManagedCluster(\n      clients[providerId].client,\n      normalizedClusterName,\n    );\n    const mci = await getManagedClusterInfo(\n      clients[providerId].client,\n      normalizedClusterName,\n    );\n\n    response.send({\n      name: clusterName,\n      ...parseManagedCluster(mc),\n      ...parseUpdateInfo(mci),\n    } as Cluster);\n  });\n\n  router.get('/status', async (request, response) => {\n    const decision = await authorize(request, ocmClusterReadPermission);\n\n    if (decision.result === AuthorizeResult.DENY) {\n      throw new NotAllowedError('Unauthorized');\n    }\n\n    logger.debug(`Incoming status request for all clusters`);\n\n    const allClusters = await Promise.all(\n      Object.values(clients).map(async c => {\n        const mcs = await listManagedClusters(c.client);\n        const mcis = await listManagedClusterInfos(c.client);\n\n        return mcs.items.map(mc => {\n          const mci =\n            mcis.items.find(\n              info => info.metadata?.name === mc.metadata!.name,\n            ) || ({} as ManagedClusterInfo);\n\n          return {\n            name: translateOCMToResource(mc.metadata!.name!, c.hubResourceName),\n            status: parseClusterStatus(mc),\n            platform: getClaim(mc, 'platform.open-cluster-management.io'),\n            openshiftVersion:\n              mc.metadata!.labels?.openshiftVersion ??\n              getClaim(mc, 'version.openshift.io'),\n            nodes: parseNodeStatus(mci),\n            ...parseUpdateInfo(mci),\n          } as ClusterOverview;\n        });\n      }),\n    );\n\n    return response.send(allClusters.flat());\n  });\n\n  const middleware = MiddlewareFactory.create({ logger, config });\n\n  router.use(middleware.error());\n  return router;\n}\n\nexport const ocmPlugin = createBackendPlugin({\n  pluginId: 'ocm',\n  register(env) {\n    env.registerInit({\n      deps: {\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        http: coreServices.httpRouter,\n        httpAuth: coreServices.httpAuth,\n        permissions: coreServices.permissions,\n      },\n      async init({ config, logger, http, httpAuth, permissions }) {\n        http.use(await createRouter({ config, logger, httpAuth, permissions }));\n      },\n    });\n  },\n});\n"],"names":["config","createOpenApiRouter","createPermissionIntegrationRouter","ocmEntityPermissions","express","readOcmConfigs","hubApiClient","ocmEntityReadPermission","AuthorizeResult","NotAllowedError","translateResourceToOCM","getManagedCluster","getManagedClusterInfo","parseManagedCluster","parseUpdateInfo","ocmClusterReadPermission","listManagedClusters","listManagedClusterInfos","translateOCMToResource","parseClusterStatus","getClaim","parseNodeStatus","MiddlewareFactory","createBackendPlugin","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;AA8DA,eAAe,aAAa,IAKzB,EAAA;AACD,EAAA,MAAM,UAAEA,QAAA,EAAQ,MAAQ,EAAA,QAAA,EAAU,aAAgB,GAAA,IAAA,CAAA;AAClD,EAAM,MAAA,MAAA,GAAS,MAAMC,qCAAoB,EAAA,CAAA;AAEzC,EAAA,MAAM,+BAA+BC,sDAAkC,CAAA;AAAA,IACrE,WAAa,EAAAC,oCAAA;AAAA,GACd,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,4BAA4B,CAAA,CAAA;AAEvC,EAAA,MAAM,UAAU,MAAO,CAAA,WAAA;AAAA,IACrBC,qBAAe,CAAAL,QAAM,CAAE,CAAA,GAAA,CAAI,CAAY,QAAA,KAAA;AAAA,MACrC,QAAS,CAAA,EAAA;AAAA,MACT;AAAA,QACE,MAAA,EAAQM,uBAAa,CAAA,QAAA,EAAU,MAAM,CAAA;AAAA,QACrC,iBAAiB,QAAS,CAAA,eAAA;AAAA,OAC5B;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AAEA,EAAM,MAAA,SAAA,GAAY,OAAO,OAAA,EAAkB,UAAgC,KAAA;AACzE,IAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA,CAAU,CAAC,EAAE,UAAA,EAAwB,CAAG,EAAA;AAAA,MACxD,WAAa,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,OAAO,CAAA;AAAA,KAChD,GACD,CAAC,CAAA,CAAA;AAEH,IAAO,OAAA,QAAA,CAAA;AAAA,GACT,CAAA;AAEA,EAAA,MAAA,CAAO,GAAI,CAAA,kCAAA,EAAoC,OAAO,OAAA,EAAS,QAAa,KAAA;AAC1E,IAAA,MAAM,QAAW,GAAA,MAAM,SAAU,CAAA,OAAA,EAASC,uCAAuB,CAAA,CAAA;AAEjE,IAAI,IAAA,QAAA,CAAS,MAAW,KAAAC,sCAAA,CAAgB,IAAM,EAAA;AAC5C,MAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA,CAAA;AAAA,KAC1C;AAEA,IAAA,MAAM,EAAE,WAAA,EAAa,UAAW,EAAA,GAAI,OAAQ,CAAA,MAAA,CAAA;AAC5C,IAAO,MAAA,CAAA,KAAA;AAAA,MACL,CAAA,4BAAA,EAA+B,WAAW,CAAA,YAAA,EAAe,UAAU,CAAA,IAAA,CAAA;AAAA,KACrE,CAAA;AAEA,IAAA,IAAI,CAAC,OAAA,CAAQ,cAAe,CAAA,UAAU,CAAG,EAAA;AACvC,MAAA,MAAM,MAAO,CAAA,MAAA,CAAO,IAAI,KAAA,CAAM,eAAe,CAAG,EAAA;AAAA,QAC9C,UAAY,EAAA,GAAA;AAAA,QACZ,IAAM,EAAA,aAAA;AAAA,OACP,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,MAAM,qBAAwB,GAAAC,6BAAA;AAAA,MAC5B,WAAA;AAAA,MACA,OAAA,CAAQ,UAAU,CAAE,CAAA,eAAA;AAAA,KACtB,CAAA;AAEA,IAAA,MAAM,KAAK,MAAMC,4BAAA;AAAA,MACf,OAAA,CAAQ,UAAU,CAAE,CAAA,MAAA;AAAA,MACpB,qBAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,MAAM,MAAMC,gCAAA;AAAA,MAChB,OAAA,CAAQ,UAAU,CAAE,CAAA,MAAA;AAAA,MACpB,qBAAA;AAAA,KACF,CAAA;AAEA,IAAA,QAAA,CAAS,IAAK,CAAA;AAAA,MACZ,IAAM,EAAA,WAAA;AAAA,MACN,GAAGC,2BAAoB,EAAE,CAAA;AAAA,MACzB,GAAGC,uBAAgB,GAAG,CAAA;AAAA,KACZ,CAAA,CAAA;AAAA,GACb,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,OAAO,OAAA,EAAS,QAAa,KAAA;AACjD,IAAA,MAAM,QAAW,GAAA,MAAM,SAAU,CAAA,OAAA,EAASC,wCAAwB,CAAA,CAAA;AAElE,IAAI,IAAA,QAAA,CAAS,MAAW,KAAAP,sCAAA,CAAgB,IAAM,EAAA;AAC5C,MAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA,CAAA;AAAA,KAC1C;AAEA,IAAA,MAAA,CAAO,MAAM,CAA0C,wCAAA,CAAA,CAAA,CAAA;AAEvD,IAAM,MAAA,WAAA,GAAc,MAAM,OAAQ,CAAA,GAAA;AAAA,MAChC,OAAO,MAAO,CAAA,OAAO,CAAE,CAAA,GAAA,CAAI,OAAM,CAAK,KAAA;AACpC,QAAA,MAAM,GAAM,GAAA,MAAMO,8BAAoB,CAAA,CAAA,CAAE,MAAM,CAAA,CAAA;AAC9C,QAAA,MAAM,IAAO,GAAA,MAAMC,kCAAwB,CAAA,CAAA,CAAE,MAAM,CAAA,CAAA;AAEnD,QAAO,OAAA,GAAA,CAAI,KAAM,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA;AACzB,UAAM,MAAA,GAAA,GACJ,KAAK,KAAM,CAAA,IAAA;AAAA,YACT,CAAQ,IAAA,KAAA,IAAA,CAAK,QAAU,EAAA,IAAA,KAAS,GAAG,QAAU,CAAA,IAAA;AAAA,eACzC,EAAC,CAAA;AAET,UAAO,OAAA;AAAA,YACL,MAAMC,6BAAuB,CAAA,EAAA,CAAG,QAAU,CAAA,IAAA,EAAO,EAAE,eAAe,CAAA;AAAA,YAClE,MAAA,EAAQC,0BAAmB,EAAE,CAAA;AAAA,YAC7B,QAAA,EAAUC,eAAS,CAAA,EAAA,EAAI,qCAAqC,CAAA;AAAA,YAC5D,kBACE,EAAG,CAAA,QAAA,CAAU,QAAQ,gBACrB,IAAAA,eAAA,CAAS,IAAI,sBAAsB,CAAA;AAAA,YACrC,KAAA,EAAOC,uBAAgB,GAAG,CAAA;AAAA,YAC1B,GAAGP,uBAAgB,GAAG,CAAA;AAAA,WACxB,CAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACF,CAAA;AAAA,KACH,CAAA;AAEA,IAAA,OAAO,QAAS,CAAA,IAAA,CAAK,WAAY,CAAA,IAAA,EAAM,CAAA,CAAA;AAAA,GACxC,CAAA,CAAA;AAED,EAAA,MAAM,aAAaQ,gCAAkB,CAAA,MAAA,CAAO,EAAE,MAAA,UAAQtB,UAAQ,CAAA,CAAA;AAE9D,EAAO,MAAA,CAAA,GAAA,CAAI,UAAW,CAAA,KAAA,EAAO,CAAA,CAAA;AAC7B,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAEO,MAAM,YAAYuB,oCAAoB,CAAA;AAAA,EAC3C,QAAU,EAAA,KAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,MAAMA,6BAAa,CAAA,UAAA;AAAA,QACnB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,aAAaA,6BAAa,CAAA,WAAA;AAAA,OAC5B;AAAA,MACA,MAAM,KAAK,EAAE,MAAA,EAAQ,QAAQ,IAAM,EAAA,QAAA,EAAU,aAAe,EAAA;AAC1D,QAAK,IAAA,CAAA,GAAA,CAAI,MAAM,YAAa,CAAA,EAAE,QAAQ,MAAQ,EAAA,QAAA,EAAU,WAAY,EAAC,CAAC,CAAA,CAAA;AAAA,OACxE;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@backstage-community/plugin-ocm-backend",
+  "version": "5.2.1",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "backstage": {
+    "role": "backend-plugin",
+    "supported-versions": "1.32.4",
+    "pluginId": "ocm",
+    "pluginPackages": [
+      "@backstage-community/plugin-ocm",
+      "@backstage-community/plugin-ocm-backend",
+      "@backstage-community/plugin-ocm-common"
+    ]
+  },
+  "exports": {
+    ".": {
+      "backstage": "@backstage/BackendFeature",
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint:check": "backstage-cli package lint",
+    "lint:fix": "backstage-cli package lint --fix",
+    "postpack": "backstage-cli package postpack",
+    "prepack": "backstage-cli package prepack",
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test --passWithNoTests --coverage",
+    "tsc": "tsc",
+    "prettier:check": "prettier --ignore-unknown --check .",
+    "prettier:fix": "prettier --ignore-unknown --write .",
+    "build:api-docs": "./scripts/openapi-doc.sh",
+    "build:api-server": "yarn backstage-repo-tools package schema openapi generate --server"
+  },
+  "configSchema": "config.d.ts",
+  "dependencies": {
+    "@backstage-community/plugin-ocm-common": "^3.6.1",
+    "@backstage/backend-defaults": "^0.5.2",
+    "@backstage/backend-openapi-utils": "^0.2.0",
+    "@backstage/backend-plugin-api": "^1.0.1",
+    "@backstage/catalog-model": "^1.7.0",
+    "@backstage/errors": "^1.2.4",
+    "@backstage/plugin-catalog-node": "^1.13.1",
+    "@backstage/plugin-permission-common": "^0.8.1",
+    "@backstage/plugin-permission-node": "^0.8.4",
+    "@kubernetes/client-node": "^0.22.1",
+    "express": "^4.18.2",
+    "semver": "^7.5.4"
+  },
+  "devDependencies": {
+    "@backstage/backend-dynamic-feature-service": "0.4.3",
+    "@backstage/backend-test-utils": "1.0.2",
+    "@backstage/cli": "0.28.2",
+    "@backstage/config": "1.2.0",
+    "@backstage/plugin-catalog-backend": "1.27.1",
+    "@openapitools/openapi-generator-cli": "2.13.4",
+    "@spotify/prettier-config": "^15.0.0",
+    "@types/express": "4.17.21",
+    "@types/supertest": "2.0.16",
+    "msw": "1.3.3",
+    "prettier": "3.3.3",
+    "supertest": "6.3.4"
+  },
+  "files": [
+    "dist",
+    "config.d.ts"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/ocm/plugins/ocm-backend"
+  },
+  "keywords": [
+    "support:production",
+    "lifecycle:active",
+    "backstage",
+    "plugin"
+  ],
+  "homepage": "https://red.ht/rhdh",
+  "bugs": "https://github.com/backstage/community-plugins/issues",
+  "maintainers": [
+    "@04kash"
+  ],
+  "author": "Red Hat"
+}