@backstage/plugin-kubernetes 0.8.0 → 0.9.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,62 @@
 # @backstage/plugin-kubernetes
 
+## 0.9.0-next.1
+
+### Minor Changes
+
+- 280ec10c18e: Added Pod logs components for Kubernetes plugin
+
+  **BREAKING**: `kubernetesProxyApi` for custom plugins built with components from the Kubernetes plugin apis, `kubernetesProxyApi` should be added to the plugin's API list.
+
+  ```
+  ...
+  export const kubernetesPlugin = createPlugin({
+    id: 'kubernetes',
+    apis: [
+  ...
+      createApiFactory({
+          api: kubernetesProxyApiRef,
+          deps: {
+          kubernetesApi: kubernetesApiRef,
+          },
+          factory: ({ kubernetesApi }) =>
+          new KubernetesProxyClient({
+              kubernetesApi,
+          }),
+      }),
+  ```
+
+  **BREAKING**: `KubernetesDrawer` is now called `KubernetesStructuredMetadataTableDrawer` so that we can do more than just show `StructuredMetadataTable`
+
+  `import { KubernetesDrawer } from "@backstage/plugin-kubernetes"`
+
+  should now be:
+
+  `import { KubernetesStructuredMetadataTableDrawer } from "@backstage/plugin-kubernetes"`
+
+### Patch Changes
+
+- a160e02c3d7: Omit managed fields in the Kubernetes resource YAML display.
+- Updated dependencies
+  - @backstage/core-components@0.13.1-next.0
+  - @backstage/core-plugin-api@1.5.1
+  - @backstage/plugin-catalog-react@1.6.0-next.1
+  - @backstage/config@1.0.7
+
+## 0.8.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-react@1.6.0-next.0
+  - @backstage/core-components@0.13.0
+  - @backstage/core-plugin-api@1.5.1
+  - @backstage/catalog-model@1.3.0
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+  - @backstage/theme@0.2.19
+  - @backstage/plugin-kubernetes-common@0.6.2
+
 ## 0.8.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -2,10 +2,12 @@
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
 import { OAuthApi, OpenIdConnectApi, DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
 import { Entity } from '@backstage/catalog-model';
-import { KubernetesRequestBody, ObjectsByEntityResponse, WorkloadsByEntityRequest, CustomObjectsByEntityRequest, ClusterObjects, CustomResourceMatcher, ClientPodStatus, ClusterAttributes } from '@backstage/plugin-kubernetes-common';
+import { KubernetesRequestBody, ObjectsByEntityResponse, WorkloadsByEntityRequest, CustomObjectsByEntityRequest, ClusterObjects, ClusterAttributes, CustomResourceMatcher, ClientPodStatus } from '@backstage/plugin-kubernetes-common';
 import { JsonObject } from '@backstage/types';
 import { V1Pod, V1ReplicaSet, V1Deployment, V1HorizontalPodAutoscaler, V1Service, V1ConfigMap, V1Ingress, V1Job, V1CronJob, V1StatefulSet, V1ObjectMeta } from '@kubernetes/client-node';
 import React from 'react';
+import { IObjectMeta } from '@kubernetes-models/apimachinery/apis/meta/v1/ObjectMeta';
+import { Pod } from 'kubernetes-models/v1';
 
 declare const kubernetesPlugin: _backstage_core_plugin_api.BackstagePlugin<{
     entityContent: _backstage_core_plugin_api.RouteRef<undefined>;
@@ -29,6 +31,7 @@ declare const Router: (props: {
 }) => JSX.Element;
 
 declare const kubernetesApiRef: _backstage_core_plugin_api.ApiRef<KubernetesApi>;
+declare const kubernetesProxyApiRef: _backstage_core_plugin_api.ApiRef<KubernetesProxyApi>;
 interface KubernetesApi {
     getObjectsByEntity(requestBody: KubernetesRequestBody): Promise<ObjectsByEntityResponse>;
     getClusters(): Promise<{
@@ -44,6 +47,16 @@ interface KubernetesApi {
         init?: RequestInit;
     }): Promise<Response>;
 }
+interface KubernetesProxyApi {
+    getPodLogs(request: {
+        podName: string;
+        namespace: string;
+        clusterName: string;
+        containerName: string;
+    }): Promise<{
+        text: string;
+    }>;
+}
 
 interface KubernetesAuthProvider {
     decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
@@ -119,6 +132,27 @@ declare class KubernetesBackendClient implements KubernetesApi {
     }): Promise<Response>;
 }
 
+/**
+ * A client for common requests through the proxy endpoint of the kubernetes backend plugin.
+ *
+ * @public
+ */
+declare class KubernetesProxyClient {
+    private readonly kubernetesApi;
+    constructor(options: {
+        kubernetesApi: KubernetesApi;
+    });
+    private handleText;
+    getPodLogs({ podName, namespace, clusterName, containerName, }: {
+        podName: string;
+        namespace: string;
+        clusterName: string;
+        containerName: string;
+    }): Promise<{
+        text: string;
+    }>;
+}
+
 type FormatClusterLinkOptions = {
     dashboardUrl?: string;
     dashboardApp?: string;
@@ -170,13 +204,13 @@ interface CustomResourcesProps {
 }
 declare const CustomResources: ({}: CustomResourcesProps) => JSX.Element;
 
-type ErrorPanelProps = {
+type ErrorPanelProps$1 = {
     entityName: string;
     errorMessage?: string;
     clustersWithErrors?: ClusterObjects[];
     children?: React.ReactNode;
 };
-declare const ErrorPanel: ({ entityName, errorMessage, clustersWithErrors, }: ErrorPanelProps) => JSX.Element;
+declare const ErrorPanel: ({ entityName, errorMessage, clustersWithErrors, }: ErrorPanelProps$1) => JSX.Element;
 
 /**
  * Severity of the error, where 10 is critical and 0 is very low.
@@ -258,10 +292,16 @@ type JobsAccordionsProps = {
 };
 declare const JobsAccordions: ({ jobs }: JobsAccordionsProps) => JSX.Element;
 
+type ErrorPanelProps = {
+    cluster: ClusterAttributes;
+    errorMessage?: string;
+    children?: React.ReactNode;
+};
+declare const LinkErrorPanel: ({ cluster, errorMessage }: ErrorPanelProps) => JSX.Element;
 interface KubernetesDrawerable {
     metadata?: V1ObjectMeta;
 }
-interface KubernetesDrawerProps<T extends KubernetesDrawerable> {
+interface KubernetesStructuredMetadataTableDrawerProps<T extends KubernetesDrawerable> {
     object: T;
     renderObject: (obj: T) => object;
     buttonVariant?: 'h5' | 'subtitle2';
@@ -269,13 +309,39 @@ interface KubernetesDrawerProps<T extends KubernetesDrawerable> {
     expanded?: boolean;
     children?: React.ReactNode;
 }
-declare const KubernetesDrawer: <T extends KubernetesDrawerable>({ object, renderObject, kind, buttonVariant, expanded, children, }: KubernetesDrawerProps<T>) => JSX.Element;
+declare const KubernetesStructuredMetadataTableDrawer: <T extends KubernetesDrawerable>({ object, renderObject, kind, buttonVariant, expanded, children, }: KubernetesStructuredMetadataTableDrawerProps<T>) => JSX.Element;
 
-/** @public */
-declare const PodDrawer: (props: {
-    pod: V1Pod;
-    expanded?: boolean;
-}) => JSX.Element;
+interface KubernetesObject {
+    kind: string;
+    metadata?: IObjectMeta;
+}
+interface KubernetesDrawerContentProps {
+    close: () => void;
+    kubernetesObject: KubernetesObject;
+    header?: React.ReactNode;
+    children?: React.ReactNode;
+}
+declare const KubernetesDrawerContent: ({ children, header, kubernetesObject, close, }: KubernetesDrawerContentProps) => JSX.Element;
+interface KubernetesDrawerProps {
+    open?: boolean;
+    kubernetesObject: KubernetesObject;
+    label: React.ReactNode;
+    drawerContentsHeader?: React.ReactNode;
+    children?: React.ReactNode;
+}
+declare const KubernetesDrawer: ({ open, label, drawerContentsHeader, kubernetesObject, children, }: KubernetesDrawerProps) => JSX.Element;
+
+interface PodAndErrors {
+    clusterName: string;
+    pod: Pod;
+    errors: any[];
+}
+
+interface PodDrawerProps {
+    open?: boolean;
+    podAndErrors: PodAndErrors;
+}
+declare const PodDrawer: ({ podAndErrors, open }: PodDrawerProps) => JSX.Element;
 
 type PodColumns = 'READY' | 'RESOURCE';
 type PodsTablesProps = {
@@ -317,4 +383,4 @@ declare const GroupedResponsesContext: React.Context<GroupedResponses>;
 
 declare const ClusterContext: React.Context<ClusterAttributes>;
 
-export { Cluster, ClusterContext, ClusterLinksFormatter, ClusterLinksFormatterOptions, CronJobsAccordions, CustomResources, DeploymentResources, DetectedError, DetectedErrorsByCluster, EntityKubernetesContent, EntityKubernetesContentProps, ErrorPanel, ErrorReporting, ErrorSeverity, GoogleKubernetesAuthProvider, GroupedResponses, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesApi, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, KubernetesContent, KubernetesDrawer, KubernetesObjects, PodDrawer, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, Router, ServerSideKubernetesAuthProvider, ServicesAccordions, clusterLinksFormatters, detectErrors, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin, useCustomResources, useKubernetesObjects };
+export { Cluster, ClusterContext, ClusterLinksFormatter, ClusterLinksFormatterOptions, CronJobsAccordions, CustomResources, DeploymentResources, DetectedError, DetectedErrorsByCluster, EntityKubernetesContent, EntityKubernetesContentProps, ErrorPanel, ErrorReporting, ErrorSeverity, GoogleKubernetesAuthProvider, GroupedResponses, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesApi, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, KubernetesContent, KubernetesDrawer, KubernetesDrawerContent, KubernetesObjects, KubernetesProxyApi, KubernetesProxyClient, KubernetesStructuredMetadataTableDrawer, LinkErrorPanel, PodDrawer, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, Router, ServerSideKubernetesAuthProvider, ServicesAccordions, clusterLinksFormatters, detectErrors, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesProxyApiRef, kubernetesPlugin as plugin, useCustomResources, useKubernetesObjects };