@backstage/plugin-kubernetes-backend 0.4.8 → 0.4.9

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/plugin-kubernetes-backend
 
+## 0.4.9
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+  - @backstage/backend-common@0.10.9
+  - @backstage/catalog-model@0.10.1
+  - @backstage/config@0.1.15
+  - @backstage/errors@0.2.2
+  - @backstage/plugin-kubernetes-common@0.2.4
+
 ## 0.4.8
 
 ### Patch Changes

package/dist/index.d.ts

@@ -0,0 +1,168 @@
+import { Config } from '@backstage/config';
+import { Logger } from 'winston';
+import { JsonObject } from '@backstage/types';
+import { KubernetesFetchError, FetchResponse, KubernetesRequestBody, ObjectsByEntityResponse } from '@backstage/plugin-kubernetes-common';
+import { PodStatus } from '@kubernetes/client-node/dist/top';
+import express from 'express';
+
+interface ObjectFetchParams {
+    serviceId: string;
+    clusterDetails: AWSClusterDetails | GKEClusterDetails | ServiceAccountClusterDetails | ClusterDetails;
+    objectTypesToFetch: Set<ObjectToFetch>;
+    labelSelector: string;
+    customResources: CustomResource[];
+}
+interface KubernetesFetcher {
+    fetchObjectsForService(params: ObjectFetchParams): Promise<FetchResponseWrapper>;
+    fetchPodMetricsByNamespace(clusterDetails: ClusterDetails, namespace: string): Promise<PodStatus[]>;
+}
+interface FetchResponseWrapper {
+    errors: KubernetesFetchError[];
+    responses: FetchResponse[];
+}
+interface ObjectToFetch {
+    objectType: KubernetesObjectTypes;
+    group: string;
+    apiVersion: string;
+    plural: string;
+}
+interface CustomResource extends ObjectToFetch {
+    objectType: 'customresources';
+}
+declare type KubernetesObjectTypes = 'pods' | 'services' | 'configmaps' | 'deployments' | 'replicasets' | 'horizontalpodautoscalers' | 'jobs' | 'cronjobs' | 'ingresses' | 'customresources';
+interface KubernetesClustersSupplier {
+    getClusters(): Promise<ClusterDetails[]>;
+}
+interface KubernetesServiceLocator {
+    getClustersByServiceId(serviceId: string): Promise<ClusterDetails[]>;
+}
+declare type ServiceLocatorMethod = 'multiTenant' | 'http';
+interface ClusterDetails {
+    /**
+     * Specifies the name of the Kubernetes cluster.
+     */
+    name: string;
+    url: string;
+    authProvider: string;
+    serviceAccountToken?: string | undefined;
+    skipTLSVerify?: boolean;
+    /**
+     * Whether to skip the lookup to the metrics server to retrieve pod resource usage.
+     * It is not guaranteed that the Kubernetes distro has the metrics server installed.
+     */
+    skipMetricsLookup?: boolean;
+    caData?: string | undefined;
+    /**
+     * Specifies the link to the Kubernetes dashboard managing this cluster.
+     * @remarks
+     * Note that you should specify the app used for the dashboard
+     * using the dashboardApp property, in order to properly format
+     * links to kubernetes resources,  otherwise it will assume that you're running the standard one.
+     * @see dashboardApp
+     * @see dashboardParameters
+     */
+    dashboardUrl?: string;
+    /**
+     * Specifies the app that provides the Kubernetes dashboard.
+     * This will be used for formatting links to kubernetes objects inside the dashboard.
+     * @remarks
+     * The existing apps are: standard, rancher, openshift, gke, aks, eks
+     * Note that it will default to the regular dashboard provided by the Kubernetes project (standard).
+     * Note that you can add your own formatter by registering it to the clusterLinksFormatters dictionary.
+     * @defaultValue standard
+     * @see dashboardUrl
+     * @example
+     * ```ts
+     * import { clusterLinksFormatters } from '@backstage/plugin-kubernetes';
+     * clusterLinksFormatters.myDashboard = (options) => ...;
+     * ```
+     */
+    dashboardApp?: string;
+    /**
+     * Specifies specific parameters used by some dashboard URL formatters.
+     * This is used by the GKE formatter which requires the project, region and cluster name.
+     * @see dashboardApp
+     */
+    dashboardParameters?: JsonObject;
+}
+interface GKEClusterDetails extends ClusterDetails {
+}
+interface ServiceAccountClusterDetails extends ClusterDetails {
+}
+interface AWSClusterDetails extends ClusterDetails {
+    assumeRole?: string;
+    externalId?: string;
+}
+interface KubernetesObjectsProviderOptions {
+    logger: Logger;
+    fetcher: KubernetesFetcher;
+    serviceLocator: KubernetesServiceLocator;
+    customResources: CustomResource[];
+    objectTypesToFetch?: ObjectToFetch[];
+}
+declare type ObjectsByEntityRequest = KubernetesRequestBody;
+interface KubernetesObjectsProvider {
+    getKubernetesObjectsByEntity(request: ObjectsByEntityRequest): Promise<ObjectsByEntityResponse>;
+}
+
+interface RouterOptions {
+    logger: Logger;
+    config: Config;
+    clusterSupplier?: KubernetesClustersSupplier;
+}
+/**
+ * creates and configure a new router for handling the kubernetes backend APIs
+ * @param options - specifies the options required by this plugin
+ * @returns a new router
+ * @deprecated Please use the new KubernetesBuilder instead like this
+ * ```
+ * import { KubernetesBuilder } from '@backstage/plugin-kubernetes-backend';
+ * const { router } = await KubernetesBuilder.createBuilder({
+ *   logger,
+ *   config,
+ * }).build();
+ * ```
+ */
+declare function createRouter(options: RouterOptions): Promise<express.Router>;
+
+interface KubernetesEnvironment {
+    logger: Logger;
+    config: Config;
+}
+declare class KubernetesBuilder {
+    protected readonly env: KubernetesEnvironment;
+    private clusterSupplier?;
+    private objectsProvider?;
+    private fetcher?;
+    private serviceLocator?;
+    static createBuilder(env: KubernetesEnvironment): KubernetesBuilder;
+    constructor(env: KubernetesEnvironment);
+    build(): Promise<{
+        clusterDetails: ClusterDetails[];
+        clusterSupplier: KubernetesClustersSupplier;
+        customResources: CustomResource[];
+        fetcher: KubernetesFetcher;
+        objectsProvider: KubernetesObjectsProvider;
+        router: express.Router;
+        serviceLocator: KubernetesServiceLocator;
+    }>;
+    setClusterSupplier(clusterSupplier?: KubernetesClustersSupplier): this;
+    setObjectsProvider(objectsProvider?: KubernetesObjectsProvider): this;
+    setFetcher(fetcher?: KubernetesFetcher): this;
+    setServiceLocator(serviceLocator?: KubernetesServiceLocator): this;
+    protected buildCustomResources(): CustomResource[];
+    protected buildClusterSupplier(): KubernetesClustersSupplier;
+    protected buildObjectsProvider(options: KubernetesObjectsProviderOptions): KubernetesObjectsProvider;
+    protected buildFetcher(): KubernetesFetcher;
+    protected buildServiceLocator(method: ServiceLocatorMethod, clusterDetails: ClusterDetails[]): KubernetesServiceLocator;
+    protected buildMultiTenantServiceLocator(clusterDetails: ClusterDetails[]): KubernetesServiceLocator;
+    protected buildHttpServiceLocator(_clusterDetails: ClusterDetails[]): KubernetesServiceLocator;
+    protected buildRouter(objectsProvider: KubernetesObjectsProvider, clusterDetails: ClusterDetails[]): express.Router;
+    protected fetchClusterDetails(clusterSupplier: KubernetesClustersSupplier): Promise<ClusterDetails[]>;
+    protected getServiceLocatorMethod(): ServiceLocatorMethod;
+    protected getObjectTypesToFetch(): ObjectToFetch[] | undefined;
+}
+
+declare const DEFAULT_OBJECTS: ObjectToFetch[];
+
+export { AWSClusterDetails, ClusterDetails, CustomResource, DEFAULT_OBJECTS, FetchResponseWrapper, GKEClusterDetails, KubernetesBuilder, KubernetesClustersSupplier, KubernetesEnvironment, KubernetesFetcher, KubernetesObjectTypes, KubernetesObjectsProvider, KubernetesObjectsProviderOptions, KubernetesServiceLocator, ObjectFetchParams, ObjectToFetch, ObjectsByEntityRequest, RouterOptions, ServiceAccountClusterDetails, ServiceLocatorMethod, createRouter };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-kubernetes-backend",
   "description": "A Backstage backend plugin that integrates towards Kubernetes",
-  "version": "0.4.8",
+  "version": "0.4.9",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -35,11 +35,11 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.10.8",
-    "@backstage/catalog-model": "^0.10.0",
-    "@backstage/config": "^0.1.14",
-    "@backstage/errors": "^0.2.1",
-    "@backstage/plugin-kubernetes-common": "^0.2.3",
+    "@backstage/backend-common": "^0.10.9",
+    "@backstage/catalog-model": "^0.10.1",
+    "@backstage/config": "^0.1.15",
+    "@backstage/errors": "^0.2.2",
+    "@backstage/plugin-kubernetes-common": "^0.2.4",
     "@google-cloud/container": "^2.2.0",
     "@kubernetes/client-node": "^0.16.0",
     "@types/express": "^4.17.6",
@@ -68,5 +68,5 @@
     "dist",
     "schema.d.ts"
   ],
-  "gitHead": "4805c3d13ce9bfc369e53c271b1b95e722b3b4dc"
+  "gitHead": "e244b348c473700e7d5e5fbcef38bd9f9fd1d0ba"
 }