Merge pull request #11603 from goenning/go/refresh-rate-k8s

[Kubernetes Plugin] ability to configure refresh interval on Kubernetes tab

.changeset/khaki-shrimps-tell.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-kubernetes': patch
+---
+
+ability to configure refresh interval on Kubernetes tab

docs/features/kubernetes/installation.md

@@ -33,10 +33,14 @@ const serviceEntityPage = (
   <EntityLayout>
     {/* other tabs... */}
     <EntityLayout.Route path="/kubernetes" title="Kubernetes">
-      <EntityKubernetesContent />
+      <EntityKubernetesContent refreshIntervalMs={30000} />
     </EntityLayout.Route>
 ```
 
+**Notes:**
+
+- The optional `refreshIntervalMs` property on the `EntityKubernetesContent` defines the interval in which the content automatically refreshes, if not set this will default to 10 seconds.
+
 That's it! But now, we need the Kubernetes Backend plugin for the frontend to
 work.
 

plugins/kubernetes/api-report.md

@@ -112,7 +112,14 @@ export interface DeploymentResources {
 // Warning: (ae-missing-release-tag) "EntityKubernetesContent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export const EntityKubernetesContent: (_props: {}) => JSX.Element;
+export const EntityKubernetesContent: (
+  props: EntityKubernetesContentProps,
+) => JSX.Element;
+
+// @public
+export type EntityKubernetesContentProps = {
+  refreshIntervalMs?: number;
+};
 
 // Warning: (ae-forgotten-export) The symbol "ErrorPanelProps" needs to be exported by the entry point index.d.ts
 // Warning: (ae-missing-release-tag) "ErrorPanel" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -303,6 +310,7 @@ export class KubernetesBackendClient implements KubernetesApi {
 // @public (undocumented)
 export const KubernetesContent: ({
   entity,
+  refreshIntervalMs,
 }: KubernetesContentProps) => JSX.Element;
 
 // Warning: (ae-forgotten-export) The symbol "KubernetesDrawerable" needs to be exported by the entry point index.d.ts
@@ -373,11 +381,10 @@ export const PodsTable: ({
   extraColumns,
 }: PodsTablesProps) => JSX.Element;
 
-// Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
 // Warning: (ae-missing-release-tag) "Router" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export const Router: (_props: Props) => JSX.Element;
+export const Router: (props: { refreshIntervalMs?: number }) => JSX.Element;
 
 // Warning: (ae-missing-release-tag) "ServiceAccountKubernetesAuthProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //

plugins/kubernetes/src/Router.tsx

@@ -32,9 +32,7 @@ export const isKubernetesAvailable = (entity: Entity) =>
     entity.metadata.annotations?.[KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION],
   );
 
-type Props = {};
-
-export const Router = (_props: Props) => {
+export const Router = (props: { refreshIntervalMs?: number }) => {
   const { entity } = useEntity();
 
   const kubernetesAnnotationValue =
@@ -49,7 +47,15 @@ export const Router = (_props: Props) => {
   ) {
     return (
       <Routes>
-        <Route path="/" element={<KubernetesContent entity={entity} />} />
+        <Route
+          path="/"
+          element={
+            <KubernetesContent
+              entity={entity}
+              refreshIntervalMs={props.refreshIntervalMs}
+            />
+          }
+        />
       </Routes>
     );
   }

plugins/kubernetes/src/components/KubernetesContent.tsx

@@ -25,10 +25,20 @@ import EmptyStateImage from '../assets/emptystate.svg';
 import { useKubernetesObjects } from '../hooks';
 import { Content, Page, Progress } from '@backstage/core-components';
 
-type KubernetesContentProps = { entity: Entity; children?: React.ReactNode };
+type KubernetesContentProps = {
+  entity: Entity;
+  refreshIntervalMs?: number;
+  children?: React.ReactNode;
+};
 
-export const KubernetesContent = ({ entity }: KubernetesContentProps) => {
-  const { kubernetesObjects, error } = useKubernetesObjects(entity);
+export const KubernetesContent = ({
+  entity,
+  refreshIntervalMs,
+}: KubernetesContentProps) => {
+  const { kubernetesObjects, error } = useKubernetesObjects(
+    entity,
+    refreshIntervalMs,
+  );
 
   const clustersWithErrors =
     kubernetesObjects?.items.filter(r => r.errors.length > 0) ?? [];

plugins/kubernetes/src/index.ts

@@ -25,6 +25,7 @@ export {
   kubernetesPlugin as plugin,
   EntityKubernetesContent,
 } from './plugin';
+export type { EntityKubernetesContentProps } from './plugin';
 export { Router, isKubernetesAvailable } from './Router';
 export * from './api';
 export * from './kubernetes-auth-provider';

plugins/kubernetes/src/plugin.ts

@@ -76,7 +76,21 @@ export const kubernetesPlugin = createPlugin({
   },
 });
 
-export const EntityKubernetesContent = kubernetesPlugin.provide(
+/**
+ * Props of EntityKubernetesContent
+ *
+ * @public
+ */
+export type EntityKubernetesContentProps = {
+  /**
+   * Sets the refresh interval in milliseconds. The default value is 10000 (10 seconds)
+   */
+  refreshIntervalMs?: number;
+};
+
+export const EntityKubernetesContent: (
+  props: EntityKubernetesContentProps,
+) => JSX.Element = kubernetesPlugin.provide(
   createRoutableExtension({
     name: 'EntityKubernetesContent',
     component: () => import('./Router').then(m => m.Router),