api

Documentation

Index

• func Gzip(next http.HandlerFunc) http.HandlerFunc
• func HTTPBasic(auth *BasicAuth, next http.HandlerFunc) http.HandlerFunc
• func HealthzHandler(synced func() bool) http.HandlerFunc
• func NamespaceReportingHandler(s reporting.PolicyReportGenerator, basePath string) http.HandlerFunc
• func NewLoggerMiddleware(logger *zap.Logger, mux http.Handler) http.Handler
• func PolicyHandler(s *kyverno.PolicyStore) http.HandlerFunc
• func PolicyReportingHandler(s reporting.PolicyReportGenerator, basePath string) http.HandlerFunc
• func ReadyHandler() http.HandlerFunc
• func VerifyImageRulesHandler(s *kyverno.PolicyStore) http.HandlerFunc
• type BasicAuth
• type Policy
• type Server
  • func NewServer(pStore *kyverno.PolicyStore, reports reporting.PolicyReportGenerator, port int, ...) Server
• type VerifyImage

Functions

func Gzip

func Gzip(next http.HandlerFunc) http.HandlerFunc

Gzip Middleware for Responses

func HTTPBasic

func HTTPBasic(auth *BasicAuth, next http.HandlerFunc) http.HandlerFunc

func HealthzHandler

func HealthzHandler(synced func() bool) http.HandlerFunc

HealthzHandler for the Liveness REST API

func NamespaceReportingHandler

func NamespaceReportingHandler(s reporting.PolicyReportGenerator, basePath string) http.HandlerFunc

NamespaceReportingHandler for the NamespaceReport REST API

func NewLoggerMiddleware

func NewLoggerMiddleware(logger *zap.Logger, mux http.Handler) http.Handler

func PolicyHandler

func PolicyHandler(s *kyverno.PolicyStore) http.HandlerFunc

PolicyHandler for the Policy REST API

func PolicyReportingHandler

func PolicyReportingHandler(s reporting.PolicyReportGenerator, basePath string) http.HandlerFunc

PolicyHandler for the PolicyReport REST API

func ReadyHandler

func ReadyHandler() http.HandlerFunc

ReadyHandler for the Readiness REST API

func VerifyImageRulesHandler

func VerifyImageRulesHandler(s *kyverno.PolicyStore) http.HandlerFunc

VerifyImageRulesHandler for the ImageVerify Policy REST API

Types

type BasicAuth

type BasicAuth struct {
	Username string
	Password string
}

type Policy

type Policy struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace,omitempty"`
	UID       string `json:"uid,omitempty"`
}

type Server

type Server interface {
	// Start the HTTP REST API
	Start() error
	// Shutdown the HTTP Sever
	Shutdown(ctx context.Context) error
	// RegisterREST add all REST API handler
	RegisterREST()
	// RegisterMetrics adds Metrics handler
	RegisterMetrics()
}

Server for the optional HTTP REST API

func NewServer

func NewServer(pStore *kyverno.PolicyStore, reports reporting.PolicyReportGenerator, port int, synced func() bool, auth *BasicAuth, logger *zap.Logger) Server

NewServer constructor for a new API Server

type VerifyImage

type VerifyImage struct {
	Policy       *Policy `json:"policy"`
	Rule         string  `json:"rule"`
	Repository   string  `json:"repository"`
	Image        string  `json:"image"`
	Key          string  `json:"key"`
	Attestations string  `json:"attestations,omitempty"`
}