@backstage/plugin-kubernetes 0.5.0 → 0.5.4

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # @backstage/plugin-kubernetes
 
+## 0.5.4
+
+### Patch Changes
+
+- 7612e2856b: Clean up emptystate.svg image, removing wrong white artifact from the background
+- Updated dependencies
+  - @backstage/config@0.1.12
+  - @backstage/core-components@0.8.4
+  - @backstage/core-plugin-api@0.5.0
+  - @backstage/plugin-catalog-react@0.6.11
+  - @backstage/catalog-model@0.9.9
+
+## 0.5.3
+
+### Patch Changes
+
+- 7ac0bd2c66: implement dashboard link formatter for GKE
+- 4ce51ab0f1: Internal refactor of the `react-use` imports to use `react-use/lib/*` instead.
+- Updated dependencies
+  - @backstage/core-plugin-api@0.4.1
+  - @backstage/plugin-catalog-react@0.6.10
+  - @backstage/plugin-kubernetes-common@0.2.1
+  - @backstage/core-components@0.8.3
+
+## 0.5.2
+
+### Patch Changes
+
+- 610614a06d: Includes `KubernetesBackendClient` in the export to allow developers to use it externally.
+- Updated dependencies
+  - @backstage/core-plugin-api@0.4.0
+  - @backstage/plugin-catalog-react@0.6.8
+  - @backstage/core-components@0.8.2
+
+## 0.5.1
+
+### Patch Changes
+
+- 6f0c850a86: Fixed styling bug for the CronJobsAccordions and updated Completed pods to display a green dot.
+- Updated dependencies
+  - @backstage/core-plugin-api@0.3.1
+  - @backstage/core-components@0.8.1
+  - @backstage/catalog-model@0.9.8
+  - @backstage/plugin-catalog-react@0.6.7
+
 ## 0.5.0
 
 ### Minor Changes

