@backstage/plugin-kubernetes-node 0.1.2-next.2 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @backstage/plugin-kubernetes-node
 
+## 0.1.2
+
+### Patch Changes
+
+- 6010564: The `kubernetes-node` plugin has been modified to house a new extension points for Kubernetes backend plugin;
+  `KubernetesClusterSupplierExtensionPoint` is introduced .
+  `kubernetesAuthStrategyExtensionPoint` is introduced .
+  `kubernetesFetcherExtensionPoint` is introduced .
+  `kubernetesServiceLocatorExtensionPoint` is introduced .
+
+  The `kubernetes-backend` plugin was modified to use this new extension point.
+
+- Updated dependencies
+  - @backstage/plugin-kubernetes-common@0.7.2
+  - @backstage/backend-plugin-api@0.6.8
+  - @backstage/catalog-model@1.4.3
+  - @backstage/types@1.1.1
+
+## 0.1.2-next.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.8-next.3
+  - @backstage/catalog-model@1.4.3
+  - @backstage/plugin-kubernetes-common@0.7.2-next.1
+
 ## 0.1.2-next.2
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -7,6 +7,22 @@ var backendPluginApi = require('@backstage/backend-plugin-api');
 const kubernetesObjectsProviderExtensionPoint = backendPluginApi.createExtensionPoint({
   id: "kubernetes.objects-provider"
 });
+const kubernetesClusterSupplierExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "kubernetes.cluster-supplier"
+});
+const kubernetesAuthStrategyExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "kubernetes.auth-strategy"
+});
+const kubernetesFetcherExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "kubernetes.fetcher"
+});
+const kubernetesServiceLocatorExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "kubernetes.service-locator"
+});
 
+exports.kubernetesAuthStrategyExtensionPoint = kubernetesAuthStrategyExtensionPoint;
+exports.kubernetesClusterSupplierExtensionPoint = kubernetesClusterSupplierExtensionPoint;
+exports.kubernetesFetcherExtensionPoint = kubernetesFetcherExtensionPoint;
 exports.kubernetesObjectsProviderExtensionPoint = kubernetesObjectsProviderExtensionPoint;
