@backstage/plugin-kubernetes-common 0.1.3 → 0.1.7

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-kubernetes-common
 
+## 0.1.7
+
+### Patch Changes
+
+- 59677fadb1: Improvements to API Reference documentation
+
+## 0.1.6
+
+### Patch Changes
+
+- 37dc844728: Include CronJobs and Jobs as default objects returned by the kubernetes backend and add/update relevant types.
+
+## 0.1.5
+
+### Patch Changes
+
+- 193a999a80: Fixed incorrect keyword, repository directory path and entrypoints in `package.json`.
+- Updated dependencies
+  - @backstage/catalog-model@0.9.4
+
+## 0.1.4
+
+### Patch Changes
+
+- 7a0c334707: Provide access to the Kubernetes dashboard when viewing a specific resource
+- Updated dependencies
+  - @backstage/catalog-model@0.9.3
+
 ## 0.1.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { V1Pod, V1Service, V1ConfigMap, V1Deployment, V1ReplicaSet, V1HorizontalPodAutoscaler, ExtensionsV1beta1Ingress } from '@kubernetes/client-node';
+import { V1Pod, V1Service, V1ConfigMap, V1Deployment, V1ReplicaSet, V1HorizontalPodAutoscaler, V1Job, V1CronJob, ExtensionsV1beta1Ingress } from '@kubernetes/client-node';
 import { Entity } from '@backstage/catalog-model';
 
 interface KubernetesRequestBody {
@@ -7,10 +7,39 @@ interface KubernetesRequestBody {
     };
     entity: Entity;
 }
+interface ClusterAttributes {
+    /**
+     * Specifies the name of the Kubernetes cluster.
+     */
+    name: string;
+    /**
+     * 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
+     */
+    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 supported dashboards 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;
+}
 interface ClusterObjects {
-    cluster: {
-        name: string;
-    };
+    cluster: ClusterAttributes;
     resources: FetchResponse[];
     errors: KubernetesFetchError[];
 }
@@ -18,7 +47,7 @@ interface ObjectsByEntityResponse {
     items: ClusterObjects[];
 }
 declare type AuthProviderType = 'google' | 'serviceAccount' | 'aws';
-declare type FetchResponse = PodFetchResponse | ServiceFetchResponse | ConfigMapFetchResponse | DeploymentFetchResponse | ReplicaSetsFetchResponse | HorizontalPodAutoscalersFetchResponse | IngressesFetchResponse | CustomResourceFetchResponse;
+declare type FetchResponse = PodFetchResponse | ServiceFetchResponse | ConfigMapFetchResponse | DeploymentFetchResponse | ReplicaSetsFetchResponse | HorizontalPodAutoscalersFetchResponse | JobsFetchResponse | CronJobsFetchResponse | IngressesFetchResponse | CustomResourceFetchResponse;
 interface PodFetchResponse {
     type: 'pods';
     resources: Array<V1Pod>;
@@ -43,6 +72,14 @@ interface HorizontalPodAutoscalersFetchResponse {
     type: 'horizontalpodautoscalers';
     resources: Array<V1HorizontalPodAutoscaler>;
 }
+interface JobsFetchResponse {
+    type: 'jobs';
+    resources: Array<V1Job>;
+}
+interface CronJobsFetchResponse {
+    type: 'cronjobs';
+    resources: Array<V1CronJob>;
+}
 interface IngressesFetchResponse {
     type: 'ingresses';
     resources: Array<ExtensionsV1beta1Ingress>;
@@ -58,4 +95,4 @@ interface KubernetesFetchError {
 }
 declare type KubernetesErrorTypes = 'BAD_REQUEST' | 'UNAUTHORIZED_ERROR' | 'SYSTEM_ERROR' | 'UNKNOWN_ERROR';
 
-export { AuthProviderType, ClusterObjects, ConfigMapFetchResponse, CustomResourceFetchResponse, DeploymentFetchResponse, FetchResponse, HorizontalPodAutoscalersFetchResponse, IngressesFetchResponse, KubernetesErrorTypes, KubernetesFetchError, KubernetesRequestBody, ObjectsByEntityResponse, PodFetchResponse, ReplicaSetsFetchResponse, ServiceFetchResponse };
+export { AuthProviderType, ClusterAttributes, ClusterObjects, ConfigMapFetchResponse, CronJobsFetchResponse, CustomResourceFetchResponse, DeploymentFetchResponse, FetchResponse, HorizontalPodAutoscalersFetchResponse, IngressesFetchResponse, JobsFetchResponse, KubernetesErrorTypes, KubernetesFetchError, KubernetesRequestBody, ObjectsByEntityResponse, PodFetchResponse, ReplicaSetsFetchResponse, ServiceFetchResponse };

package/package.json

@@ -1,23 +1,23 @@
 {
   "name": "@backstage/plugin-kubernetes-common",
   "description": "Common functionalities for kubernetes, to be shared between kubernetes and kubernetes-backend plugin",
-  "version": "0.1.3",
-  "main": "dist/index.esm.js",
+  "version": "0.1.7",
+  "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",
-    "main": "dist/index.esm.js",
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js",
     "types": "dist/index.d.ts"
   },
   "homepage": "https://backstage.io",
   "repository": {
     "type": "git",
     "url": "https://github.com/backstage/backstage",
-    "directory": "plugin/kubernetes-common"
+    "directory": "plugins/kubernetes-common"
   },
   "keywords": [
-    "techdocs",
     "kubernetes"
   ],
   "files": [
@@ -35,16 +35,17 @@
     "url": "https://github.com/backstage/backstage/issues"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^0.9.0",
+    "@backstage/catalog-model": "^0.9.7",
     "@kubernetes/client-node": "^0.15.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.7.6"
+    "@backstage/cli": "^0.10.0"
   },
   "jest": {
     "roots": [
       ".."
     ]
   },
-  "gitHead": "c49b012d55e1a1716f05d3da84d22760ab2770e3"
+  "gitHead": "a05e7081b805006e3f0b2960a08a7753357f532f",
+  "module": "dist/index.esm.js"
 }