package/dist/assets/emptystate.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="282" height="173" fill="none" viewBox="0 0 282 173"><path fill="#000" fill-opacity=".05" fill-rule="evenodd" d="M16.4571 45.1637C11.0514 46.1711 7.48574 51.3699 8.49306 56.7756C9.50039 62.1814 14.6992 65.747 20.105 64.7397L27.5528 63.3518C25.4791 65.5835 24.4525 68.7347 25.0535 71.9596C26.0608 77.3653 31.2596 80.931 36.6654 79.9236L89.691 70.0427C89.7016 70.1067 89.7129 70.1708 89.7249 70.2349C90.3258 73.4598 92.4185 76.0298 95.1569 77.3647L91.9031 77.971C86.4974 78.9784 82.9318 84.1772 83.9391 89.583C84.9464 94.9887 90.1452 98.5543 95.551 97.547L250.098 68.7482C255.504 67.7409 259.069 62.5421 258.062 57.1363C257.461 53.9114 255.368 51.3414 252.63 50.0065L257.835 49.0366C263.241 48.0292 266.807 42.8304 265.799 37.4247C264.792 32.0189 259.593 28.4533 254.187 29.4606L161.492 46.7338C161.481 46.6697 161.47 46.6056 161.458 46.5415C160.857 43.3166 158.764 40.7466 156.026 39.4117L165.025 37.7347C170.431 36.7274 173.997 31.5286 172.989 26.1228C171.982 20.7171 166.783 17.1514 161.378 18.1588L16.4571 45.1637ZM24.3031 122.54C23.2958 117.134 26.8614 111.936 32.2672 110.928L190.856 81.3762C196.262 80.3688 201.461 83.9345 202.468 89.3402C203.476 94.746 199.91 99.9448 194.504 100.952L189.963 101.798C190.493 102.057 190.999 102.362 191.474 102.708L246.43 92.4677C251.835 91.4604 257.034 95.026 258.041 100.432C258.642 103.657 257.616 106.808 255.542 109.04L256.649 108.833C262.055 107.826 267.253 111.392 268.261 116.797C269.268 122.203 265.702 127.402 260.297 128.409L95.5591 159.107C90.1534 160.114 84.9545 156.549 83.9472 151.143C82.9399 145.737 86.5055 140.538 91.9113 139.531L103.94 137.29C103.41 137.031 102.904 136.726 102.429 136.38L29.1002 150.044C23.6944 151.051 18.4956 147.486 17.4882 142.08C16.4809 136.674 20.0465 131.475 25.4523 130.468L29.7352 129.67C26.9967 128.335 24.904 125.765 24.3031 122.54Z" clip-rule="evenodd"/><g filter="url(#filter0_d)"><path fill="#EEE" d="M232.896 31.2403H51.2975C49.1452 31.2403 47.4005 32.983 47.4005 35.1327V46.8101C47.4005 48.9598 49.1452 50.7025 51.2975 50.7025H232.896C235.048 50.7025 236.793 48.9598 236.793 46.8101V35.1327C236.793 32.983 235.048 31.2403 232.896 31.2403Z"/><mask id="mask0" width="190" height="114" x="47" y="31" mask-type="alpha" maskUnits="userSpaceOnUse"><path fill="#404040" d="M232.896 31.2403H51.2975C49.1452 31.2403 47.4005 32.983 47.4005 35.1327V141.007C47.4005 143.157 49.1452 144.9 51.2975 144.9H232.896C235.048 144.9 236.793 143.157 236.793 141.007V35.1327C236.793 32.983 235.048 31.2403 232.896 31.2403Z"/></mask><g mask="url(#mask0)"><path fill="#EEE" d="M239.91 42.1391H47.4005V150.349H239.91V42.1391Z"/></g></g><circle cx="188" cy="55" r="6" fill="#69DDC7"/><circle cx="91" cy="92" r="6" fill="#69DDC7"/><path fill="#69DDC7" d="M121 114L95.5 88L86.5 96L121 130L192.5 59L183.5 51L121 114Z"/><defs><filter id="filter0_d" width="229.392" height="153.66" x="29.401" y="15.24" color-interpolation-filters="sRGB" filterUnits="userSpaceOnUse"><feFlood flood-opacity="0" result="BackgroundImageFix"/><feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0"/><feOffset dx="2" dy="4"/><feGaussianBlur stdDeviation="10"/><feColorMatrix type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0.25 0"/><feBlend in2="BackgroundImageFix" mode="normal" result="effect1_dropShadow"/><feBlend in="SourceGraphic" in2="effect1_dropShadow" mode="normal" result="shape"/></filter></defs></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="282" height="173" fill="none" viewBox="0 0 282 173"><path fill="#000" fill-opacity=".05" fill-rule="evenodd" d="M16.4571 45.1637C11.0514 46.1711 7.48574 51.3699 8.49306 56.7756C9.50039 62.1814 14.6992 65.747 20.105 64.7397L27.5528 63.3518C25.4791 65.5835 24.4525 68.7347 25.0535 71.9596C26.0608 77.3653 31.2596 80.931 36.6654 79.9236L89.691 70.0427C89.7016 70.1067 89.7129 70.1708 89.7249 70.2349C90.3258 73.4598 92.4185 76.0298 95.1569 77.3647L91.9031 77.971C86.4974 78.9784 82.9318 84.1772 83.9391 89.583C84.9464 94.9887 90.1452 98.5543 95.551 97.547L250.098 68.7482C255.504 67.7409 259.069 62.5421 258.062 57.1363C257.461 53.9114 255.368 51.3414 252.63 50.0065L257.835 49.0366C263.241 48.0292 266.807 42.8304 265.799 37.4247C264.792 32.0189 259.593 28.4533 254.187 29.4606L161.492 46.7338C161.481 46.6697 161.47 46.6056 161.458 46.5415C160.857 43.3166 158.764 40.7466 156.026 39.4117L165.025 37.7347C170.431 36.7274 173.997 31.5286 172.989 26.1228C171.982 20.7171 166.783 17.1514 161.378 18.1588L16.4571 45.1637ZM24.3031 122.54C23.2958 117.134 26.8614 111.936 32.2672 110.928L190.856 81.3762C196.262 80.3688 201.461 83.9345 202.468 89.3402C203.476 94.746 199.91 99.9448 194.504 100.952L189.963 101.798C190.493 102.057 190.999 102.362 191.474 102.708L246.43 92.4677C251.835 91.4604 257.034 95.026 258.041 100.432C258.642 103.657 257.616 106.808 255.542 109.04L256.649 108.833C262.055 107.826 267.253 111.392 268.261 116.797C269.268 122.203 265.702 127.402 260.297 128.409L95.5591 159.107C90.1534 160.114 84.9545 156.549 83.9472 151.143C82.9399 145.737 86.5055 140.538 91.9113 139.531L103.94 137.29C103.41 137.031 102.904 136.726 102.429 136.38L29.1002 150.044C23.6944 151.051 18.4956 147.486 17.4882 142.08C16.4809 136.674 20.0465 131.475 25.4523 130.468L29.7352 129.67C26.9967 128.335 24.904 125.765 24.3031 122.54Z" clip-rule="evenodd"/><circle cx="188" cy="55" r="6" fill="#69DDC7"/><circle cx="91" cy="92" r="6" fill="#69DDC7"/><path fill="#69DDC7" d="M121 114L95.5 88L86.5 96L121 130L192.5 59L183.5 51L121 114Z"/></svg>

package/dist/index.d.ts

@@ -2,8 +2,9 @@
 import * as _backstage_catalog_model from '@backstage/catalog-model';
 import { Entity } from '@backstage/catalog-model';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
-import { OAuthApi } from '@backstage/core-plugin-api';
+import { DiscoveryApi, IdentityApi, OAuthApi } from '@backstage/core-plugin-api';
 import { KubernetesRequestBody, ObjectsByEntityResponse } from '@backstage/plugin-kubernetes-common';
+import { JsonObject } from '@backstage/types';
 
 declare const kubernetesPlugin: _backstage_core_plugin_api.BackstagePlugin<{
     entityContent: _backstage_core_plugin_api.RouteRef<undefined>;
@@ -28,6 +29,22 @@ interface KubernetesApi {
     }[]>;
 }
 
+declare class KubernetesBackendClient implements KubernetesApi {
+    private readonly discoveryApi;
+    private readonly identityApi;
+    constructor(options: {
+        discoveryApi: DiscoveryApi;
+        identityApi: IdentityApi;
+    });
+    private handleResponse;
+    private postRequired;
+    getObjectsByEntity(requestBody: KubernetesRequestBody): Promise<ObjectsByEntityResponse>;
+    getClusters(): Promise<{
+        name: string;
+        authProvider: string;
+    }[]>;
+}
+
 declare const kubernetesAuthProvidersApiRef: _backstage_core_plugin_api.ApiRef<KubernetesAuthProvidersApi>;
 interface KubernetesAuthProvidersApi {
     decorateRequestBodyForAuth(authProvider: string, requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
@@ -44,13 +61,15 @@ declare class KubernetesAuthProviders implements KubernetesAuthProvidersApi {
 declare type FormatClusterLinkOptions = {
     dashboardUrl?: string;
     dashboardApp?: string;
+    dashboardParameters?: JsonObject;
     object: any;
     kind: string;
 };
 declare function formatClusterLink(options: FormatClusterLinkOptions): string | undefined;
 
 interface ClusterLinksFormatterOptions {
-    dashboardUrl: URL;
+    dashboardUrl?: URL;
+    dashboardParameters?: JsonObject;
     object: any;
     kind: string;
 }
@@ -58,4 +77,4 @@ declare type ClusterLinksFormatter = (options: ClusterLinksFormatterOptions) =>
 
 declare const clusterLinksFormatters: Record<string, ClusterLinksFormatter>;
 
-export { EntityKubernetesContent, KubernetesApi, KubernetesAuthProviders, KubernetesAuthProvidersApi, Router, clusterLinksFormatters, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin };
+export { EntityKubernetesContent, KubernetesApi, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, Router, clusterLinksFormatters, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin };

package/dist/index.esm.js

@@ -11,7 +11,7 @@ import Close from '@material-ui/icons/Close';
 import OpenInNewIcon from '@material-ui/icons/OpenInNew';
 import { withStyles } from '@material-ui/core/styles';
 import jsYaml from 'js-yaml';
-import { useInterval } from 'react-use';
+import useInterval from 'react-use/lib/useInterval';
 import cronstrue from 'cronstrue';
 import lodash from 'lodash';
 import PauseIcon from '@material-ui/icons/Pause';
@@ -68,13 +68,11 @@ class KubernetesBackendClient {
 }
 
 const kubernetesApiRef = createApiRef({
-  id: "plugin.kubernetes.service",
-  description: "Used by the Kubernetes plugin to make requests to accompanying backend"
+  id: "plugin.kubernetes.service"
 });
 
 const kubernetesAuthProvidersApiRef = createApiRef({
-  id: "plugin.kubernetes-auth-providers.service",
-  description: "Used by the Kubernetes plugin to fetch KubernetesAuthProviders"
+  id: "plugin.kubernetes-auth-providers.service"
 });
 
 class GoogleKubernetesAuthProvider {
@@ -339,7 +337,7 @@ const containerStatuses = (pod) => {
       return /* @__PURE__ */ React__default.createElement(Fragment, {
         key: `${(_a2 = pod.metadata) == null ? void 0 : _a2.name}-${next.name}`
       }, /* @__PURE__ */ React__default.createElement(SubvalueCell, {
-        value: /* @__PURE__ */ React__default.createElement(StatusError, null, "Container: ", next.name),
+        value: reason === "Completed" ? /* @__PURE__ */ React__default.createElement(StatusOK, null, "Container: ", next.name) : /* @__PURE__ */ React__default.createElement(StatusError, null, "Container: ", next.name),
         subvalue: reason
       }), /* @__PURE__ */ React__default.createElement("br", null));
     };
@@ -626,18 +624,22 @@ const ClusterContext = React__default.createContext({
   name: ""
 });
 
-const kindMappings$2 = {
+const kindMappings$3 = {
   deployment: "deployment",
+  pod: "pod",
   ingress: "ingress",
   service: "service",
   horizontalpodautoscaler: "deployment"
 };
 function standardFormatter(options) {
   var _a, _b, _c, _d;
+  if (!options.dashboardUrl) {
+    throw new Error("standard dashboard requires a dashboardUrl option");
+  }
   const result = new URL(options.dashboardUrl.href);
   const name = encodeURIComponent((_b = (_a = options.object.metadata) == null ? void 0 : _a.name) != null ? _b : "");
   const namespace = encodeURIComponent((_d = (_c = options.object.metadata) == null ? void 0 : _c.namespace) != null ? _d : "");
-  const validKind = kindMappings$2[options.kind.toLocaleLowerCase("en-US")];
+  const validKind = kindMappings$3[options.kind.toLocaleLowerCase("en-US")];
   if (!result.pathname.endsWith("/")) {
     result.pathname += "/";
   }
@@ -652,7 +654,7 @@ function standardFormatter(options) {
   return result;
 }
 
-const kindMappings$1 = {
+const kindMappings$2 = {
   deployment: "apps.deployment",
   ingress: "networking.k8s.io.ingress",
   service: "service",
@@ -660,10 +662,13 @@ const kindMappings$1 = {
 };
 function rancherFormatter(options) {
   var _a, _b, _c, _d;
+  if (!options.dashboardUrl) {
+    throw new Error("Rancher dashboard requires a dashboardUrl option");
+  }
   const basePath = new URL(options.dashboardUrl.href);
   const name = encodeURIComponent((_b = (_a = options.object.metadata) == null ? void 0 : _a.name) != null ? _b : "");
   const namespace = encodeURIComponent((_d = (_c = options.object.metadata) == null ? void 0 : _c.namespace) != null ? _d : "");
-  const validKind = kindMappings$1[options.kind.toLocaleLowerCase("en-US")];
+  const validKind = kindMappings$2[options.kind.toLocaleLowerCase("en-US")];
   if (!basePath.pathname.endsWith("/")) {
     basePath.pathname += "/";
   }
@@ -676,7 +681,7 @@ function rancherFormatter(options) {
   return new URL(path, basePath);
 }
 
-const kindMappings = {
+const kindMappings$1 = {
   deployment: "deployments",
   ingress: "ingresses",
   service: "services",
@@ -685,10 +690,13 @@ const kindMappings = {
 };
 function openshiftFormatter(options) {
   var _a, _b, _c, _d;
+  if (!options.dashboardUrl) {
+    throw new Error("OpenShift dashboard requires a dashboardUrl option");
+  }
   const basePath = new URL(options.dashboardUrl.href);
   const name = encodeURIComponent((_b = (_a = options.object.metadata) == null ? void 0 : _a.name) != null ? _b : "");
   const namespace = encodeURIComponent((_d = (_c = options.object.metadata) == null ? void 0 : _c.namespace) != null ? _d : "");
-  const validKind = kindMappings[options.kind.toLocaleLowerCase("en-US")];
+  const validKind = kindMappings$1[options.kind.toLocaleLowerCase("en-US")];
   if (!basePath.pathname.endsWith("/")) {
     basePath.pathname += "/";
   }
@@ -716,8 +724,45 @@ function eksFormatter(_options) {
   throw new Error("EKS formatter is not yet implemented. Please, contribute!");
 }
 
-function gkeFormatter(_options) {
-  throw new Error("GKE formatter is not yet implemented. Please, contribute!");
+const kindMappings = {
+  deployment: "deployment",
+  pod: "pod",
+  ingress: "ingress",
+  service: "service",
+  horizontalpodautoscaler: "deployment"
+};
+function gkeFormatter(options) {
+  var _a, _b, _c, _d;
+  if (!options.dashboardParameters) {
+    throw new Error("GKE dashboard requires a dashboardParameters option");
+  }
+  const args = options.dashboardParameters;
+  if (typeof args.projectId !== "string") {
+    throw new Error('GKE dashboard requires a "projectId" of type string in the dashboardParameters option');
+  }
+  if (typeof args.region !== "string") {
+    throw new Error('GKE dashboard requires a "region" of type string in the dashboardParameters option');
+  }
+  if (typeof args.clusterName !== "string") {
+    throw new Error('GKE dashboard requires a "clusterName" of type string in the dashboardParameters option');
+  }
+  const basePath = new URL("https://console.cloud.google.com/");
+  const region = encodeURIComponent(args.region);
+  const clusterName = encodeURIComponent(args.clusterName);
+  const name = encodeURIComponent((_b = (_a = options.object.metadata) == null ? void 0 : _a.name) != null ? _b : "");
+  const namespace = encodeURIComponent((_d = (_c = options.object.metadata) == null ? void 0 : _c.namespace) != null ? _d : "");
+  const validKind = kindMappings[options.kind.toLocaleLowerCase("en-US")];
+  let path = "";
+  if (namespace && name && validKind) {
+    const kindsWithDetails = ["ingress", "pod"];
+    const landingPage = kindsWithDetails.includes(validKind) ? "details" : "overview";
+    path = `kubernetes/${validKind}/${region}/${clusterName}/${namespace}/${name}/${landingPage}`;
+  } else {
+    path = `kubernetes/clusters/details/${region}/${clusterName}/details`;
+  }
+  const result = new URL(path, basePath);
+  result.searchParams.set("project", args.projectId);
+  return result;
 }
 
 const clusterLinksFormatters = {
@@ -731,10 +776,10 @@ const clusterLinksFormatters = {
 const defaultFormatterName = "standard";
 
 function formatClusterLink(options) {
-  if (!options.dashboardUrl) {
+  if (!options.dashboardUrl && !options.dashboardParameters) {
     return void 0;
   }
-  if (!options.object) {
+  if (options.dashboardUrl && !options.object) {
     return options.dashboardUrl;
   }
   const app = options.dashboardApp || defaultFormatterName;
@@ -743,7 +788,8 @@ function formatClusterLink(options) {
     throw new Error(`Could not find Kubernetes dashboard app named '${app}'`);
   }
   const url = formatter({
-    dashboardUrl: new URL(options.dashboardUrl),
+    dashboardUrl: options.dashboardUrl ? new URL(options.dashboardUrl) : void 0,
+    dashboardParameters: options.dashboardParameters,
     object: options.object,
     kind: options.kind
   });
@@ -823,6 +869,7 @@ const KubernetesDrawerContent = ({
   const { clusterLink, errorMessage } = tryFormatClusterLink({
     dashboardUrl: cluster.dashboardUrl,
     dashboardApp: cluster.dashboardApp,
+    dashboardParameters: cluster.dashboardParameters,
     object,
     kind
   });
@@ -2048,9 +2095,9 @@ const Cluster = ({ clusterObjects, podsWithErrors }) => {
     item: true
   }, /* @__PURE__ */ React__default.createElement(IngressesAccordions, null)), /* @__PURE__ */ React__default.createElement(Grid, {
     item: true
-  }, /* @__PURE__ */ React__default.createElement(ServicesAccordions, null))), /* @__PURE__ */ React__default.createElement(Grid, {
+  }, /* @__PURE__ */ React__default.createElement(ServicesAccordions, null)), /* @__PURE__ */ React__default.createElement(Grid, {
     item: true
-  }, /* @__PURE__ */ React__default.createElement(CronJobsAccordions, null))))))));
+  }, /* @__PURE__ */ React__default.createElement(CronJobsAccordions, null)))))))));
 };
 
 const KubernetesContent = ({ entity }) => {
@@ -2161,5 +2208,5 @@ var Router$1 = /*#__PURE__*/Object.freeze({
   Router: Router
 });
 
-export { EntityKubernetesContent, KubernetesAuthProviders, Router, clusterLinksFormatters, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin };
+export { EntityKubernetesContent, KubernetesAuthProviders, KubernetesBackendClient, Router, clusterLinksFormatters, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin };
 //# sourceMappingURL=index.esm.js.map