netchecks icon indicating copy to clipboard operation
netchecks copied to clipboard

Feature Request: Netchecks API

Open hardbyte opened this issue 2 years ago • 0 comments

Add an API to list/create/delete network assertions and their related policy reports.

An API running in a container that allows users to administrate NetworkAssertions, ideally to debug/run test assertions, see their results, and perhaps eventually configure the actions to take on failure (alerts). Should be optionally deployed with the operator.

POC: a thin wrapper around the k8s api for NetworkAssertions and PolicyReports.

Why? Why Not

Mostly to be the backend for a possible UI for Netchecks. Alternative is to directly use the k8s api which is fantastic for developers but not so good for everyone.

Requirements

  • Connect to local K8s cluster to manage namespaced network assertions and expose results.

Out of scope

  • Auth - Supporting Users, Groups, Orgs.
  • Ability to configure alerts (slack + sending emails)
  • Web UI for managing assertions, alerts, users, org settings etc.

Design

Dockerized application exposing a simple REST API. This application will directly talk to the K8s api, and likely runs inside the cluster too. Ideally avoid duplicating the k8s data (networkassertions, policyreports etc).

hardbyte avatar Sep 14 '23 01:09 hardbyte