@backstage/plugin-kubernetes 0.7.10-next.2 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 # @backstage/plugin-kubernetes
 
+## 0.8.0
+
+### Minor Changes
+
+- 754be7c5106: refactor kubernetes error detection to make way for proposed solutions
+
+  **BREAKING**: `DetectedError` now appears once per Kubernetes resource per error instead of for all resources which have that error, `namespace` and `name` fields are now in `sourceRef` object `message` is now a `string` instead of a `string[]`. `ErrorDetectableKind` has been removed.
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- e7fb0117485: fixes a bug where an empty authorization header was provided to the proxy endpoint when a cluster had a server-side auth provider
+- c159ab64a60: `KubernetesBackendClient` now requires a `kubernetesAuthProvidersApi` value to be provided. `KubernetesApi` interface now has a proxy method requirement.
+- e0c6e8b9c3c: Update peer dependencies
+- Updated dependencies
+  - @backstage/core-components@0.13.0
+  - @backstage/plugin-catalog-react@1.5.0
+  - @backstage/theme@0.2.19
+  - @backstage/core-plugin-api@1.5.1
+  - @backstage/catalog-model@1.3.0
+  - @backstage/plugin-kubernetes-common@0.6.2
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+
+## 0.8.0-next.3
+
+### Minor Changes
+
+- 754be7c5106: refactor kubernetes error detection to make way for proposed solutions
+
+  **BREAKING**: `DetectedError` now appears once per Kubernetes resource per error instead of for all resources which have that error, `namespace` and `name` fields are now in `sourceRef` object `message` is now a `string` instead of a `string[]`. `ErrorDetectableKind` has been removed.
+
+### Patch Changes
+
+- e7fb0117485: fixes a bug where an empty authorization header was provided to the proxy endpoint when a cluster had a server-side auth provider
+- c159ab64a60: `KubernetesBackendClient` now requires a `kubernetesAuthProvidersApi` value to be provided. `KubernetesApi` interface now has a proxy method requirement.
+- Updated dependencies
+  - @backstage/plugin-catalog-react@1.5.0-next.3
+  - @backstage/catalog-model@1.3.0-next.0
+  - @backstage/core-components@0.13.0-next.3
+  - @backstage/config@1.0.7
+  - @backstage/core-plugin-api@1.5.1-next.1
+  - @backstage/errors@1.1.5
+  - @backstage/theme@0.2.19-next.0
+  - @backstage/plugin-kubernetes-common@0.6.2-next.2
+
 ## 0.7.10-next.2
 
 ### 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, OpenIdConnectApi } 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 { JsonObject } from '@backstage/types';
@@ -38,32 +38,25 @@ interface KubernetesApi {
     }[]>;
     getWorkloadsByEntity(request: WorkloadsByEntityRequest): Promise<ObjectsByEntityResponse>;
     getCustomObjectsByEntity(request: CustomObjectsByEntityRequest): Promise<ObjectsByEntityResponse>;