+exports.kubernetesServiceLocatorExtensionPoint = kubernetesServiceLocatorExtensionPoint;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { KubernetesObjectsProvider } from '@backstage/plugin-kubernetes-node';\n\n/**\n * The interface for {@link kubernetesObjectsProviderExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesObjectsProviderExtensionPoint {\n  addObjectsProvider(provider: KubernetesObjectsProvider): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a objects provider.\n *\n * @public\n */\nexport const kubernetesObjectsProviderExtensionPoint =\n  createExtensionPoint<KubernetesObjectsProviderExtensionPoint>({\n    id: 'kubernetes.objects-provider',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;;;AAgCO,MAAM,0CACXA,qCAA8D,CAAA;AAAA,EAC5D,EAAI,EAAA,6BAAA;AACN,CAAC;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n  AuthenticationStrategy,\n  KubernetesClustersSupplier,\n  KubernetesFetcher,\n  KubernetesObjectsProvider,\n  KubernetesServiceLocator,\n} from '@backstage/plugin-kubernetes-node';\n\n/**\n * The interface for {@link kubernetesObjectsProviderExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesObjectsProviderExtensionPoint {\n  addObjectsProvider(provider: KubernetesObjectsProvider): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a objects provider.\n *\n * @public\n */\nexport const kubernetesObjectsProviderExtensionPoint =\n  createExtensionPoint<KubernetesObjectsProviderExtensionPoint>({\n    id: 'kubernetes.objects-provider',\n  });\n\n/**\n * The interface for {@link kubernetesClusterSupplierExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesClusterSupplierExtensionPoint {\n  addClusterSupplier(clusterSupplier: KubernetesClustersSupplier): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a cluster supplier.\n *\n * @public\n */\nexport const kubernetesClusterSupplierExtensionPoint =\n  createExtensionPoint<KubernetesClusterSupplierExtensionPoint>({\n    id: 'kubernetes.cluster-supplier',\n  });\n\n/**\n * The interface for {@link kubernetesAuthStrategyExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesAuthStrategyExtensionPoint {\n  addAuthStrategy(key: string, strategy: AuthenticationStrategy): void;\n}\n\n/**\n * An extension point the exposes the ability to add an Auth Strategy.\n *\n * @public\n */\nexport const kubernetesAuthStrategyExtensionPoint =\n  createExtensionPoint<KubernetesAuthStrategyExtensionPoint>({\n    id: 'kubernetes.auth-strategy',\n  });\n\n/**\n * The interface for {@link kubernetesFetcherExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesFetcherExtensionPoint {\n  addFetcher(fetcher: KubernetesFetcher): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a kubernetes fetcher.\n *\n * @public\n */\nexport const kubernetesFetcherExtensionPoint =\n  createExtensionPoint<KubernetesFetcherExtensionPoint>({\n    id: 'kubernetes.fetcher',\n  });\n\n/**\n * The interface for {@link kubernetesServiceLocatorExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesServiceLocatorExtensionPoint {\n  addServiceLocator(serviceLocator: KubernetesServiceLocator): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a kubernetes service locator.\n *\n * @public\n */\nexport const kubernetesServiceLocatorExtensionPoint =\n  createExtensionPoint<KubernetesServiceLocatorExtensionPoint>({\n    id: 'kubernetes.service-locator',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;;;AAsCO,MAAM,0CACXA,qCAA8D,CAAA;AAAA,EAC5D,EAAI,EAAA,6BAAA;AACN,CAAC,EAAA;AAgBI,MAAM,0CACXA,qCAA8D,CAAA;AAAA,EAC5D,EAAI,EAAA,6BAAA;AACN,CAAC,EAAA;AAgBI,MAAM,uCACXA,qCAA2D,CAAA;AAAA,EACzD,EAAI,EAAA,0BAAA;AACN,CAAC,EAAA;AAgBI,MAAM,kCACXA,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA,oBAAA;AACN,CAAC,EAAA;AAgBI,MAAM,yCACXA,qCAA6D,CAAA;AAAA,EAC3D,EAAI,EAAA,4BAAA;AACN,CAAC;;;;;;;;"}

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { KubernetesObjectsProvider as KubernetesObjectsProvider$1 } from '@backstage/plugin-kubernetes-node';
+import { KubernetesObjectsProvider as KubernetesObjectsProvider$1, KubernetesClustersSupplier as KubernetesClustersSupplier$1, AuthenticationStrategy as AuthenticationStrategy$1, KubernetesFetcher as KubernetesFetcher$1, KubernetesServiceLocator as KubernetesServiceLocator$1 } from '@backstage/plugin-kubernetes-node';
 import { Entity } from '@backstage/catalog-model';
-import { ObjectsByEntityResponse, KubernetesRequestAuth, CustomResourceMatcher } from '@backstage/plugin-kubernetes-common';
+import { ObjectsByEntityResponse, KubernetesRequestAuth, CustomResourceMatcher, KubernetesFetchError, FetchResponse } from '@backstage/plugin-kubernetes-common';
+import { JsonObject } from '@backstage/types';
 
 /**
  * The interface for {@link kubernetesObjectsProviderExtensionPoint}.
@@ -17,6 +18,62 @@ interface KubernetesObjectsProviderExtensionPoint {
  * @public
  */
 declare const kubernetesObjectsProviderExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<KubernetesObjectsProviderExtensionPoint>;
+/**
+ * The interface for {@link kubernetesClusterSupplierExtensionPoint}.
+ *
+ * @public
+ */
+interface KubernetesClusterSupplierExtensionPoint {
+    addClusterSupplier(clusterSupplier: KubernetesClustersSupplier$1): void;
+}
+/**
+ * An extension point the exposes the ability to configure a cluster supplier.
+ *
+ * @public
+ */
+declare const kubernetesClusterSupplierExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<KubernetesClusterSupplierExtensionPoint>;
+/**
+ * The interface for {@link kubernetesAuthStrategyExtensionPoint}.
+ *
+ * @public
+ */
+interface KubernetesAuthStrategyExtensionPoint {
+    addAuthStrategy(key: string, strategy: AuthenticationStrategy$1): void;
+}
+/**
+ * An extension point the exposes the ability to add an Auth Strategy.
+ *
+ * @public
+ */
+declare const kubernetesAuthStrategyExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<KubernetesAuthStrategyExtensionPoint>;
+/**
+ * The interface for {@link kubernetesFetcherExtensionPoint}.
+ *
+ * @public
+ */
+interface KubernetesFetcherExtensionPoint {
+    addFetcher(fetcher: KubernetesFetcher$1): void;
+}
+/**
+ * An extension point the exposes the ability to configure a kubernetes fetcher.
+ *
+ * @public
+ */
+declare const kubernetesFetcherExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<KubernetesFetcherExtensionPoint>;
+/**
+ * The interface for {@link kubernetesServiceLocatorExtensionPoint}.
+ *
+ * @public
+ */
+interface KubernetesServiceLocatorExtensionPoint {
+    addServiceLocator(serviceLocator: KubernetesServiceLocator$1): void;
+}
+/**
+ * An extension point the exposes the ability to configure a kubernetes service locator.
+ *
+ * @public
+ */
+declare const kubernetesServiceLocatorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<KubernetesServiceLocatorExtensionPoint>;
 
 /**
  *
@@ -41,5 +98,166 @@ interface KubernetesObjectsByEntity {
 interface CustomResourcesByEntity extends KubernetesObjectsByEntity {
     customResources: CustomResourceMatcher[];
 }
+/**
+ * Provider-specific authentication configuration
+ * @public
+ */
+type AuthMetadata = Record<string, string>;
+/**
+ *
+ * @public
+ */
+interface ClusterDetails {
+    /**
+     * Specifies the name of the Kubernetes cluster.
+     */
+    name: string;
+    url: string;
+    authMetadata: AuthMetadata;
+    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;
+    caFile?: 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;
+    /**
+     * Specifies which custom resources to look for when returning an entity's
+     * Kubernetes resources.
+     */
+    customResources?: CustomResourceMatcher[];
+}
+/**
+ * Used to load cluster details from different sources
+ * @public
+ */
+interface KubernetesClustersSupplier {
+    /**
+     * Returns the cached list of clusters.
+     *
+     * Implementations _should_ cache the clusters and refresh them periodically,
+     * as getClusters is called whenever the list of clusters is needed.
+     */
+    getClusters(): Promise<ClusterDetails[]>;
+}
+/**
+ * Authentication data used to make a request to Kubernetes
+ * @public
+ */
+type KubernetesCredential = {
+    type: 'bearer token';
+    token: string;
+} | {
+    type: 'anonymous';
+};
+/**
+ *
+ * @public
+ */
+interface AuthenticationStrategy {
+    getCredential(clusterDetails: ClusterDetails, authConfig: KubernetesRequestAuth): Promise<KubernetesCredential>;
+    validateCluster(authMetadata: AuthMetadata): Error[];
+}
+/**
+ *
+ * @public
+ */
+type KubernetesObjectTypes = 'pods' | 'services' | 'configmaps' | 'deployments' | 'limitranges' | 'resourcequotas' | 'replicasets' | 'horizontalpodautoscalers' | 'jobs' | 'cronjobs' | 'ingresses' | 'customresources' | 'statefulsets' | 'daemonsets';
+/**
+ *
+ * @public
+ */
+interface ObjectToFetch {
+    objectType: KubernetesObjectTypes;
+    group: string;
+    apiVersion: string;
+    plural: string;
+}
+/**
+ *
+ * @public
+ */
+interface CustomResource extends ObjectToFetch {
+    objectType: 'customresources';
+}
+/**
+ *
+ * @public
+ */
+interface ObjectFetchParams {
+    serviceId: string;
+    clusterDetails: ClusterDetails;
+    credential: KubernetesCredential;
+    objectTypesToFetch: Set<ObjectToFetch>;
+    labelSelector?: string;
+    customResources: CustomResource[];
+    namespace?: string;
+}
+/**
+ *
+ * @public
+ */
+interface FetchResponseWrapper {
+    errors: KubernetesFetchError[];
+    responses: FetchResponse[];
+}
+/**
+ * Fetches information from a kubernetes cluster using the cluster details object to target a specific cluster
+ *
+ * @public
+ */
+interface KubernetesFetcher {
+    fetchObjectsForService(params: ObjectFetchParams): Promise<FetchResponseWrapper>;
+    fetchPodMetricsByNamespaces(clusterDetails: ClusterDetails, credential: KubernetesCredential, namespaces: Set<string>, labelSelector?: string): Promise<FetchResponseWrapper>;
+}
+/**
+ * @public
+ */
+interface ServiceLocatorRequestContext {
+    objectTypesToFetch: Set<ObjectToFetch>;
+    customResources: CustomResourceMatcher[];
+}
+/**
+ * Used to locate which cluster(s) a service is running on
+ * @public
+ */
+interface KubernetesServiceLocator {
+    getClustersByEntity(entity: Entity, requestContext: ServiceLocatorRequestContext): Promise<{
+        clusters: ClusterDetails[];
+    }>;
+}
 
-export { CustomResourcesByEntity, KubernetesObjectsByEntity, KubernetesObjectsProvider, KubernetesObjectsProviderExtensionPoint, kubernetesObjectsProviderExtensionPoint };
+export { AuthMetadata, AuthenticationStrategy, ClusterDetails, CustomResource, CustomResourcesByEntity, FetchResponseWrapper, KubernetesAuthStrategyExtensionPoint, KubernetesClusterSupplierExtensionPoint, KubernetesClustersSupplier, KubernetesCredential, KubernetesFetcher, KubernetesFetcherExtensionPoint, KubernetesObjectTypes, KubernetesObjectsByEntity, KubernetesObjectsProvider, KubernetesObjectsProviderExtensionPoint, KubernetesServiceLocator, KubernetesServiceLocatorExtensionPoint, ObjectFetchParams, ObjectToFetch, ServiceLocatorRequestContext, kubernetesAuthStrategyExtensionPoint, kubernetesClusterSupplierExtensionPoint, kubernetesFetcherExtensionPoint, kubernetesObjectsProviderExtensionPoint, kubernetesServiceLocatorExtensionPoint };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-kubernetes-node",
   "description": "Node.js library for the kubernetes plugin",
-  "version": "0.1.2-next.2",
+  "version": "0.1.2",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -22,14 +22,15 @@
     "postpack": "backstage-cli package postpack"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.25.0-next.2"
+    "@backstage/cli": "^0.25.0"
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.6.8-next.2",
+    "@backstage/backend-plugin-api": "^0.6.8",
     "@backstage/catalog-model": "^1.4.3",
-    "@backstage/plugin-kubernetes-common": "^0.7.2-next.1"
+    "@backstage/plugin-kubernetes-common": "^0.7.2",
+    "@backstage/types": "^1.1.1"
   }
 }