@backstage/plugin-kubernetes 0.12.4 → 0.12.5-next.1

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-kubernetes
 
+## 0.12.5-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-components@0.16.5-next.0
+  - @backstage/plugin-catalog-react@1.16.0-next.1
+  - @backstage/core-compat-api@0.3.7-next.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/core-plugin-api@1.10.4
+  - @backstage/frontend-plugin-api@0.9.6-next.1
+  - @backstage/plugin-kubernetes-common@0.9.4-next.0
+  - @backstage/plugin-kubernetes-react@0.5.5-next.1
+  - @backstage/plugin-permission-react@0.4.31
+
+## 0.12.5-next.0
+
+### Patch Changes
+
+- d517d13: refactor: use `KUBERNETES_ANNOTATION` and `KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION` annotations from `kubernetes-common`
+- ba9649a: Set deployment as the default group of Kubernetes entity content. It is just an example and shouldn't cause any visual difference since entity page tabs with just one entity content appear as normal tabs.
+- Updated dependencies
+  - @backstage/plugin-kubernetes-common@0.9.4-next.0
+  - @backstage/plugin-catalog-react@1.16.0-next.0
+  - @backstage/frontend-plugin-api@0.9.6-next.0
+  - @backstage/plugin-kubernetes-react@0.5.5-next.0
+  - @backstage/core-compat-api@0.3.7-next.0
+
 ## 0.12.4
 
 ### Patch Changes

package/dist/Router.esm.js

@@ -3,9 +3,8 @@ import { useEntity, MissingAnnotationEmptyState } from '@backstage/plugin-catalo
 import { Routes, Route } from 'react-router-dom';
 import { KubernetesContent } from './KubernetesContent.esm.js';
 import Button from '@material-ui/core/Button';
+import { KUBERNETES_ANNOTATION, KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION } from '@backstage/plugin-kubernetes-common';
 
-const KUBERNETES_ANNOTATION = "backstage.io/kubernetes-id";
-const KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION = "backstage.io/kubernetes-label-selector";
 const isKubernetesAvailable = (entity) => Boolean(entity.metadata.annotations?.[KUBERNETES_ANNOTATION]) || Boolean(
   entity.metadata.annotations?.[KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION]
 );

