@backstage/plugin-kubernetes 0.6.7-next.2 → 0.7.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # @backstage/plugin-kubernetes
 
+## 0.7.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-plugin-api@1.0.5-next.0
+  - @backstage/plugin-catalog-react@1.1.3-next.0
+  - @backstage/core-components@0.10.1-next.0
+
+## 0.7.0
+
+### Minor Changes
+
+- f5c9730639: Add `localKubectlProxy` cluster locator method to make local development simpler to setup.
+
+  Consolidated no-op server side auth decorators.
+  The following Kubernetes auth decorators are now one class (`ServerSideKubernetesAuthProvider`):
+
+  - `AwsKubernetesAuthProvider`
+  - `AzureKubernetesAuthProvider`
+  - `ServiceAccountKubernetesAuthProvider`
+
+### Patch Changes
+
+- 3ec294a186: expose detectErrors function publicly
+- a70869e775: Updated dependency `msw` to `^0.43.0`.
+- 4e9a90e307: Updated dependency `luxon` to `^3.0.0`.
+- 8006d0f9bf: Updated dependency `msw` to `^0.44.0`.
+- eadb3a8d2e: Updated dependency `@kubernetes/client-node` to `^0.17.0`.
+- Updated dependencies
+  - @backstage/core-components@0.10.0
+  - @backstage/catalog-model@1.1.0
+  - @backstage/plugin-kubernetes-common@0.4.0
+  - @backstage/core-plugin-api@1.0.4
+  - @backstage/plugin-catalog-react@1.1.2
+  - @backstage/theme@0.2.16
+
+## 0.7.0-next.3
+
+### Minor Changes
+
+- f5c9730639: Add `localKubectlProxy` cluster locator method to make local development simpler to setup.
+
+  Consolidated no-op server side auth decorators.
+  The following Kubernetes auth decorators are now one class (`ServerSideKubernetesAuthProvider`):
+
+  - `AwsKubernetesAuthProvider`
+  - `AzureKubernetesAuthProvider`
+  - `ServiceAccountKubernetesAuthProvider`
+
+### Patch Changes
+
+- 3ec294a186: expose detectErrors function publicly
+- a70869e775: Updated dependency `msw` to `^0.43.0`.
+- 4e9a90e307: Updated dependency `luxon` to `^3.0.0`.
+- eadb3a8d2e: Updated dependency `@kubernetes/client-node` to `^0.17.0`.
+- Updated dependencies
+  - @backstage/core-plugin-api@1.0.4-next.0
+  - @backstage/core-components@0.10.0-next.3
+  - @backstage/catalog-model@1.1.0-next.3
+  - @backstage/plugin-catalog-react@1.1.2-next.3
+  - @backstage/plugin-kubernetes-common@0.4.0-next.2
+
 ## 0.6.7-next.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -9,7 +9,7 @@ import React from 'react';
 
 declare const kubernetesPlugin: _backstage_core_plugin_api.BackstagePlugin<{
     entityContent: _backstage_core_plugin_api.RouteRef<undefined>;
-}, {}>;
+}, {}, {}>;
 /**
  * Props of EntityKubernetesContent
  *
@@ -73,21 +73,18 @@ declare class KubernetesAuthProviders implements KubernetesAuthProvidersApi {
     decorateRequestBodyForAuth(authProvider: string, requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
 }
 
-declare class AwsKubernetesAuthProvider implements KubernetesAuthProvider {
-    decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
-}
-
 declare class GoogleKubernetesAuthProvider implements KubernetesAuthProvider {
     authProvider: OAuthApi;
     constructor(authProvider: OAuthApi);
     decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
 }
 
-declare class GoogleServiceAccountAuthProvider implements KubernetesAuthProvider {
-    decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
-}
-
-declare class ServiceAccountKubernetesAuthProvider implements KubernetesAuthProvider {
+/**
+ * No-op KubernetesAuthProvider, authorization will be handled in the kubernetes-backend plugin
+ *
+ * @public
+ */
+declare class ServerSideKubernetesAuthProvider implements KubernetesAuthProvider {
     decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
 }
 
@@ -150,9 +147,29 @@ declare type ErrorPanelProps = {
 };
 declare const ErrorPanel: ({ entityName, errorMessage, clustersWithErrors, }: ErrorPanelProps) => JSX.Element;
 
+/**
+ * Severity of the error, where 10 is critical and 0 is very low.
+ *
+ * @alpha
+ */
 declare type ErrorSeverity = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+/**
+ * Kubernetes kinds that errors might be reported by the plugin
+ *
+ * @alpha
+ */
 declare type ErrorDetectableKind = 'Pod' | 'Deployment' | 'HorizontalPodAutoscaler';
+/**
+ * A list of errors keyed by Cluster name
+ *
+ * @alpha
+ */
 declare type DetectedErrorsByCluster = Map<string, DetectedError[]>;
+/**
+ * Represents an error found on a Kubernetes object
+ *
+ * @alpha
+ */
 interface DetectedError {
     severity: ErrorSeverity;
     cluster: string;
@@ -161,6 +178,14 @@ interface DetectedError {
     message: string[];
 }
 
+/**
+ * For each cluster try to find errors in each of the object types provided
+ * returning a map of cluster names to errors in that cluster
+ *
+ * @alpha
+ */
+declare const detectErrors: (objects: ObjectsByEntityResponse) => DetectedErrorsByCluster;
+
 declare type ErrorReportingProps = {
     detectedErrors: DetectedErrorsByCluster;
 };
@@ -231,4 +256,4 @@ declare const GroupedResponsesContext: React.Context<GroupedResponses>;
 
 declare const ClusterContext: React.Context<ClusterAttributes>;
 
-export { AwsKubernetesAuthProvider, Cluster, ClusterContext, ClusterLinksFormatter, ClusterLinksFormatterOptions, CronJobsAccordions, CustomResources, DeploymentResources, EntityKubernetesContent, EntityKubernetesContentProps, ErrorPanel, ErrorReporting, GoogleKubernetesAuthProvider, GoogleServiceAccountAuthProvider, GroupedResponses, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesApi, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, KubernetesContent, KubernetesDrawer, KubernetesObjects, PodDrawer, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, Router, ServiceAccountKubernetesAuthProvider, ServicesAccordions, clusterLinksFormatters, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin, useKubernetesObjects };
+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, useKubernetesObjects };