@backstage/plugin-kubernetes-react 0.2.1-next.1 → 0.3.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/plugin-kubernetes-react
 
+## 0.3.0-next.0
+
+### Minor Changes
+
+- 0d526c8: **BREAKING** The pod exec terminal is now disabled by default since there are several scenarios where it is known not to work. It can be re-enabled at your own risk by setting the config parameter `kubernetes.podExecTerminal.enabled` to `true`.
+
+### Patch Changes
+
+- 536f67d: Fix broken XtermJS CSS import
+- db1054b: Fixed a bug where the logs dialog and any other functionality depending on the proxy endpoint would fail for clusters configured with the OIDC auth provider.
+- Updated dependencies
+  - @backstage/plugin-kubernetes-common@0.7.4-next.0
+  - @backstage/core-components@0.13.10
+  - @backstage/catalog-model@1.4.3
+  - @backstage/core-plugin-api@1.8.2
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+
+## 0.2.1
+
+### Patch Changes
+
+- d5d2c67: Add `authuser` search parameter to GKE cluster link formatter in k8s plugin
+
+  Thanks to this, people with multiple simultaneously logged-in accounts in their GCP console will automatically view objects with the same email as the one signed in to the Google auth provider in Backstage.
+
+- Updated dependencies
+  - @backstage/core-components@0.13.10
+  - @backstage/core-plugin-api@1.8.2
+  - @backstage/plugin-kubernetes-common@0.7.3
+  - @backstage/catalog-model@1.4.3
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+
 ## 0.2.1-next.1
 
 ### Patch Changes

package/config.d.ts

@@ -0,0 +1,31 @@
+import { PodExecTerminal } from './src/components/PodExecTerminal/PodExecTerminal';
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface Config {
+  kubernetes?: {
+    /**
+     * Pod Exec Terminal config
+     */
+    podExecTerminal?: {
+      /**
+       * Enable `PodExecTerminal` UI feature
+       * @visibility frontend
+       */
+      enabled?: boolean;
+    };
+  };
+}

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import { createApiRef, useApi, discoveryApiRef } from '@backstage/core-plugin-api';
+import { useApi, configApiRef, createApiRef, discoveryApiRef } from '@backstage/core-plugin-api';
 import useAsync from 'react-use/lib/useAsync';
 import * as React from 'react';
 import React__default, { useCallback, useContext, useState, useEffect, useMemo, Fragment } from 'react';
@@ -13,6 +13,7 @@ import { LinearGauge, DismissableBanner, EmptyState, LogViewer, StructuredMetada
 import { DateTime } from 'luxon';
 import CloseIcon from '@material-ui/icons/Close';
 import OpenInBrowserIcon from '@material-ui/icons/OpenInBrowser';
+import 'xterm/css/xterm.css';
 import { Terminal } from 'xterm';
 import { FitAddon } from 'xterm-addon-fit';
 import { AttachAddon } from 'xterm-addon-attach';
@@ -35,6 +36,11 @@ import lodash from 'lodash';
 import PauseIcon from '@material-ui/icons/Pause';
 import ErrorOutlineIcon from '@material-ui/icons/ErrorOutline';
 
+const useIsPodExecTerminalEnabled = () => {
+  const configApi = useApi(configApiRef);
+  return configApi.getOptionalBoolean("kubernetes.podExecTerminal.enabled");
+};
+
 const kubernetesApiRef = createApiRef({
   id: "plugin.kubernetes.service"
 });
@@ -422,8 +428,10 @@ class KubernetesBackendClient {
     }
     return cluster;
   }