package/dist/Router.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"Router.esm.js","sources":["../src/Router.tsx"],"sourcesContent":["/*\n * Copyright 2020 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 */\n\nimport React from 'react';\nimport { Entity } from '@backstage/catalog-model';\nimport {\n  useEntity,\n  MissingAnnotationEmptyState,\n} from '@backstage/plugin-catalog-react';\nimport { Route, Routes } from 'react-router-dom';\nimport { KubernetesContent } from './KubernetesContent';\nimport Button from '@material-ui/core/Button';\n\nconst KUBERNETES_ANNOTATION = 'backstage.io/kubernetes-id';\nconst KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION =\n  'backstage.io/kubernetes-label-selector';\n\nexport const isKubernetesAvailable = (entity: Entity) =>\n  Boolean(entity.metadata.annotations?.[KUBERNETES_ANNOTATION]) ||\n  Boolean(\n    entity.metadata.annotations?.[KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION],\n  );\n\nexport const Router = (props: { refreshIntervalMs?: number }) => {\n  const { entity } = useEntity();\n\n  const kubernetesAnnotationValue =\n    entity.metadata.annotations?.[KUBERNETES_ANNOTATION];\n\n  const kubernetesLabelSelectorQueryAnnotationValue =\n    entity.metadata.annotations?.[KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION];\n\n  if (\n    kubernetesAnnotationValue ||\n    kubernetesLabelSelectorQueryAnnotationValue\n  ) {\n    return (\n      <Routes>\n        <Route\n          path=\"/\"\n          element={\n            <KubernetesContent\n              entity={entity}\n              refreshIntervalMs={props.refreshIntervalMs}\n            />\n          }\n        />\n      </Routes>\n    );\n  }\n\n  return (\n    <>\n      <MissingAnnotationEmptyState annotation={KUBERNETES_ANNOTATION} />\n      <h1>\n        Or use a label selector query, which takes precedence over the previous\n        annotation.\n      </h1>\n      <Button\n        variant=\"contained\"\n        color=\"primary\"\n        href=\"https://backstage.io/docs/features/kubernetes/configuration#surfacing-your-kubernetes-components-as-part-of-an-entity\"\n      >\n        Read Kubernetes Plugin Docs\n      </Button>\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;;;AA0BA,MAAM,qBAAwB,GAAA,4BAAA;AAC9B,MAAM,0CACJ,GAAA,wCAAA;AAEW,MAAA,qBAAA,GAAwB,CAAC,MACpC,KAAA,OAAA,CAAQ,OAAO,QAAS,CAAA,WAAA,GAAc,qBAAqB,CAAC,CAC5D,IAAA,OAAA;AAAA,EACE,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,0CAA0C;AAC1E;AAEW,MAAA,MAAA,GAAS,CAAC,KAA0C,KAAA;AAC/D,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,SAAU,EAAA;AAE7B,EAAA,MAAM,yBACJ,GAAA,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,qBAAqB,CAAA;AAErD,EAAA,MAAM,2CACJ,GAAA,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,0CAA0C,CAAA;AAE1E,EAAA,IACE,6BACA,2CACA,EAAA;AACA,IAAA,2CACG,MACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,IAAK,EAAA,GAAA;AAAA,QACL,OACE,kBAAA,KAAA,CAAA,aAAA;AAAA,UAAC,iBAAA;AAAA,UAAA;AAAA,YACC,MAAA;AAAA,YACA,mBAAmB,KAAM,CAAA;AAAA;AAAA;AAC3B;AAAA,KAGN,CAAA;AAAA;AAIJ,EACE,uBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,sCACG,2BAA4B,EAAA,EAAA,UAAA,EAAY,uBAAuB,CAChE,kBAAA,KAAA,CAAA,aAAA,CAAC,IAAG,EAAA,IAAA,EAAA,qFAGJ,CACA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,MAAA;AAAA,IAAA;AAAA,MACC,OAAQ,EAAA,WAAA;AAAA,MACR,KAAM,EAAA,SAAA;AAAA,MACN,IAAK,EAAA;AAAA,KAAA;AAAA,IACN;AAAA,GAGH,CAAA;AAEJ;;;;"}
+{"version":3,"file":"Router.esm.js","sources":["../src/Router.tsx"],"sourcesContent":["/*\n * Copyright 2020 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 */\n\nimport React from 'react';\nimport { Entity } from '@backstage/catalog-model';\nimport {\n  useEntity,\n  MissingAnnotationEmptyState,\n} from '@backstage/plugin-catalog-react';\nimport { Route, Routes } from 'react-router-dom';\nimport { KubernetesContent } from './KubernetesContent';\nimport Button from '@material-ui/core/Button';\nimport {\n  KUBERNETES_ANNOTATION,\n  KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION,\n} from '@backstage/plugin-kubernetes-common';\n\nexport const isKubernetesAvailable = (entity: Entity) =>\n  Boolean(entity.metadata.annotations?.[KUBERNETES_ANNOTATION]) ||\n  Boolean(\n    entity.metadata.annotations?.[KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION],\n  );\n\nexport const Router = (props: { refreshIntervalMs?: number }) => {\n  const { entity } = useEntity();\n\n  const kubernetesAnnotationValue =\n    entity.metadata.annotations?.[KUBERNETES_ANNOTATION];\n\n  const kubernetesLabelSelectorQueryAnnotationValue =\n    entity.metadata.annotations?.[KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION];\n\n  if (\n    kubernetesAnnotationValue ||\n    kubernetesLabelSelectorQueryAnnotationValue\n  ) {\n    return (\n      <Routes>\n        <Route\n          path=\"/\"\n          element={\n            <KubernetesContent\n              entity={entity}\n              refreshIntervalMs={props.refreshIntervalMs}\n            />\n          }\n        />\n      </Routes>\n    );\n  }\n\n  return (\n    <>\n      <MissingAnnotationEmptyState annotation={KUBERNETES_ANNOTATION} />\n      <h1>\n        Or use a label selector query, which takes precedence over the previous\n        annotation.\n      </h1>\n      <Button\n        variant=\"contained\"\n        color=\"primary\"\n        href=\"https://backstage.io/docs/features/kubernetes/configuration#surfacing-your-kubernetes-components-as-part-of-an-entity\"\n      >\n        Read Kubernetes Plugin Docs\n      </Button>\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;;;;AA8Ba,MAAA,qBAAA,GAAwB,CAAC,MACpC,KAAA,OAAA,CAAQ,OAAO,QAAS,CAAA,WAAA,GAAc,qBAAqB,CAAC,CAC5D,IAAA,OAAA;AAAA,EACE,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,0CAA0C;AAC1E;AAEW,MAAA,MAAA,GAAS,CAAC,KAA0C,KAAA;AAC/D,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,SAAU,EAAA;AAE7B,EAAA,MAAM,yBACJ,GAAA,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,qBAAqB,CAAA;AAErD,EAAA,MAAM,2CACJ,GAAA,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,0CAA0C,CAAA;AAE1E,EAAA,IACE,6BACA,2CACA,EAAA;AACA,IAAA,2CACG,MACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,IAAK,EAAA,GAAA;AAAA,QACL,OACE,kBAAA,KAAA,CAAA,aAAA;AAAA,UAAC,iBAAA;AAAA,UAAA;AAAA,YACC,MAAA;AAAA,YACA,mBAAmB,KAAM,CAAA;AAAA;AAAA;AAC3B;AAAA,KAGN,CAAA;AAAA;AAIJ,EACE,uBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,sCACG,2BAA4B,EAAA,EAAA,UAAA,EAAY,uBAAuB,CAChE,kBAAA,KAAA,CAAA,aAAA,CAAC,IAAG,EAAA,IAAA,EAAA,qFAGJ,CACA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,MAAA;AAAA,IAAA;AAAA,MACC,OAAQ,EAAA,WAAA;AAAA,MACR,KAAM,EAAA,SAAA;AAAA,MACN,IAAK,EAAA;AAAA,KAAA;AAAA,IACN;AAAA,GAGH,CAAA;AAEJ;;;;"}

package/dist/alpha/entityContents.esm.js

@@ -7,6 +7,7 @@ const entityKubernetesContent = EntityContentBlueprint.make({
   params: {
     defaultPath: "/kubernetes",
     defaultTitle: "Kubernetes",
+    defaultGroup: "deployment",
     filter: "kind:component,resource",
     loader: () => import('./KubernetesContentPage.esm.js').then(
       (m) => compatWrapper(/* @__PURE__ */ React.createElement(m.KubernetesContentPage, null))

package/dist/alpha/entityContents.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"entityContents.esm.js","sources":["../../src/alpha/entityContents.tsx"],"sourcesContent":["/*\n * Copyright 2024 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 */\n\nimport React from 'react';\nimport { compatWrapper } from '@backstage/core-compat-api';\nimport { EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';\n\nexport const entityKubernetesContent = EntityContentBlueprint.make({\n  name: 'kubernetes',\n  params: {\n    defaultPath: '/kubernetes',\n    defaultTitle: 'Kubernetes',\n    filter: 'kind:component,resource',\n    loader: () =>\n      import('./KubernetesContentPage').then(m =>\n        compatWrapper(<m.KubernetesContentPage />),\n      ),\n  },\n});\n"],"names":[],"mappings":";;;;AAoBa,MAAA,uBAAA,GAA0B,uBAAuB,IAAK,CAAA;AAAA,EACjE,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,WAAa,EAAA,aAAA;AAAA,IACb,YAAc,EAAA,YAAA;AAAA,IACd,MAAQ,EAAA,yBAAA;AAAA,IACR,MAAQ,EAAA,MACN,OAAO,gCAAyB,CAAE,CAAA,IAAA;AAAA,MAAK,OACrC,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,qBAAA,EAAF,IAAwB,CAAE;AAAA;AAC3C;AAEN,CAAC;;;;"}
+{"version":3,"file":"entityContents.esm.js","sources":["../../src/alpha/entityContents.tsx"],"sourcesContent":["/*\n * Copyright 2024 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 */\n\nimport React from 'react';\nimport { compatWrapper } from '@backstage/core-compat-api';\nimport { EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';\n\nexport const entityKubernetesContent = EntityContentBlueprint.make({\n  name: 'kubernetes',\n  params: {\n    defaultPath: '/kubernetes',\n    defaultTitle: 'Kubernetes',\n    defaultGroup: 'deployment',\n    filter: 'kind:component,resource',\n    loader: () =>\n      import('./KubernetesContentPage').then(m =>\n        compatWrapper(<m.KubernetesContentPage />),\n      ),\n  },\n});\n"],"names":[],"mappings":";;;;AAoBa,MAAA,uBAAA,GAA0B,uBAAuB,IAAK,CAAA;AAAA,EACjE,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,WAAa,EAAA,aAAA;AAAA,IACb,YAAc,EAAA,YAAA;AAAA,IACd,YAAc,EAAA,YAAA;AAAA,IACd,MAAQ,EAAA,yBAAA;AAAA,IACR,MAAQ,EAAA,MACN,OAAO,gCAAyB,CAAE,CAAA,IAAA;AAAA,MAAK,OACrC,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,qBAAA,EAAF,IAAwB,CAAE;AAAA;AAC3C;AAEN,CAAC;;;;"}

package/dist/alpha.d.ts

@@ -13,6 +13,17 @@ declare const kubernetesTranslationRef: _backstage_core_plugin_api_alpha.Transla
 declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
     kubernetes: _backstage_frontend_plugin_api.RouteRef<undefined>;
 }, {}, {
+    "api:kubernetes": _backstage_frontend_plugin_api.ExtensionDefinition<{
+        kind: "api";
+        name: undefined;
+        config: {};
+        configInput: {};
+        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
+        inputs: {};
+        params: {
+            factory: _backstage_frontend_plugin_api.AnyApiFactory;
+        };
+    }>;
     "page:kubernetes": _backstage_frontend_plugin_api.ExtensionDefinition<{
         kind: "page";
         name: undefined;
@@ -32,17 +43,6 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
             routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
         };
     }>;
-    "api:kubernetes": _backstage_frontend_plugin_api.ExtensionDefinition<{
-        kind: "api";
-        name: undefined;
-        config: {};
-        configInput: {};
-        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
-        inputs: {};
-        params: {
-            factory: _backstage_frontend_plugin_api.AnyApiFactory;
-        };
-    }>;
     "entity-content:kubernetes/kubernetes": _backstage_frontend_plugin_api.ExtensionDefinition<{
         kind: "entity-content";
         name: "kubernetes";
@@ -50,11 +50,13 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
             path: string | undefined;
             title: string | undefined;
             filter: string | undefined;
+            group: string | false | undefined;
         };
         configInput: {
             filter?: string | undefined;
             title?: string | undefined;
             path?: string | undefined;
+            group?: string | false | undefined;
         };
         output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
             optional: true;
@@ -62,12 +64,15 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
             optional: true;
         }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
             optional: true;
+        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-group", {
+            optional: true;
         }>;
         inputs: {};
         params: {
             loader: () => Promise<JSX.Element>;
             defaultPath: string;
             defaultTitle: string;
+            defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
             routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
             filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-kubernetes",
-  "version": "0.12.4",
+  "version": "0.12.5-next.1",
   "description": "A Backstage plugin that integrates towards Kubernetes",
   "backstage": {
     "role": "frontend-plugin",
@@ -70,15 +70,15 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.7.3",
-    "@backstage/core-compat-api": "^0.3.6",
-    "@backstage/core-components": "^0.16.4",
-    "@backstage/core-plugin-api": "^1.10.4",
-    "@backstage/frontend-plugin-api": "^0.9.5",
-    "@backstage/plugin-catalog-react": "^1.15.2",
-    "@backstage/plugin-kubernetes-common": "^0.9.3",
-    "@backstage/plugin-kubernetes-react": "^0.5.4",
-    "@backstage/plugin-permission-react": "^0.4.31",
+    "@backstage/catalog-model": "1.7.3",
+    "@backstage/core-compat-api": "0.3.7-next.1",
+    "@backstage/core-components": "0.16.5-next.0",
+    "@backstage/core-plugin-api": "1.10.4",
+    "@backstage/frontend-plugin-api": "0.9.6-next.1",
+    "@backstage/plugin-catalog-react": "1.16.0-next.1",
+    "@backstage/plugin-kubernetes-common": "0.9.4-next.0",
+    "@backstage/plugin-kubernetes-react": "0.5.5-next.1",
+    "@backstage/plugin-permission-react": "0.4.31",
     "@kubernetes-models/apimachinery": "^2.0.0",
     "@kubernetes-models/base": "^5.0.0",
     "@kubernetes/client-node": "1.0.0-rc7",
@@ -93,9 +93,9 @@
     "xterm-addon-fit": "^0.8.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.30.0",
-    "@backstage/dev-utils": "^1.1.7",
-    "@backstage/test-utils": "^1.7.5",
+    "@backstage/cli": "0.30.1-next.0",
+    "@backstage/dev-utils": "1.1.8-next.1",
+    "@backstage/test-utils": "1.7.5",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",