kubebench

Documentation

Overview

This package provides primitives for working with CIS Kubernetes benchmarks.

Index

• type Config
• type Converter
• type ReadWriter
  • func NewReadWriter(scheme *runtime.Scheme, clientset versioned.Interface) ReadWriter
• type Reader
• type Scanner
  • func NewScanner(scheme *runtime.Scheme, clientset kubernetes.Interface, config Config, ...) *Scanner
  • func (s *Scanner) Scan(ctx context.Context, node corev1.Node) (v1alpha1.CISKubeBenchOutput, error)
• type Writer

Types

type Config

type Config interface {
	GetKubeBenchImageRef() (string, error)
}

type Converter

type Converter interface {
	Convert(config Config, reader io.Reader) (v1alpha1.CISKubeBenchOutput, error)
}

var DefaultConverter Converter = &converter{}

type ReadWriter

type ReadWriter interface {
	Writer
	Reader
}

func NewReadWriter

func NewReadWriter(scheme *runtime.Scheme, clientset versioned.Interface) ReadWriter

type Reader

type Reader interface {
	Read(ctx context.Context, node kube.Object) (v1alpha1.CISKubeBenchOutput, error)
}

type Scanner

type Scanner struct {
	// contains filtered or unexported fields
}

func NewScanner

func NewScanner(
	scheme *runtime.Scheme,
	clientset kubernetes.Interface,
	config Config,
	opts kube.ScannerOpts,
) *Scanner

func (*Scanner) Scan

func (s *Scanner) Scan(ctx context.Context, node corev1.Node) (v1alpha1.CISKubeBenchOutput, error)

type Writer

type Writer interface {
	Write(ctx context.Context, report v1alpha1.CISKubeBenchOutput, node *corev1.Node) error
}