@backstage/plugin-kubernetes-common 0.1.5 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @backstage/plugin-kubernetes-common
 
+## 0.2.1
+
+### Patch Changes
+
+- 7ac0bd2c66: implement dashboard link formatter for GKE
+
+## 0.2.0
+
+### Minor Changes
+
+- c010632f88: Add pod metrics lookup and display in pod table.
+
+  ## Backwards incompatible changes
+
+  If your Kubernetes distribution does not have the [metrics server](https://github.com/kubernetes-sigs/metrics-server) installed,
+  you will need to set the `skipMetricsLookup` config flag to `false`.
+
+  See the [configuration docs](https://backstage.io/docs/features/kubernetes/configuration) for more details.
+
+## 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

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { V1Pod, V1Service, V1ConfigMap, V1Deployment, V1ReplicaSet, V1HorizontalPodAutoscaler, ExtensionsV1beta1Ingress } from '@kubernetes/client-node';
+import { JsonObject } from '@backstage/types';
+import { V1Pod, V1Service, V1ConfigMap, V1Deployment, V1ReplicaSet, V1HorizontalPodAutoscaler, V1Job, V1CronJob, V1Ingress } from '@kubernetes/client-node';
 import { Entity } from '@backstage/catalog-model';
 
 interface KubernetesRequestBody {
@@ -18,6 +19,7 @@ interface ClusterAttributes {
      * 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.
+     * Also, for cloud clusters such as GKE, you should provide addititonal parameters using dashboardParameters.
      * @see dashboardApp
      */
     dashboardUrl?: string;
@@ -37,17 +39,23 @@ interface ClusterAttributes {
      * ```
      */
     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.
+     */
+    dashboardParameters?: JsonObject;
 }
 interface ClusterObjects {
     cluster: ClusterAttributes;
     resources: FetchResponse[];
+    podMetrics: ClientPodStatus[];
     errors: KubernetesFetchError[];
 }
 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>;
@@ -72,9 +80,17 @@ 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>;
+    resources: Array<V1Ingress>;
 }
 interface CustomResourceFetchResponse {
     type: 'customresources';
@@ -86,5 +102,21 @@ interface KubernetesFetchError {
     resourcePath?: string;
 }
 declare type KubernetesErrorTypes = 'BAD_REQUEST' | 'UNAUTHORIZED_ERROR' | 'SYSTEM_ERROR' | 'UNKNOWN_ERROR';
+interface ClientCurrentResourceUsage {
+    currentUsage: number | string;
+    requestTotal: number | string;
+    limitTotal: number | string;
+}
+interface ClientContainerStatus {
+    container: string;
+    cpuUsage: ClientCurrentResourceUsage;
+    memoryUsage: ClientCurrentResourceUsage;
+}
+interface ClientPodStatus {
+    pod: V1Pod;
+    cpu: ClientCurrentResourceUsage;
+    memory: ClientCurrentResourceUsage;
+    containers: ClientContainerStatus[];
+}
 
-export { AuthProviderType, ClusterAttributes, ClusterObjects, ConfigMapFetchResponse, CustomResourceFetchResponse, DeploymentFetchResponse, FetchResponse, HorizontalPodAutoscalersFetchResponse, IngressesFetchResponse, KubernetesErrorTypes, KubernetesFetchError, KubernetesRequestBody, ObjectsByEntityResponse, PodFetchResponse, ReplicaSetsFetchResponse, ServiceFetchResponse };
+export { AuthProviderType, ClientContainerStatus, ClientCurrentResourceUsage, ClientPodStatus, ClusterAttributes, ClusterObjects, ConfigMapFetchResponse, CronJobsFetchResponse, CustomResourceFetchResponse, DeploymentFetchResponse, FetchResponse, HorizontalPodAutoscalersFetchResponse, IngressesFetchResponse, JobsFetchResponse, KubernetesErrorTypes, KubernetesFetchError, KubernetesRequestBody, ObjectsByEntityResponse, PodFetchResponse, ReplicaSetsFetchResponse, ServiceFetchResponse };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-kubernetes-common",
   "description": "Common functionalities for kubernetes, to be shared between kubernetes and kubernetes-backend plugin",
-  "version": "0.1.5",
+  "version": "0.2.1",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -35,17 +35,17 @@
     "url": "https://github.com/backstage/backstage/issues"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^0.9.4",
-    "@kubernetes/client-node": "^0.15.0"
+    "@backstage/catalog-model": "^0.9.7",
+    "@kubernetes/client-node": "^0.16.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.7.15"
+    "@backstage/cli": "^0.10.5"
   },
   "jest": {
     "roots": [
       ".."
     ]
   },
-  "gitHead": "16279cb3284369941e2eaf8b8968da207232cd6d",
+  "gitHead": "ffdb98aa2973366d48ff1774a7f892bc0c926e7e",
   "module": "dist/index.esm.js"
 }