@kyverno/backstage-plugin-policy-reporter-backend 2.4.0 → 2.6.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @kyverno/backstage-plugin-policy-reporter-backend
 
+## 2.6.0
+
+### Minor Changes
+
+- fa25ccc: Added additional responses to all routes, they can now also return 404, 502 and 503
+- 256fb9a: Added source filtering to the PolicyReportsPage. Users can now filter the list of policy reports by selecting one or more sources from the selected cluster.
+- 2f4ac45: Added policy filtering to the PolicyReportsPage. Users can now filter the list of policy reports by selecting one or more policies from the selected cluster.
+- d598ade: Added category filtering to the PolicyReportsPage. Users can now filter the list of policy reports by selecting one or more categories from the selected cluster.
+- a664d0c: Added kind filtering to the PolicyReportsPage. Users can now filter the list of policy reports by selecting one or more kinds from the selected cluster.
+- 880eecc: Backstage version bump to v1.51.1
+- fa25ccc: Add support for configuring requestHeaders for the Policy Reporter Backend in your config using policyReporter.requestHeaders. This can be used for configuring Basic Auth credentials to the backend.
+
+  ```yaml
+  policyReporter:
+    requestHeaders:
+      Authorization: Bearer ${POLICY_REPORTER_API_TOKEN}
+  ```
+
+- 44c5238: Backstage version bump to v1.52.0
+
+### Patch Changes
+
+- Updated dependencies [256fb9a]
+- Updated dependencies [2f4ac45]
+- Updated dependencies [d598ade]
+- Updated dependencies [a664d0c]
+- Updated dependencies [880eecc]
+- Updated dependencies [44c5238]
+  - @kyverno/backstage-plugin-policy-reporter-common@2.5.0
+
+## 2.5.0
+
+### Minor Changes
+
+- e0e8462: Backstage verion bump to v1.50.4
+
+### Patch Changes
+
+- Updated dependencies [e0e8462]
+  - @kyverno/backstage-plugin-policy-reporter-common@2.4.0
+
 ## 2.4.0
 
 ### Minor Changes

package/config.d.ts

@@ -0,0 +1,10 @@
+export interface Config {
+  policyReporter?: {
+    /**
+     * Optional HTTP headers forwarded with every outbound request to every Policy Reporter API
+     * Typically used to authenticate through a gateway/proxy.
+     * @visibility backend
+     */
+    requestHeaders?: { [key: string]: string };
+  };
+}

package/dist/index.d.ts

@@ -1,13 +1,180 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { LoggerService, RootConfigService, AuthService } from '@backstage/backend-plugin-api';
+import { LoggerService, RootConfigService } from '@backstage/backend-plugin-api';
 import express from 'express';
