chore(annotations): add support for kubernetes ns annotation (#71)

* chore(annotations): add helpers and kubernetes namespace

Signed-off-by: Jonas Beck <dev@jonasbeck.dk>

* chore(content): make use of new annotation helpers

Signed-off-by: Jonas Beck <dev@jonasbeck.dk>

* chore(changeset): add changeset

Signed-off-by: Jonas Beck <dev@jonasbeck.dk>

* test(annotations): remove invalid test case

Signed-off-by: Jonas Beck <dev@jonasbeck.dk>

---------

Signed-off-by: Jonas Beck <dev@jonasbeck.dk>

Author: Jonas-Beck

.changeset/little-otters-bathe.md

@@ -0,0 +1,8 @@
+---
+'@kyverno/backstage-plugin-policy-reporter-common': minor
+'@kyverno/backstage-plugin-policy-reporter': minor
+---
+
+Add support for the `backstage.io/kubernetes-namespace` annotation as an alternative for the `kyverno.io/namespace`. This is useful for anyone already using the Kubernetes plugin. The kyverno namespaced annotation will always be the first priority.
+
+Add `isPolicyReporterAvailable` helper function to validate if PolicyReporter is configured for an entity.

plugins/policy-reporter-common/src/annotations.ts

@@ -7,6 +7,10 @@ export const KYVERNO_KIND_ANNOTATION = 'kyverno.io/kind';
 // The namespace of the resource to display policies
 export const KYVERNO_NAMESPACE_ANNOTATION = 'kyverno.io/namespace';
 
+// The namespace of the resource to display policies
+export const KUBERNETES_NAMESPACE_ANNOTATION =
+  'backstage.io/kubernetes-namespace';
+
 // The endpoint for the Policy Reporter API
 // EXAMPLE: https://kyverno.io/policy-reporter/api/
 export const KYVERNO_ENDPOINT_ANNOTATION = 'kyverno.io/endpoint';

plugins/policy-reporter/src/components/EntityCustomPoliciesContent/EntityCustomPoliciesContent.tsx

@@ -12,16 +12,14 @@ import { Grid } from '@material-ui/core';
 import { PolicyReportsTable } from '../PolicyReportsTable';
 import { SelectEnvironment } from '../SelectEnvironment';
 import {
-  containsRequiredAnnotations,
-  annotationsRequired,
+  getKinds,
+  getNamespaces,
+  getResourceName,
+  isPolicyReporterAvailable,
 } from '../../utils/annotations';
 import { MissingEnvironmentsEmptyState } from '../MissingEnvironmentsEmptyState';
 import { useEntityEnvironment } from '../../hooks/useEntityEnvironment';
-import {
-  KYVERNO_KIND_ANNOTATION,
-  KYVERNO_NAMESPACE_ANNOTATION,
-  KYVERNO_RESOURCE_NAME_ANNOTATION,
-} from '@kyverno/backstage-plugin-policy-reporter-common';
+import { KYVERNO_RESOURCE_NAME_ANNOTATION } from '@kyverno/backstage-plugin-policy-reporter-common';
 
 type EntityCustomPoliciesContentProps = {
   annotationsDocumentationUrl?: string;
@@ -49,8 +47,7 @@ export const EntityCustomPoliciesContent = ({
   const { entity } = useEntity();
   const annotations = entity.metadata.annotations;
 
-  // Boolean variable to validate that entity have required annotations
-  const annotationsState: boolean = containsRequiredAnnotations(annotations);
+  const annotationsState = isPolicyReporterAvailable(entity);
 
   const {
     environments,
@@ -65,7 +62,7 @@ export const EntityCustomPoliciesContent = ({
       <PageContent>
         <MissingAnnotationEmptyState
           readMoreUrl={annotationsDocumentationUrl}
-          annotation={annotationsRequired}
+          annotation={KYVERNO_RESOURCE_NAME_ANNOTATION}
         />
       </PageContent>
     );
@@ -81,9 +78,9 @@ export const EntityCustomPoliciesContent = ({
       </PageContent>
     );
 
-  const namespaces = annotations![KYVERNO_NAMESPACE_ANNOTATION].split(',');
-  const kinds = annotations![KYVERNO_KIND_ANNOTATION].split(',');
-  const resourceName = annotations![KYVERNO_RESOURCE_NAME_ANNOTATION];
+  const namespaces = getNamespaces(annotations);
+  const kinds = getKinds(annotations);
+  const resourceName = getResourceName(annotations);
 
   return (
     <PageContent>

plugins/policy-reporter/src/components/EntityKyvernoPoliciesContent/EntityKyvernoPoliciesContent.tsx

@@ -12,16 +12,14 @@ import { Grid } from '@material-ui/core';
 import { PolicyReportsTable } from '../PolicyReportsTable';
 import { SelectEnvironment } from '../SelectEnvironment';
 import {
-  containsRequiredAnnotations,
-  annotationsRequired,
+  getKinds,
+  getNamespaces,
+  getResourceName,
+  isPolicyReporterAvailable,
 } from '../../utils/annotations';
 import { MissingEnvironmentsEmptyState } from '../MissingEnvironmentsEmptyState';
 import { useEntityEnvironment } from '../../hooks/useEntityEnvironment';
-import {
-  KYVERNO_KIND_ANNOTATION,
-  KYVERNO_NAMESPACE_ANNOTATION,
-  KYVERNO_RESOURCE_NAME_ANNOTATION,
-} from '@kyverno/backstage-plugin-policy-reporter-common';
+import { KYVERNO_RESOURCE_NAME_ANNOTATION } from '@kyverno/backstage-plugin-policy-reporter-common';
 
 type KyvernoPoliciesContentProps = {
   annotationsDocumentationUrl?: string;
@@ -46,7 +44,7 @@ export const EntityKyvernoPoliciesContent = ({
   const annotations = entity.metadata.annotations;
 
   // Boolean variable to validate that entity have required annotations
-  const annotationsState: boolean = containsRequiredAnnotations(annotations);
+  const annotationsState = isPolicyReporterAvailable(entity);
 
   const {
     environments,
@@ -61,7 +59,7 @@ export const EntityKyvernoPoliciesContent = ({
       <PageContent>
         <MissingAnnotationEmptyState
           readMoreUrl={annotationsDocumentationUrl}
-          annotation={annotationsRequired}
+          annotation={KYVERNO_RESOURCE_NAME_ANNOTATION}
         />
       </PageContent>
     );
@@ -77,9 +75,9 @@ export const EntityKyvernoPoliciesContent = ({
       </PageContent>
     );
 
-  const namespaces = annotations![KYVERNO_NAMESPACE_ANNOTATION].split(',');
-  const kinds = annotations![KYVERNO_KIND_ANNOTATION].split(',');
-  const resourceName = annotations![KYVERNO_RESOURCE_NAME_ANNOTATION];
+  const namespaces = getNamespaces(annotations);
+  const kinds = getKinds(annotations);
+  const resourceName = getResourceName(annotations);
 
   return (
     <PageContent>