@backstage/plugin-kubernetes 0.6.5-next.1 → 0.6.5

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @backstage/plugin-kubernetes
 
+## 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
+
+- 1ef98cfe48: add Azure Identity auth provider and AKS dashboard formatter
+- Updated dependencies
+  - @backstage/core-components@0.9.4-next.1
+  - @backstage/plugin-kubernetes-common@0.2.10-next.0
+  - @backstage/config@1.0.1-next.0
+  - @backstage/plugin-catalog-react@1.1.0-next.2
+  - @backstage/catalog-model@1.0.2-next.0
+  - @backstage/core-plugin-api@1.0.2-next.1
+
 ## 0.6.5-next.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /// <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';
@@ -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>;
 }

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';
@@ -108,6 +108,30 @@ class GoogleServiceAccountAuthProvider {
   }
 }
 
+class AzureKubernetesAuthProvider {
+  async decorateRequestBodyForAuth(requestBody) {
+    return requestBody;
+  }
+}
+
+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();
@@ -115,12 +139,21 @@ class KubernetesAuthProviders {
     this.kubernetesAuthProviderMap.set("serviceAccount", new ServiceAccountKubernetesAuthProvider());
     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`);
   }
 }
@@ -141,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 });
       }
     })
   ],
@@ -582,7 +631,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
@@ -727,8 +776,29 @@ function openshiftFormatter(options) {
   return new URL(path, basePath);
 }
 
-function aksFormatter(_options) {
-  throw new Error("AKS formatter is not yet implemented. Please, contribute!");
+const basePath = "https://portal.azure.com/#blade/Microsoft_Azure_ContainerService/AksK8ResourceMenuBlade/overview-Deployment/aksClusterId";
+const requiredParams = ["subscriptionId", "resourceGroup", "clusterName"];
+function aksFormatter(options) {
+  if (!options.dashboardParameters) {
+    throw new Error("AKS dashboard requires a dashboardParameters option");
+  }
+  const args = options.dashboardParameters;
+  for (const param of requiredParams) {
+    if (typeof args[param] !== "string") {
+      throw new Error(`AKS dashboard requires a "${param}" of type string in the dashboardParameters option`);
+    }
+  }
+  const path = `/subscriptions/${args.subscriptionId}/resourceGroups/${args.resourceGroup}/providers/Microsoft.ContainerService/managedClusters/${args.clusterName}`;
+  const { name, namespace, uid } = options.object.metadata;
+  const { selector } = options.object.spec;
+  const params = {
+    kind: options.kind,
+    metadata: { name, namespace, uid },
+    spec: {
+      selector
+    }
+  };
+  return new URL(`${basePath}/${encodeURIComponent(path)}/resource/${encodeURIComponent(JSON.stringify(params))}`);
 }
 
 function eksFormatter(_options) {