-  async getCredentials(authProvider) {
-    return await this.kubernetesAuthProvidersApi.getCredentials(authProvider);
+  async getCredentials(authProvider, oidcTokenProvider) {
+    return await this.kubernetesAuthProvidersApi.getCredentials(
+      authProvider === "oidc" ? `${authProvider}.${oidcTokenProvider}` : authProvider
+    );
   }
   async getObjectsByEntity(requestBody) {
     return await this.postRequired(
@@ -459,7 +467,10 @@ class KubernetesBackendClient {
     const { authProvider, oidcTokenProvider } = await this.getCluster(
       options.clusterName
     );
-    const kubernetesCredentials = await this.getCredentials(authProvider);
+    const kubernetesCredentials = await this.getCredentials(
+      authProvider,
+      oidcTokenProvider
+    );
     const url = `${await this.discoveryApi.getBaseUrl("kubernetes")}/proxy${options.path}`;
     const identityResponse = await this.identityApi.getCredentials();
     const headers = KubernetesBackendClient.getKubernetesHeaders(
@@ -879,7 +890,17 @@ class PodExecTerminalAttachAddon extends AttachAddon {
 _textEncoder = new WeakMap();
 
 const hasSocketProtocol = (url) => /wss?:\/\//.test(url.toString());
+const useStyles$4 = makeStyles(
+  (theme) => createStyles({
+    podExecTerminal: {
+      width: "100%",
+      height: "100%",
+      "& .xterm-screen": { padding: theme.spacing(1) }
+    }
+  })
+);
 const PodExecTerminal = (props) => {
+  const classes = useStyles$4();
   const { containerName, podNamespace, podName } = props;
   const [baseUrl, setBaseUrl] = useState(window.location.host);
   const terminalRef = React__default.useRef(null);
@@ -941,10 +962,7 @@ const PodExecTerminal = (props) => {
     {
       "data-testid": "terminal",
       ref: terminalRef,
-      style: {
-        width: "100%",
-        height: "100%"
-      }
+      className: classes.podExecTerminal
     }
   );
 };
@@ -1172,6 +1190,7 @@ const ContainerCard = ({
   containerMetrics
 }) => {
   var _a, _b;
+  const isPodExecTerminalEnabled = useIsPodExecTerminalEnabled();
   if (containerSpec === void 0) {
     return /* @__PURE__ */ React__default.createElement(Typography, null, "error reading pod from cluster");
   }
@@ -1259,7 +1278,7 @@ const ContainerCard = ({
         ...podScope
       }
     }
-  ), /* @__PURE__ */ React__default.createElement(
+  ), isPodExecTerminalEnabled && /* @__PURE__ */ React__default.createElement(
     PodExecTerminalDialog,
     {
       clusterName: podScope.clusterName,
@@ -3302,5 +3321,5 @@ const ErrorReporting = ({ detectedErrors }) => {
   ));
 };
 
-export { AksClusterLinksFormatter, AksKubernetesAuthProvider, Cluster, ClusterContext, ContainerCard, CronJobsAccordions, CustomResources, DEFAULT_FORMATTER_NAME, DetectedErrorsContext, EksClusterLinksFormatter, ErrorList, ErrorPanel, ErrorReporting, Events, EventsContent, FixDialog, GkeClusterLinksFormatter, GoogleKubernetesAuthProvider, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesAuthProviders, KubernetesBackendClient, KubernetesClusterLinkFormatter, KubernetesDrawer, KubernetesProxyClient, KubernetesStructuredMetadataTableDrawer, LinkErrorPanel, ManifestYaml, OidcKubernetesAuthProvider, OpenshiftClusterLinksFormatter, PendingPodContent, PodDrawer, PodExecTerminal, PodExecTerminalDialog, PodLogs, PodLogsDialog, PodMetricsContext, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, READY_COLUMNS, RESOURCE_COLUMNS, RancherClusterLinksFormatter, ResourceUtilization, ServerSideKubernetesAuthProvider, ServicesAccordions, StandardClusterLinksFormatter, getDefaultFormatters, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesClusterLinkFormatterApiRef, kubernetesProxyApiRef, useCustomResources, useEvents, useIsPodExecTerminalSupported, useKubernetesObjects, useMatchingErrors, usePodLogs, usePodMetrics };
+export { AksClusterLinksFormatter, AksKubernetesAuthProvider, Cluster, ClusterContext, ContainerCard, CronJobsAccordions, CustomResources, DEFAULT_FORMATTER_NAME, DetectedErrorsContext, EksClusterLinksFormatter, ErrorList, ErrorPanel, ErrorReporting, Events, EventsContent, FixDialog, GkeClusterLinksFormatter, GoogleKubernetesAuthProvider, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesAuthProviders, KubernetesBackendClient, KubernetesClusterLinkFormatter, KubernetesDrawer, KubernetesProxyClient, KubernetesStructuredMetadataTableDrawer, LinkErrorPanel, ManifestYaml, OidcKubernetesAuthProvider, OpenshiftClusterLinksFormatter, PendingPodContent, PodDrawer, PodExecTerminal, PodExecTerminalDialog, PodLogs, PodLogsDialog, PodMetricsContext, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, READY_COLUMNS, RESOURCE_COLUMNS, RancherClusterLinksFormatter, ResourceUtilization, ServerSideKubernetesAuthProvider, ServicesAccordions, StandardClusterLinksFormatter, getDefaultFormatters, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesClusterLinkFormatterApiRef, kubernetesProxyApiRef, useCustomResources, useEvents, useIsPodExecTerminalEnabled, useIsPodExecTerminalSupported, useKubernetesObjects, useMatchingErrors, usePodLogs, usePodMetrics };
 //# sourceMappingURL=index.esm.js.map