@backstage/plugin-kubernetes 0.9.2-next.1 → 0.9.2-next.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/plugin-kubernetes
 
+## 0.9.2-next.2
+
+### Patch Changes
+
+- 73cc0deee48a: Add proposed fix dialog for pod errors
+- Updated dependencies
+  - @backstage/theme@0.4.0-next.1
+  - @backstage/plugin-catalog-react@1.7.0-next.2
+  - @backstage/core-components@0.13.2-next.2
+  - @backstage/config@1.0.7
+  - @backstage/core-plugin-api@1.5.2-next.0
+
 ## 0.9.2-next.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -3,11 +3,13 @@ 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, ClusterAttributes, CustomResourceMatcher, ClientPodStatus } from '@backstage/plugin-kubernetes-common';
+import * as kubernetes_models_v1 from 'kubernetes-models/v1';
+import { Event, Pod, IContainer, IContainerStatus } from 'kubernetes-models/v1';
 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';
+import * as react_use_lib_useAsyncFn from 'react-use/lib/useAsyncFn';
 import { Pod as Pod$1 } from 'kubernetes-models/v1/Pod';
 
 declare const kubernetesPlugin: _backstage_core_plugin_api.BackstagePlugin<{
@@ -54,9 +56,15 @@ interface KubernetesProxyApi {
         namespace: string;
         clusterName: string;
         containerName: string;
+        previous?: boolean;
     }): Promise<{
         text: string;
     }>;
+    getEventsByInvolvedObjectName(request: {
+        clusterName: string;
+        involvedObjectName: string;
+        namespace: string;
+    }): Promise<Event[]>;
 }
 
 interface KubernetesAuthProvider {
@@ -145,11 +153,18 @@ declare class KubernetesProxyClient {
         kubernetesApi: KubernetesApi;
     });
     private handleText;
