@backstage/plugin-kubernetes 0.6.5-next.2 → 0.6.6-next.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @backstage/plugin-kubernetes
 
+## 0.6.6-next.0
+
+### Patch Changes
+
+- 4328737af6: Add support to fetch data for Stateful Sets and display an accordion in the same way as with Deployments
+- 81304e3e91: Fix for HPA matching when deploying same HPA in multiple namespaces
+- Updated dependencies
+  - @backstage/plugin-catalog-react@1.1.1-next.0
+  - @backstage/core-components@0.9.5-next.0
+  - @backstage/plugin-kubernetes-common@0.3.0-next.0
+
+## 0.6.5
+
+### Patch Changes
+
+- 1ef98cfe48: add Azure Identity auth provider and AKS dashboard formatter
+- 447e060872: Add support for 'oidc' as authProvider for kubernetes authentication
+  and adds optional 'oidcTokenProvider' config value. This will allow
+  users to authenticate to kubernetes cluster using id tokens obtained
+  from the configured auth provider in their backstage instance.
+- Updated dependencies
+  - @backstage/core-components@0.9.4
+  - @backstage/plugin-kubernetes-common@0.2.10
+  - @backstage/core-plugin-api@1.0.2
+  - @backstage/plugin-catalog-react@1.1.0
+  - @backstage/config@1.0.1
+  - @backstage/catalog-model@1.0.2
+
+## 0.6.5-next.3
+
+### Patch Changes
+
+- 447e060872: Add support for 'oidc' as authProvider for kubernetes authentication
+  and adds optional 'oidcTokenProvider' config value. This will allow
+  users to authenticate to kubernetes cluster using id tokens obtained
+  from the configured auth provider in their backstage instance.
+- Updated dependencies
+  - @backstage/plugin-kubernetes-common@0.2.10-next.1
+  - @backstage/core-components@0.9.4-next.2
+
 ## 0.6.5-next.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="react" />
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
-import { DiscoveryApi, IdentityApi, OAuthApi } from '@backstage/core-plugin-api';
+import { DiscoveryApi, IdentityApi, OAuthApi, OpenIdConnectApi } from '@backstage/core-plugin-api';
 import { Entity } from '@backstage/catalog-model';
 import { KubernetesRequestBody, ObjectsByEntityResponse, ClusterObjects, ClientPodStatus, ClusterAttributes } from '@backstage/plugin-kubernetes-common';
 import { JsonObject } from '@backstage/types';