-import { CatalogService } from '@backstage/plugin-catalog-node';
+
+/**
+ * @public
+ */
+type Direction = 'asc' | 'desc';
+
+/**
+ * @public
+ */
+type Severity = 'unknown' | 'info' | 'low' | 'medium' | 'high' | 'critical';
+
+/**
+ * @public
+ */
+type Status = 'fail' | 'skip' | 'pass' | 'warn' | 'error' | 'summary';
+
+/**
+ * Filter options for policy results
+ * @public
+ */
+interface Filter {
+    /**
+     * Filter by a list of sources
+     */
+    sources?: Array<string>;
+    /**
+     * Filter by a list of namespaces
+     */
+    namespaces?: Array<string>;
+    /**
+     * Filter by a list of kinds
+     */
+    kinds?: Array<string>;
+    /**
+     * Filter by a list of resources
+     */
+    resources?: Array<string>;
+    /**
+     * Filter by a list of categories
+     */
+    categories?: Array<string>;
+    /**
+     * Filter by a list of policies
+     */
+    policies?: Array<string>;
+    /**
+     * Filter by a list of status
+     */
+    status?: Array<Status>;
+    /**
+     * Filter by a list of severities
+     */
+    severities?: Array<Severity>;
+    /**
+     * Filter by search string
+     */
+    search?: string;
+    /**
+     * Filter by label-value pairs
+     */
+    labels?: Array<string>;
+}
+
+/**
+ * @public
+ */
+interface ListResult {
+    /**
+     * Unique identifier for the result
+     */
+    id: string;
+    /**
+     * Kubernetes namespace
+     */
+    namespace: string;
+    /**
+     * Kubernetes resource kind
+     */
+    kind: string;
+    /**
+     * Resource name
+     */
+    name: string;
+    /**
+     * Unique resource identifier
+     */
+    resourceId: string;
+    /**
+     * Policy result message
+     */
+    message: string;
+    /**
+     * Policy name
+     */
+    policy: string;
+    /**
+     * Policy rule name
+     */
+    rule: string;
+    status: Status;
+    severity: Severity;
+    /**
+     * Unix timestamp of the result
+     */
+    timestamp: number;
+    /**
+     * Additional key-value properties
+     */
+    properties: {
+        [key: string]: string;
+    };
+}
+
+/**
+ * Pagination options for results
+ * @public
+ */
+interface Pagination {
+    /**
+     * Requested list page number
+     */
+    page?: number;
+    /**
+     * Number of results per page
+     */
+    offset?: number;
+    /**
+     * Fields to sort by
+     */
+    sortBy?: Array<string>;
+    direction?: Direction;
+}
+
+/**
+ * @public
+ */
+interface ResultList {
+    items: Array<ListResult>;
+    /**
+     * Total number of results
+     */
+    count: number;
+}
+
+interface PolicyReporterApi {
+    getNamespacedResourceResults(options: {
+        entityRef: string;
+        query: Filter & Pagination;
+    }): Promise<ResultList>;
+    getNamespaces(options: {
+        entityRef: string;
+        query: Pick<Filter, 'sources' | 'categories' | 'policies'>;
+    }): Promise<string[]>;
+    getSources(options: {
+        entityRef: string;
+    }): Promise<string[]>;
+    getKinds(options: {
+        entityRef: string;
+        query: Pick<Filter, 'sources' | 'kinds'>;
+    }): Promise<string[]>;
+    getCategories(options: {
+        entityRef: string;
+        query: Pick<Filter, 'sources' | 'namespaces'>;
+    }): Promise<string[]>;
+    getPolicies(options: {
+        entityRef: string;
+        query: Pick<Filter, 'sources' | 'namespaces' | 'categories'>;
+    }): Promise<string[]>;
+}
 
 interface RouterOptions {
     logger: LoggerService;
     config: RootConfigService;
-    catalogService: CatalogService;
-    authService: AuthService;
+    policyReporterService: PolicyReporterApi;
 }
 declare function createRouter(options: RouterOptions): Promise<express.Router>;
 

package/dist/plugin.cjs.js

@@ -3,6 +3,7 @@
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var router = require('./service/router.cjs.js');
 var pluginCatalogNode = require('@backstage/plugin-catalog-node');