-}
-
-declare class KubernetesBackendClient implements KubernetesApi {
-    private readonly discoveryApi;
-    private readonly identityApi;
-    constructor(options: {
-        discoveryApi: DiscoveryApi;
-        identityApi: IdentityApi;
-    });
-    private handleResponse;
-    private postRequired;
-    getObjectsByEntity(requestBody: KubernetesRequestBody): Promise<ObjectsByEntityResponse>;
-    getWorkloadsByEntity(request: WorkloadsByEntityRequest): Promise<ObjectsByEntityResponse>;
-    getCustomObjectsByEntity(request: CustomObjectsByEntityRequest): Promise<ObjectsByEntityResponse>;
-    getClusters(): Promise<{
-        name: string;
-        authProvider: string;
-    }[]>;
+    proxy(options: {
+        clusterName: string;
+        path: string;
+        init?: RequestInit;
+    }): Promise<Response>;
 }
 
 interface KubernetesAuthProvider {
     decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(): Promise<{
+        token?: string;
+    }>;
 }
 declare const kubernetesAuthProvidersApiRef: _backstage_core_plugin_api.ApiRef<KubernetesAuthProvidersApi>;
 interface KubernetesAuthProvidersApi {
     decorateRequestBodyForAuth(authProvider: string, requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(authProvider: string): Promise<{
+        token?: string;
+    }>;
 }
 
 declare class KubernetesAuthProviders implements KubernetesAuthProvidersApi {
@@ -75,12 +68,18 @@ declare class KubernetesAuthProviders implements KubernetesAuthProvidersApi {
         };
     });
     decorateRequestBodyForAuth(authProvider: string, requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(authProvider: string): Promise<{
+        token?: string;
+    }>;
 }
 
 declare class GoogleKubernetesAuthProvider implements KubernetesAuthProvider {
     authProvider: OAuthApi;
     constructor(authProvider: OAuthApi);
     decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(): Promise<{
+        token: string;
+    }>;
 }
 
 /**
@@ -90,6 +89,34 @@ declare class GoogleKubernetesAuthProvider implements KubernetesAuthProvider {
  */
 declare class ServerSideKubernetesAuthProvider implements KubernetesAuthProvider {
     decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(): Promise<{}>;
+}
+
+declare class KubernetesBackendClient implements KubernetesApi {
+    private readonly discoveryApi;
+    private readonly identityApi;
+    private readonly kubernetesAuthProvidersApi;
+    constructor(options: {
+        discoveryApi: DiscoveryApi;
+        identityApi: IdentityApi;
+        kubernetesAuthProvidersApi: KubernetesAuthProvidersApi;
+    });
+    private handleResponse;
+    private postRequired;
+    private getCluster;
+    private getCredentials;
+    getObjectsByEntity(requestBody: KubernetesRequestBody): Promise<ObjectsByEntityResponse>;
+    getWorkloadsByEntity(request: WorkloadsByEntityRequest): Promise<ObjectsByEntityResponse>;
+    getCustomObjectsByEntity(request: CustomObjectsByEntityRequest): Promise<ObjectsByEntityResponse>;
+    getClusters(): Promise<{
+        name: string;
+        authProvider: string;
+    }[]>;
+    proxy(options: {
+        clusterName: string;
+        path: string;
+        init?: RequestInit;
+    }): Promise<Response>;
 }
 
 type FormatClusterLinkOptions = {
@@ -157,30 +184,49 @@ declare const ErrorPanel: ({ entityName, errorMessage, clustersWithErrors, }: Er
  * @public
  */
 type ErrorSeverity = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
-/**
- * Kubernetes kinds that errors might be reported by the plugin
- *
- * @public
- */
-type ErrorDetectableKind = 'Pod' | 'Deployment' | 'HorizontalPodAutoscaler';
 /**
  * A list of errors keyed by Cluster name
  *
  * @public
  */
 type DetectedErrorsByCluster = Map<string, DetectedError[]>;
+interface ResourceRef {
+    name: string;
+    namespace: string;
+    kind: string;
+    apiGroup: string;
+}
 /**
  * Represents an error found on a Kubernetes object
  *
  * @public
  */
 interface DetectedError {
+    type: string;
     severity: ErrorSeverity;
-    cluster: string;
-    namespace: string;
-    kind: ErrorDetectableKind;
-    names: string[];
-    message: string[];
+    message: string;
+    proposedFix: ProposedFix[];
+    sourceRef: ResourceRef;
+    occuranceCount: number;
+}
+type ProposedFix = LogSolution | DocsSolution | EventsSolution;
+interface ProposedFixBase {
+    errorType: string;
+    rootCauseExplanation: string;
+    possibleFixes: string[];
+}
+interface LogSolution extends ProposedFixBase {
+    type: 'logs';
+    container: string;
+}
+interface DocsSolution extends ProposedFixBase {
+    type: 'docs';
+    docsLink: string;
+}
+interface EventsSolution extends ProposedFixBase {
+    type: 'events';
+    docsLink: string;
+    podName: string;
 }
 
 /**
@@ -271,4 +317,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, ErrorDetectableKind, 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, KubernetesObjects, PodDrawer, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, Router, ServerSideKubernetesAuthProvider, ServicesAccordions, clusterLinksFormatters, detectErrors, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin, useCustomResources, useKubernetesObjects };