feat(ocm): Install and configure the ocm plugin

app-config.yaml

@@ -115,3 +115,9 @@ kubernetes:
           authProvider: 'serviceAccount'
           skipTLSVerify: true
           serviceAccountToken: ${K8S_CLUSTER_TOKEN}
+
+ocm:
+  hub:
+    name: ${OCM_HUB_NAME}
+    url: ${OCM_HUB_URL}
+    serviceAccountToken: ${moc_infra_token}

manifests/base/externalsecret.yaml

@@ -7,6 +7,8 @@ spec:
     - extract:
         conversionStrategy: Default
         key: moc/smaug/janus-idp/values-app-config
+    - extract:
+        key: moc/smaug/service-catalog/k8s-plugin-tokens
   refreshInterval: 60s
   secretStoreRef:
     kind: SecretStore

packages/app/package.json

@@ -42,6 +42,7 @@
     "@backstage/plugin-techdocs-react": "^1.1.2",
     "@backstage/plugin-user-settings": "^0.6.2",
     "@backstage/theme": "^0.2.16",
+    "@janus-idp/backstage-plugin-ocm": "^1.1.1",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@roadiehq/backstage-plugin-argo-cd": "^2.2.6",

packages/app/src/App.tsx

@@ -37,6 +37,8 @@ import { CssBaseline, ThemeProvider } from '@material-ui/core';
 import { janusTheme } from './themes/janus';
 import { HomePage } from './components/home/HomePage';
 import { HomepageCompositionRoot } from '@backstage/plugin-home';