+var policyReporterService = require('./service/policyReporterService.cjs.js');
 
 const kyvernoPolicyReportsPlugin = backendPluginApi.createBackendPlugin({
   pluginId: "policy-reporter",
@@ -16,12 +17,17 @@ const kyvernoPolicyReportsPlugin = backendPluginApi.createBackendPlugin({
         authService: backendPluginApi.coreServices.auth
       },
       async init({ httpRouter, logger, config, catalogService, authService }) {
+        const policyReporterService$1 = new policyReporterService.PolicyReporterService({
+          logger,
+          configService: config,
+          catalogService,
+          authService
+        });
         httpRouter.use(
           await router.createRouter({
             logger,
             config,
-            catalogService,
-            authService
+            policyReporterService: policyReporterService$1
           })
         );
       }

package/dist/plugin.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["import {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\n\n/**\n * kyvernoPolicyReportsPlugin backend plugin\n *\n * @public\n */\nexport const kyvernoPolicyReportsPlugin = createBackendPlugin({\n  pluginId: 'policy-reporter',\n  register(env) {\n    env.registerInit({\n      deps: {\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        catalogService: catalogServiceRef,\n        authService: coreServices.auth,\n      },\n      async init({ httpRouter, logger, config, catalogService, authService }) {\n        httpRouter.use(\n          await createRouter({\n            logger,\n            config,\n            catalogService,\n            authService,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","catalogServiceRef","createRouter"],"mappings":";;;;;;AAYO,MAAM,6BAA6BA,oCAAoB,CAAA;AAAA,EAC5D,QAAU,EAAA,iBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,YAAYC,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,cAAgB,EAAAC,mCAAA;AAAA,QAChB,aAAaD,6BAAa,CAAA;AAAA,OAC5B;AAAA,MACA,MAAM,KAAK,EAAE,UAAA,EAAY,QAAQ,MAAQ,EAAA,cAAA,EAAgB,aAAe,EAAA;AACtE,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAME,mBAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,cAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
+{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["import {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\nimport { PolicyReporterService } from './service/policyReporterService';\n\n/**\n * kyvernoPolicyReportsPlugin backend plugin\n *\n * @public\n */\nexport const kyvernoPolicyReportsPlugin = createBackendPlugin({\n  pluginId: 'policy-reporter',\n  register(env) {\n    env.registerInit({\n      deps: {\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        catalogService: catalogServiceRef,\n        authService: coreServices.auth,\n      },\n      async init({ httpRouter, logger, config, catalogService, authService }) {\n        const policyReporterService = new PolicyReporterService({\n          logger,\n          configService: config,\n          catalogService,\n          authService,\n        });\n\n        httpRouter.use(\n          await createRouter({\n            logger,\n            config,\n            policyReporterService,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","catalogServiceRef","policyReporterService","PolicyReporterService","createRouter"],"mappings":";;;;;;;AAaO,MAAM,6BAA6BA,oCAAA,CAAoB;AAAA,EAC5D,QAAA,EAAU,iBAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,YAAYC,6BAAA,CAAa,UAAA;AAAA,QACzB,QAAQA,6BAAA,CAAa,MAAA;AAAA,QACrB,QAAQA,6BAAA,CAAa,UAAA;AAAA,QACrB,cAAA,EAAgBC,mCAAA;AAAA,QAChB,aAAaD,6BAAA,CAAa;AAAA,OAC5B;AAAA,MACA,MAAM,KAAK,EAAE,UAAA,EAAY,QAAQ,MAAA,EAAQ,cAAA,EAAgB,aAAY,EAAG;AACtE,QAAA,MAAME,uBAAA,GAAwB,IAAIC,2CAAA,CAAsB;AAAA,UACtD,MAAA;AAAA,UACA,aAAA,EAAe,MAAA;AAAA,UACf,cAAA;AAAA,UACA;AAAA,SACD,CAAA;AAED,QAAA,UAAA,CAAW,GAAA;AAAA,UACT,MAAMC,mBAAA,CAAa;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,mCACAF;AAAA,WACD;AAAA,SACH;AAAA,MACF;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}

package/dist/schema/openapi/generated/router.cjs.js

@@ -215,6 +215,280 @@ const spec = {
         }
       }
     },
+    "/v1/namespaced-resources/sources": {
+      get: {
+        summary: "Get sources",
+        description: "List of all Sources with namespace scoped results",
+        operationId: "getSources",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of sources",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - invalid entityRef or missing annotation",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/namespaced-resources/kinds": {
+      get: {
+        summary: "Get kinds",
+        description: "List of all Kubernetes resource kinds with namespace scoped results",
+        operationId: "getKinds",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "namespaces",
+            in: "query",
+            description: "Filter by a list of namespaces",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of kinds",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - invalid entityRef or missing annotation",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/namespaced-resources/categories": {
+      get: {
+        summary: "Get categories",
+        description: "List of all Categories with namespace scoped results",
+        operationId: "getCategories",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "namespaces",
+            in: "query",
+            description: "Filter by a list of namespaces",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of categories",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - invalid entityRef or missing annotation",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/namespaces": {
       get: {
         summary: "Get namespaces",
@@ -304,6 +578,139 @@ const spec = {
                 }
               }
             }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/namespaced-resources/policies": {
+      get: {
+        summary: "Get policies with namespaced policy results",
+        description: "List of all Policies with namespace scoped results",
+        operationId: "getPolicies",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "namespaces",
+            in: "query",
+            description: "Filter by a list of namespaces",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "categories",
+            in: "query",
+            description: "Filter by a list of categories",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of policies",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - invalid entityRef or missing annotation",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error - failed to fetch policies",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
           }
         }
       }