-    getPodLogs({ podName, namespace, clusterName, containerName, }: {
+    private handleJson;
+    getEventsByInvolvedObjectName({ clusterName, involvedObjectName, namespace, }: {
+        clusterName: string;
+        involvedObjectName: string;
+        namespace: string;
+    }): Promise<Event[]>;
+    getPodLogs({ podName, namespace, clusterName, containerName, previous, }: {
         podName: string;
         namespace: string;
         clusterName: string;
         containerName: string;
+        previous?: boolean;
     }): Promise<{
         text: string;
     }>;
@@ -241,7 +256,7 @@ interface DetectedError {
     type: string;
     severity: ErrorSeverity;
     message: string;
-    proposedFix: ProposedFix[];
+    proposedFix?: ProposedFix;
     sourceRef: ResourceRef;
     occuranceCount: number;
 }
@@ -249,7 +264,7 @@ type ProposedFix = LogSolution | DocsSolution | EventsSolution;
 interface ProposedFixBase {
     errorType: string;
     rootCauseExplanation: string;
-    possibleFixes: string[];
+    actions: string[];
 }
 interface LogSolution extends ProposedFixBase {
     type: 'logs';
@@ -261,7 +276,6 @@ interface DocsSolution extends ProposedFixBase {
 }
 interface EventsSolution extends ProposedFixBase {
     type: 'events';
-    docsLink: string;
     podName: string;
 }
 
@@ -333,18 +347,216 @@ interface KubernetesDrawerProps {
 }
 declare const KubernetesDrawer: ({ open, label, drawerContentsHeader, kubernetesObject, children, }: KubernetesDrawerProps) => JSX.Element;
 
+/**
+ * Wraps a pod with the associated detected errors and cluster name
+ *
+ * @public
+ */
 interface PodAndErrors {
     clusterName: string;
     pod: Pod;
     errors: DetectedError[];
 }
 
+/**
+ * Props for PodDrawer
+ *
+ * @public
+ */
 interface PodDrawerProps {
     open?: boolean;
     podAndErrors: PodAndErrors;
 }
+/**
+ * A Drawer for Kubernetes Pods
+ *
+ * @public
+ */
 declare const PodDrawer: ({ podAndErrors, open }: PodDrawerProps) => JSX.Element;
 
+/**
+ * Contains the details needed to make a log request to Kubernetes, except the container name
+ *
+ * @public
+ */
+interface PodScope {
+    podName: string;
+    podNamespace: string;
+    clusterName: string;
+}
+/**
+ * Contains the details needed to make a log request to Kubernetes
+ *
+ * @public
+ */
+interface ContainerScope extends PodScope {
+    containerName: string;
+}
+
+/**
+ * Props for PodLogs
+ *
+ * @public
+ */
+interface PodLogsProps {
+    containerScope: ContainerScope;
+    previous?: boolean;
+}
+/**
+ * Shows the logs for the given pod
+ *
+ * @public
+ */
+declare const PodLogs: React.FC<PodLogsProps>;
+
+/**
+ * Props for PodLogsDialog
+ *
+ * @public
+ */
+interface PodLogsDialogProps {
+    containerScope: ContainerScope;
+}
+/**
+ * Shows the logs for the given pod in a Dialog
+ *
+ * @public
+ */
+declare const PodLogsDialog: ({ containerScope }: PodLogsDialogProps) => JSX.Element;
+
+/**
+ * Arguments for usePodLogs
+ *
+ * @public
+ */
+interface PodLogsOptions {
+    containerScope: ContainerScope;
+    previous?: boolean;
+}
+/**
+ * Retrieves the logs for the given pod
+ *
+ * @public
+ */
+declare const usePodLogs: ({ containerScope, previous }: PodLogsOptions) => react_use_lib_useAsyncFn.AsyncState<{
+    text: string;
+}>;
+
+/**
+ * Props for ContainerCard
+ *
+ * @public
+ */
+interface ContainerCardProps {
+    podScope: PodScope;
+    containerSpec?: IContainer;
+    containerStatus: IContainerStatus;
+}
+/**
+ * Shows details about a container within a pod
+ *
+ * @public
+ */
+declare const ContainerCard: React.FC<ContainerCardProps>;
+
+/**
+ * Props for PendingPodContent
+ *
+ * @public
+ */
+interface PendingPodContentProps {
+    pod: Pod;
+}
+/**
+ * Shows details about pod's conditions as it starts
+ *
+ * @public
+ */
+declare const PendingPodContent: ({ pod }: PendingPodContentProps) => JSX.Element;
+
+/**
+ * Props for FixDialog
+ *
+ * @public
+ */
+interface FixDialogProps {
+    open?: boolean;
+    clusterName: string;
+    pod: Pod$1;
+    error: DetectedError;
+}
+/**
+ * A dialog for fixing detected Kubernetes errors
+ *
+ * @public
+ */
+declare const FixDialog: React.FC<FixDialogProps>;
+
+/**
+ * Props for Events
+ *
+ * @public
+ */
+interface EventsContentProps {
+    warningEventsOnly?: boolean;
+    events: Event[];
+}
+/**
+ * Shows given Kubernetes events
+ *
+ * @public
+ */
+declare const EventsContent: ({ events, warningEventsOnly, }: EventsContentProps) => JSX.Element;
+/**
+ * Props for Events
+ *
+ * @public
+ */
+interface EventsProps {
+    involvedObjectName: string;
+    namespace: string;
+    clusterName: string;
+    warningEventsOnly?: boolean;
+}
+/**
+ * Retrieves and shows Kubernetes events for the given object
+ *
+ * @public
+ */
+declare const Events: ({ involvedObjectName, namespace, clusterName, warningEventsOnly, }: EventsProps) => JSX.Element;
+
+/**
+ * Arguments for useEvents
+ *
+ * @public
+ */
+interface EventsOptions {
+    involvedObjectName: string;
+    namespace: string;
+    clusterName: string;
+}
+/**
+ * Retrieves the events for the given object
+ *
+ * @public
+ */
+declare const useEvents: ({ involvedObjectName, namespace, clusterName, }: EventsOptions) => react_use_lib_useAsyncFn.AsyncState<kubernetes_models_v1.Event[]>;
+
+/**
+ * Props for ErrorList
+ *
+ * @public
+ */
+interface ErrorListProps {
+    podAndErrors: PodAndErrors[];
+}
+/**
+ * Shows a list of errors found on a Pod
+ *
+ * @public
+ */
+declare const ErrorList: ({ podAndErrors }: ErrorListProps) => JSX.Element;
+
 type PodColumns = 'READY' | 'RESOURCE';
 type PodsTablesProps = {
     pods: Pod$1 | V1Pod[];
@@ -385,4 +597,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, 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 };
+export { Cluster, ClusterContext, ClusterLinksFormatter, ClusterLinksFormatterOptions, ContainerCard, ContainerCardProps, ContainerScope, CronJobsAccordions, CustomResources, DeploymentResources, DetectedError, DetectedErrorsByCluster, EntityKubernetesContent, EntityKubernetesContentProps, ErrorList, ErrorListProps, ErrorPanel, ErrorReporting, ErrorSeverity, Events, EventsContent, EventsContentProps, EventsOptions, EventsProps, FixDialog, FixDialogProps, GoogleKubernetesAuthProvider, GroupedResponses, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesApi, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, KubernetesContent, KubernetesDrawer, KubernetesDrawerContent, KubernetesObjects, KubernetesProxyApi, KubernetesProxyClient, KubernetesStructuredMetadataTableDrawer, LinkErrorPanel, PendingPodContent, PendingPodContentProps, PodAndErrors, PodDrawer, PodLogs, PodLogsDialog, PodLogsDialogProps, PodLogsOptions, PodLogsProps, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodScope, PodsTable, Router, ServerSideKubernetesAuthProvider, ServicesAccordions, clusterLinksFormatters, detectErrors, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesProxyApiRef, kubernetesPlugin as plugin, useCustomResources, useEvents, useKubernetesObjects, usePodLogs };