Skip to content

kubernetes-sigs/apisnoop

Folders and files

NameName
Last commit message
Last commit date
Sep 12, 2023
Mar 14, 2022
Oct 3, 2023
Oct 3, 2023
Dec 11, 2022
Nov 29, 2022
Jan 9, 2023
Aug 14, 2023
Sep 30, 2023
Oct 18, 2019
Mar 25, 2021
Nov 24, 2022
Nov 25, 2022
Aug 29, 2021
Apr 22, 2021
Nov 20, 2022
Mar 3, 2021
Sep 1, 2021

Repository files navigation

APISnoop Readme

A suite of tools to assist kubernetes test-writing and investigate test coverage.

Introduction

APISnoop is a collection of programs intended to run in a kubernetes cluster, that help with multiple aspects of conformance testing. These programs include:

snoopdb
a postgres database for running queries about the state of conformance coverage. This db starts up with audit events from a recent test run and the latest kubernetes api spec. This allows you to run queries to see exactly which endpoints in the spec are covered by exactly which tests. It can also be connected to auditlogger to create a more data-driven live-testing-environment.
auditlogger
a simple server that, when attached to a kubernetes cluster configured with an auditsink, will listen to all events in that cluster and insert them into the snoopdb’s testing tables. This allows you to perform mock tests against a cluster and then query the results immediately to ensure that your mock test is hitting the endpoints you intended.

We use snoopdb to generate the data for the site https://apisnoop.cncf.io.

Learning more

To learn more about the database, you can check out its README: ./apps/snoopdb/README.md Or, for auditlogger:./apps/auditlogger/README.org