-import { V1Pod, V1ReplicaSet, V1Deployment, V1HorizontalPodAutoscaler, V1Service, V1ConfigMap, V1Ingress, V1Job, V1CronJob, V1ObjectMeta } from '@kubernetes/client-node';
+import { V1Pod, V1ReplicaSet, V1Deployment, V1HorizontalPodAutoscaler, V1Service, V1ConfigMap, V1Ingress, V1Job, V1CronJob, V1StatefulSet, V1ObjectMeta } from '@kubernetes/client-node';
 import React from 'react';
 
 declare const kubernetesPlugin: _backstage_core_plugin_api.BackstagePlugin<{
@@ -22,6 +22,7 @@ interface KubernetesApi {
     getClusters(): Promise<{
         name: string;
         authProvider: string;
+        oidcTokenProvider?: string | undefined;
     }[]>;
 }
 
@@ -53,6 +54,9 @@ declare class KubernetesAuthProviders implements KubernetesAuthProvidersApi {
     private readonly kubernetesAuthProviderMap;
     constructor(options: {
         googleAuthApi: OAuthApi;
+        oidcProviders?: {
+            [key: string]: OpenIdConnectApi;
+        };
     });
     decorateRequestBodyForAuth(authProvider: string, requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
 }
@@ -97,6 +101,7 @@ interface GroupedResponses extends DeploymentResources {
     jobs: V1Job[];
     cronJobs: V1CronJob[];
     customResources: any[];
+    statefulsets: V1StatefulSet[];
 }
 interface ClusterLinksFormatterOptions {
     dashboardUrl?: URL;

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import { createApiRef, createRouteRef, createPlugin, createApiFactory, discoveryApiRef, identityApiRef, googleAuthApiRef, createRoutableExtension, useApi } from '@backstage/core-plugin-api';
+import { createApiRef, createRouteRef, createPlugin, createApiFactory, discoveryApiRef, identityApiRef, googleAuthApiRef, microsoftAuthApiRef, oktaAuthApiRef, oneloginAuthApiRef, createRoutableExtension, useApi } from '@backstage/core-plugin-api';
 import * as React from 'react';
 import React__default, { Fragment, useState, useEffect, useContext } from 'react';
 import { useEntity } from '@backstage/plugin-catalog-react';
@@ -114,6 +114,24 @@ class AzureKubernetesAuthProvider {
   }
 }
 
+class OidcKubernetesAuthProvider {
+  constructor(providerName, authProvider) {
+    this.providerName = providerName;
+    this.authProvider = authProvider;
+  }
+  async decorateRequestBodyForAuth(requestBody) {
+    const authToken = await this.authProvider.getIdToken();
+    const auth = { ...requestBody.auth };
+    if (auth.oidc) {
+      auth.oidc[this.providerName] = authToken;
+    } else {
+      auth.oidc = { [this.providerName]: authToken };
+    }
+    requestBody.auth = auth;
+    return requestBody;
+  }
+}
+
 class KubernetesAuthProviders {
   constructor(options) {
     this.kubernetesAuthProviderMap = /* @__PURE__ */ new Map();
@@ -122,12 +140,20 @@ class KubernetesAuthProviders {
     this.kubernetesAuthProviderMap.set("googleServiceAccount", new GoogleServiceAccountAuthProvider());
     this.kubernetesAuthProviderMap.set("aws", new AwsKubernetesAuthProvider());
     this.kubernetesAuthProviderMap.set("azure", new AzureKubernetesAuthProvider());
+    if (options.oidcProviders) {
+      Object.keys(options.oidcProviders).forEach((provider) => {
+        this.kubernetesAuthProviderMap.set(`oidc.${provider}`, new OidcKubernetesAuthProvider(provider, options.oidcProviders[provider]));
+      });
+    }
   }
   async decorateRequestBodyForAuth(authProvider, requestBody) {
     const kubernetesAuthProvider = this.kubernetesAuthProviderMap.get(authProvider);
     if (kubernetesAuthProvider) {
       return await kubernetesAuthProvider.decorateRequestBodyForAuth(requestBody);
     }
+    if (authProvider.startsWith("oidc.")) {
+      throw new Error(`KubernetesAuthProviders has no oidcProvider configured for ${authProvider}`);
+    }
     throw new Error(`authProvider "${authProvider}" has no KubernetesAuthProvider defined for it`);
   }
 }
@@ -148,9 +174,25 @@ const kubernetesPlugin = createPlugin({
     }),
     createApiFactory({
       api: kubernetesAuthProvidersApiRef,
-      deps: { googleAuthApi: googleAuthApiRef },
-      factory: ({ googleAuthApi }) => {
-        return new KubernetesAuthProviders({ googleAuthApi });
+      deps: {
+        googleAuthApi: googleAuthApiRef,
+        microsoftAuthApi: microsoftAuthApiRef,
+        oktaAuthApi: oktaAuthApiRef,
+        oneloginAuthApi: oneloginAuthApiRef
+      },
+      factory: ({
+        googleAuthApi,
+        microsoftAuthApi,
+        oktaAuthApi,
+        oneloginAuthApi
+      }) => {
+        const oidcProviders = {
+          google: googleAuthApi,
+          microsoft: microsoftAuthApi,
+          okta: oktaAuthApi,
+          onelogin: oneloginAuthApi
+        };
+        return new KubernetesAuthProviders({ googleAuthApi, oidcProviders });
       }
     })
   ],
@@ -298,6 +340,9 @@ const groupResponses = (fetchResponse) => {
       case "customresources":
         prev.customResources.push(...next.resources);
         break;
+      case "statefulsets":
+        prev.statefulsets.push(...next.resources);
+        break;
     }
     return prev;
   }, {
@@ -310,7 +355,8 @@ const groupResponses = (fetchResponse) => {
     ingresses: [],
     jobs: [],
     cronJobs: [],
-    customResources: []
+    customResources: [],
+    statefulsets: []
   });
 };
 
@@ -589,7 +635,7 @@ const useKubernetesObjects = (entity, intervalMs = 1e4) => {
       return;
     }
     const authProviders = [
-      ...new Set(clusters.map((c) => c.authProvider))
+      ...new Set(clusters.map((c) => `${c.authProvider}${c.oidcTokenProvider ? `.${c.oidcTokenProvider}` : ""}`))
     ];
     let requestBody = {
       entity
@@ -635,7 +681,8 @@ const GroupedResponsesContext = React__default.createContext({
   ingresses: [],
   jobs: [],
   cronJobs: [],
-  customResources: []
+  customResources: [],
+  statefulsets: []
 });
 
 const ClusterContext = React__default.createContext({
@@ -647,7 +694,8 @@ const kindMappings$3 = {
   pod: "pod",
   ingress: "ingress",
   service: "service",
-  horizontalpodautoscaler: "deployment"
+  horizontalpodautoscaler: "deployment",
+  statefulset: "statefulset"
 };
 function standardFormatter(options) {
   var _a, _b, _c, _d;
@@ -1199,10 +1247,10 @@ const getOwnedPodsThroughReplicaSets = (potentialOwner, replicaSets, pods) => {
     return accum.concat(getOwnedResources(rs, pods));
   }, []);
 };
-const getMatchingHpa = (ownerName, ownerKind, hpas) => {
+const getMatchingHpa = (owner, hpas) => {
   return hpas.find((hpa) => {
-    var _a, _b, _c, _d, _e, _f;
-    return ((_c = (_b = (_a = hpa.spec) == null ? void 0 : _a.scaleTargetRef) == null ? void 0 : _b.kind) != null ? _c : "").toLocaleLowerCase("en-US") === ownerKind.toLocaleLowerCase("en-US") && ((_f = (_e = (_d = hpa.spec) == null ? void 0 : _d.scaleTargetRef) == null ? void 0 : _e.name) != null ? _f : "") === (ownerName != null ? ownerName : "unknown-deployment");
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
+    return ((_c = (_b = (_a = hpa.spec) == null ? void 0 : _a.scaleTargetRef) == null ? void 0 : _b.kind) != null ? _c : "").toLocaleLowerCase("en-US") === owner.kind.toLocaleLowerCase("en-US") && ((_e = (_d = hpa.metadata) == null ? void 0 : _d.namespace) != null ? _e : "") === ((_f = owner.namespace) != null ? _f : "unknown-namespace") && ((_i = (_h = (_g = hpa.spec) == null ? void 0 : _g.scaleTargetRef) == null ? void 0 : _h.name) != null ? _i : "") === ((_j = owner.name) != null ? _j : "unknown-deployment");
   });
 };
 
@@ -1298,7 +1346,7 @@ const DeploymentsAccordions = ({}) => {
     justifyContent: "flex-start",
     alignItems: "flex-start"
   }, groupedResponses.deployments.map((deployment, i) => {
-    var _a;
+    var _a, _b;
     return /* @__PURE__ */ React__default.createElement(Grid, {
       container: true,
       item: true,
@@ -1308,13 +1356,178 @@ const DeploymentsAccordions = ({}) => {
       item: true,
       xs: true
     }, /* @__PURE__ */ React__default.createElement(DeploymentAccordion, {
-      matchingHpa: getMatchingHpa((_a = deployment.metadata) == null ? void 0 : _a.name, "deployment", groupedResponses.horizontalPodAutoscalers),
+      matchingHpa: getMatchingHpa({
+        name: (_a = deployment.metadata) == null ? void 0 : _a.name,
+        namespace: (_b = deployment.metadata) == null ? void 0 : _b.namespace,
+        kind: "deployment"
+      }, groupedResponses.horizontalPodAutoscalers),
       ownedPods: getOwnedPodsThroughReplicaSets(deployment, groupedResponses.replicaSets, groupedResponses.pods),
       deployment
     })));
   }));
 };
 
+const StatefulSetDrawer = ({
+  statefulset,
+  expanded
+}) => {
+  var _a, _b, _c;
+  const namespace = (_a = statefulset.metadata) == null ? void 0 : _a.namespace;
+  return /* @__PURE__ */ React__default.createElement(KubernetesDrawer, {
+    object: statefulset,
+    expanded,
+    kind: "StatefulSet",
+    renderObject: (statefulsetObj) => {
+      var _a2, _b2, _c2, _d, _e, _f, _g, _h, _i, _j, _k, _l;
+      const conditions = ((_b2 = (_a2 = statefulsetObj.status) == null ? void 0 : _a2.conditions) != null ? _b2 : []).map(renderCondition).reduce((accum, next) => {
+        accum[next[0]] = next[1];
+        return accum;
+      }, {});
+      return {
+        updateStrategy: (_d = (_c2 = statefulset.spec) == null ? void 0 : _c2.updateStrategy) != null ? _d : "???",
+        podManagementPolicy: (_f = (_e = statefulset.spec) == null ? void 0 : _e.podManagementPolicy) != null ? _f : "???",
+        serviceName: (_h = (_g = statefulset.spec) == null ? void 0 : _g.serviceName) != null ? _h : "???",
+        selector: (_j = (_i = statefulset.spec) == null ? void 0 : _i.selector) != null ? _j : "???",
+        revisionHistoryLimit: (_l = (_k = statefulset.spec) == null ? void 0 : _k.revisionHistoryLimit) != null ? _l : "???",
+        ...conditions
+      };
+    }
+  }, /* @__PURE__ */ React__default.createElement(Grid, {
+    container: true,
+    direction: "column",
+    justifyContent: "flex-start",
+    alignItems: "flex-start",
+    spacing: 0
+  }, /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true
+  }, /* @__PURE__ */ React__default.createElement(Typography, {
+    variant: "h5"
+  }, (_c = (_b = statefulset.metadata) == null ? void 0 : _b.name) != null ? _c : "unknown object")), /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true
+  }, /* @__PURE__ */ React__default.createElement(Typography, {
+    color: "textSecondary",
+    variant: "body1"
+  }, "Stateful Set")), namespace && /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true
+  }, /* @__PURE__ */ React__default.createElement(Chip, {
+    size: "small",
+    label: `namespace: ${namespace}`
+  }))));
+};
+
+const StatefulSetSummary = ({
+  statefulset,
+  numberOfCurrentPods,
+  numberOfPodsWithErrors,
+  hpa
+}) => {
+  var _a, _b, _c, _d, _e, _f, _g, _h;
+  return /* @__PURE__ */ React__default.createElement(Grid, {
+    container: true,
+    direction: "row",
+    justifyContent: "flex-start",
+    alignItems: "center"
+  }, /* @__PURE__ */ React__default.createElement(Grid, {
+    xs: 3,
+    item: true
+  }, /* @__PURE__ */ React__default.createElement(StatefulSetDrawer, {
+    statefulset
+  })), /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true,
+    xs: 1
+  }, /* @__PURE__ */ React__default.createElement(Divider, {
+    style: { height: "5em" },
+    orientation: "vertical"
+  })), hpa && /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true,
+    xs: 3
+  }, /* @__PURE__ */ React__default.createElement(HorizontalPodAutoscalerDrawer, {
+    hpa
+  }, /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true,
+    container: true,
+    direction: "column",
+    justifyContent: "flex-start",
+    alignItems: "flex-start",
+    spacing: 0
+  }, /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true
+  }, /* @__PURE__ */ React__default.createElement(Typography, {
+    variant: "subtitle2"
+  }, "min replicas ", (_b = (_a = hpa.spec) == null ? void 0 : _a.minReplicas) != null ? _b : "?", " / max replicas", " ", (_d = (_c = hpa.spec) == null ? void 0 : _c.maxReplicas) != null ? _d : "?")), /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true
+  }, /* @__PURE__ */ React__default.createElement(Typography, {
+    variant: "subtitle2"
+  }, "current CPU usage:", " ", (_f = (_e = hpa.status) == null ? void 0 : _e.currentCPUUtilizationPercentage) != null ? _f : "?", "%")), /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true
+  }, /* @__PURE__ */ React__default.createElement(Typography, {
+    variant: "subtitle2"
+  }, "target CPU usage:", " ", (_h = (_g = hpa.spec) == null ? void 0 : _g.targetCPUUtilizationPercentage) != null ? _h : "?", "%"))))), /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true,
+    container: true,
+    xs: 3,
+    direction: "column",
+    justifyContent: "flex-start",
+    alignItems: "flex-start"
+  }, /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true
+  }, /* @__PURE__ */ React__default.createElement(StatusOK, null, numberOfCurrentPods, " pods")), /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true
+  }, numberOfPodsWithErrors > 0 ? /* @__PURE__ */ React__default.createElement(StatusError, null, numberOfPodsWithErrors, " pod", numberOfPodsWithErrors > 1 ? "s" : "", " with errors") : /* @__PURE__ */ React__default.createElement(StatusOK, null, "No pods with errors"))));
+};
+const StatefulSetAccordion = ({
+  statefulset,
+  ownedPods,
+  matchingHpa
+}) => {
+  const podNamesWithErrors = useContext(PodNamesWithErrorsContext);
+  const podsWithErrors = ownedPods.filter((p) => {
+    var _a, _b;
+    return podNamesWithErrors.has((_b = (_a = p.metadata) == null ? void 0 : _a.name) != null ? _b : "");
+  });
+  return /* @__PURE__ */ React__default.createElement(Accordion, {
+    TransitionProps: { unmountOnExit: true }
+  }, /* @__PURE__ */ React__default.createElement(AccordionSummary, {
+    expandIcon: /* @__PURE__ */ React__default.createElement(ExpandMoreIcon, null)
+  }, /* @__PURE__ */ React__default.createElement(StatefulSetSummary, {
+    statefulset,
+    numberOfCurrentPods: ownedPods.length,
+    numberOfPodsWithErrors: podsWithErrors.length,
+    hpa: matchingHpa
+  })), /* @__PURE__ */ React__default.createElement(AccordionDetails, null, /* @__PURE__ */ React__default.createElement(PodsTable, {
+    pods: ownedPods,
+    extraColumns: [READY_COLUMNS, RESOURCE_COLUMNS]
+  })));
+};
+const StatefulSetsAccordions = ({}) => {
+  const groupedResponses = useContext(GroupedResponsesContext);
+  return /* @__PURE__ */ React__default.createElement(Grid, {
+    container: true,
+    direction: "column",
+    justifyContent: "flex-start",
+    alignItems: "flex-start"
+  }, groupedResponses.statefulsets.map((statefulset, i) => {
+    var _a, _b;
+    return /* @__PURE__ */ React__default.createElement(Grid, {
+      container: true,
+      item: true,
+      key: i,
+      xs: true
+    }, /* @__PURE__ */ React__default.createElement(Grid, {
+      item: true,
+      xs: true
+    }, /* @__PURE__ */ React__default.createElement(StatefulSetAccordion, {
+      matchingHpa: getMatchingHpa({
+        name: (_a = statefulset.metadata) == null ? void 0 : _a.name,
+        namespace: (_b = statefulset.metadata) == null ? void 0 : _b.namespace,
+        kind: "statefulset"
+      }, groupedResponses.horizontalPodAutoscalers),
+      ownedPods: getOwnedResources(statefulset, groupedResponses.pods),
+      statefulset
+    })));
+  }));
+};
+
 const IngressDrawer = ({
   ingress,
   expanded
@@ -1911,7 +2124,7 @@ const RolloutAccordions = ({
     justifyContent: "flex-start",
     alignItems: "flex-start"
   }, rollouts.map((rollout, i) => {
-    var _a;
+    var _a, _b;
     return /* @__PURE__ */ React__default.createElement(Grid, {
       container: true,
       item: true,
@@ -1922,7 +2135,11 @@ const RolloutAccordions = ({
       xs: true
     }, /* @__PURE__ */ React__default.createElement(RolloutAccordion, {
       defaultExpanded,
-      matchingHpa: getMatchingHpa((_a = rollout.metadata) == null ? void 0 : _a.name, "rollout", groupedResponses.horizontalPodAutoscalers),
+      matchingHpa: getMatchingHpa({
+        name: (_a = rollout.metadata) == null ? void 0 : _a.name,
+        namespace: (_b = rollout.metadata) == null ? void 0 : _b.namespace,
+        kind: "rollout"
+      }, groupedResponses.horizontalPodAutoscalers),
       ownedPods: getOwnedPodsThroughReplicaSets(rollout, groupedResponses.replicaSets, groupedResponses.pods),
       rollout
     })));
@@ -2130,6 +2347,8 @@ const Cluster = ({ clusterObjects, podsWithErrors }) => {
     item: true
   }, /* @__PURE__ */ React__default.createElement(DeploymentsAccordions, null)), /* @__PURE__ */ React__default.createElement(Grid, {
     item: true
+  }, /* @__PURE__ */ React__default.createElement(StatefulSetsAccordions, null)), /* @__PURE__ */ React__default.createElement(Grid, {
+    item: true
   }, /* @__PURE__ */ React__default.createElement(IngressesAccordions, null)), /* @__PURE__ */ React__default.createElement(Grid, {
     item: true
   }, /* @__PURE__ */ React__default.createElement(ServicesAccordions, null)), /* @__PURE__ */ React__default.createElement(Grid, {