+import { OcmPage } from '@janus-idp/backstage-plugin-ocm';
+import Logo from './components/Root/LogoIcon';
 
 const app = createApp({
   apis,
@@ -110,6 +112,7 @@ const routes = (
     </Route>
     <Route path="/settings" element={<UserSettingsPage />} />
     <Route path="/catalog-graph" element={<CatalogGraphPage />} />
+    <Route path="/ocm" element={<OcmPage logo={<Logo />} />} />
   </FlatRoutes>
 );
 

packages/app/src/components/Root/Root.tsx

@@ -3,6 +3,7 @@ import { makeStyles } from '@material-ui/core';
 import AppsIcon from '@material-ui/icons/Apps';
 import HomeIcon from '@material-ui/icons/Home';
 import ExtensionIcon from '@material-ui/icons/Extension';
+import StorageIcon from '@material-ui/icons/Storage';
 import MapIcon from '@material-ui/icons/MyLocation';
 import LibraryBooks from '@material-ui/icons/LibraryBooks';
 import CreateComponentIcon from '@material-ui/icons/AddCircleOutline';
@@ -70,6 +71,7 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
         <SidebarItem icon={AppsIcon} to="catalog" text="Catalog" />
         <SidebarItem icon={ExtensionIcon} to="api-docs" text="APIs" />
         <SidebarItem icon={LibraryBooks} to="docs" text="Docs" />
+        <SidebarItem icon={StorageIcon} to="ocm" text="Clusters" />
         <SidebarItem icon={CreateComponentIcon} to="create" text="Create..." />
         {/* End global nav */}
         <SidebarDivider />

packages/app/src/components/catalog/EntityPage.tsx

@@ -70,6 +70,14 @@ import {
   EntityArgoCDOverviewCard,
   EntityArgoCDHistoryCard,
 } from '@roadiehq/backstage-plugin-argo-cd';
+import {
+  ClusterAllocatableResourceCard,
+  ClusterAvailableResourceCard,
+  ClusterContextProvider,
+  ClusterInfoCard,
+  ClusterStatusCard,
+} from '@janus-idp/backstage-plugin-ocm';
+import { isType } from './utils';
 
 const techdocsContent = (
   <EntityTechdocsContent>
@@ -420,6 +428,49 @@ const domainPage = (
   </EntityLayout>
 );
 
+const resourcePage = (
+  <EntityLayout>
+    <EntityLayout.Route path="/" title="Overview">
+      <Grid container spacing={3} alignItems="stretch">
+        {entityWarningContent}
+        <Grid item md={6}>
+          <EntityAboutCard variant="gridItem" />
+        </Grid>
+        <Grid item md={6} xs={12}>
+          <EntityCatalogGraphCard variant="gridItem" height={400} />
+        </Grid>
+        <Grid item md={6}>
+          <EntityHasSystemsCard variant="gridItem" />
+        </Grid>
+      </Grid>
+    </EntityLayout.Route>
+    <EntityLayout.Route path="/status" title="status">
+      <EntitySwitch>
+        <EntitySwitch.Case if={isType('kubernetes-cluster')}>
+          <ClusterContextProvider>
+            <Grid container>
+              <Grid container item direction="column" xs={3}>
+                <Grid item>
+                  <ClusterStatusCard />
+                </Grid>
+                <Grid item>
+                  <ClusterAllocatableResourceCard />
+                </Grid>
+                <Grid item>
+                  <ClusterAvailableResourceCard />
+                </Grid>
+              </Grid>
+              <Grid item xs>
+                <ClusterInfoCard />
+              </Grid>
+            </Grid>
+          </ClusterContextProvider>
+        </EntitySwitch.Case>
+      </EntitySwitch>
+    </EntityLayout.Route>
+  </EntityLayout>
+);
+
 export const entityPage = (
   <EntitySwitch>
     <EntitySwitch.Case if={isKind('component')} children={componentPage} />
@@ -428,6 +479,7 @@ export const entityPage = (
     <EntitySwitch.Case if={isKind('user')} children={userPage} />
     <EntitySwitch.Case if={isKind('system')} children={systemPage} />
     <EntitySwitch.Case if={isKind('domain')} children={domainPage} />
+    <EntitySwitch.Case if={isKind('resource')} children={resourcePage} />
 
     <EntitySwitch.Case>{defaultEntityPage}</EntitySwitch.Case>
   </EntitySwitch>

packages/app/src/components/catalog/utils.tsx

@@ -0,0 +1,10 @@
+import { Entity } from '@backstage/catalog-model';
+
+export const isType = (types: string | string[]) => (entity: Entity) => {
+  if (!entity?.spec?.type) {
+    return false;
+  }
+  return typeof types === 'string'
+    ? entity?.spec?.type === types
+    : types.includes(entity.spec.type as string);
+};

packages/backend/package.json

@@ -34,6 +34,7 @@
     "@backstage/plugin-search-backend-module-pg": "^0.5.2",
     "@backstage/plugin-search-backend-node": "^1.1.2",
     "@backstage/plugin-techdocs-backend": "^1.5.2",
+    "@janus-idp/backstage-plugin-ocm-backend": "^1.3.0",
     "app": "link:../app",
     "better-sqlite3": "^8.0.0",
     "dockerode": "^3.3.1",

packages/backend/src/index.ts

@@ -32,6 +32,7 @@ import kubernetes from './plugins/kubernetes';
 import { PluginEnvironment } from './types';
 import { ServerPermissionClient } from '@backstage/plugin-permission-node';
 import { DefaultIdentityClient } from '@backstage/plugin-auth-node';
+import ocm from './plugins/ocm';
 
 function makeCreateEnv(config: Config) {
   const root = getRootLogger();
@@ -87,6 +88,7 @@ async function main() {
   const searchEnv = useHotMemoize(module, () => createEnv('search'));
   const appEnv = useHotMemoize(module, () => createEnv('app'));
   const kubernetesEnv = useHotMemoize(module, () => createEnv('kubernetes'));
+  const ocmEnv = useHotMemoize(module, () => createEnv('ocm'));
 
   const apiRouter = Router();
   apiRouter.use('/catalog', await catalog(catalogEnv));
@@ -96,6 +98,7 @@ async function main() {
   apiRouter.use('/proxy', await proxy(proxyEnv));
   apiRouter.use('/search', await search(searchEnv));
   apiRouter.use('/kubernetes', await kubernetes(kubernetesEnv));
+  apiRouter.use('/ocm', await ocm(ocmEnv));
 
   // Add backends ABOVE this line; this 404 handler is the catch-all fallback
   apiRouter.use(notFoundHandler());

packages/backend/src/plugins/catalog.ts

@@ -1,14 +1,27 @@
 import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
 import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backend';
+import { ManagedClusterProvider } from '@janus-idp/backstage-plugin-ocm-backend';
 import { Router } from 'express';
 import { PluginEnvironment } from '../types';
 
 export default async function createPlugin(
   env: PluginEnvironment,
 ): Promise<Router> {
   const builder = await CatalogBuilder.create(env);
+  const ocm = ManagedClusterProvider.fromConfig(env.config, {
+    logger: env.logger,
+  });
+  builder.addEntityProvider(ocm);
   builder.addProcessor(new ScaffolderEntitiesProcessor());
   const { processingEngine, router } = await builder.build();
   await processingEngine.start();
+  await env.scheduler.scheduleTask({
+    id: 'run_ocm_refresh',
+    fn: async () => {
+      await ocm.run();
+    },
+    frequency: { minutes: 30 },
+    timeout: { minutes: 10 },
+  });
   return router;
 }

packages/backend/src/plugins/ocm.ts

@@ -0,0 +1,12 @@
+import { createRouter } from '@janus-idp/backstage-plugin-ocm-backend';
+import { Router } from 'express';
+import { PluginEnvironment } from '../types';
+
+export default async function createPlugin(
+  env: PluginEnvironment,
+): Promise<Router> {
+  return await createRouter({
+    logger: env.logger,
+    config: env.config,
+  });
+}