api

package

v1.6.3 Latest Latest Go to latest Published: Jan 19, 2024 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kyverno/policy-reporter-kyverno-plugin

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Gzip ¶

func Gzip(next http.HandlerFunc) http.HandlerFunc

Gzip Middleware for Responses

func HTTPBasic ¶ added in v1.6.0

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 ¶ added in v1.5.0

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

NamespaceReportingHandler for the NamespaceReport REST API

func NewLoggerMiddleware ¶ added in v1.5.1

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 ¶ added in v1.5.0

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 ¶ added in v1.1.0

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

VerifyImageRulesHandler for the ImageVerify Policy REST API

Types ¶

type BasicAuth ¶ added in v1.6.0

type BasicAuth struct {
	Username string
	Password string
}

type Policy ¶ added in v1.1.0

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 ¶ added in v1.1.0

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"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL