controller

Documentation

Index

• type HttpChecker
  • func NewHttpChecker() HttpChecker
• type SbomReports
• type ScanJobController
  • func (r *ScanJobController) SetupWithManager(mgr ctrl.Manager) error
• type ScanJobRequest
• type ScanJobResult
• type ServerHealthChecker
  • func NewTrivyServerChecker(expiration *time.Duration, cache gcache.Cache, httpChecker HttpChecker) ServerHealthChecker
• type VulnerabilityReports
• type WorkloadController
  • func (r *WorkloadController) ProcessScanJob()
  • func (r *WorkloadController) SetupWithManager(mgr ctrl.Manager) error
  • func (r *WorkloadController) SubmitScanJob(ctx context.Context, owner client.Object, ...) error

Types

type HttpChecker

type HttpChecker interface {
	ServerHealthy(serverURL string) error
}

HttpChecker check health with http server

func NewHttpChecker

func NewHttpChecker() HttpChecker

type SbomReports

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

type ScanJobController

type ScanJobController struct {
	logr.Logger
	etc.Config
	kube.ObjectResolver
	kube.LogsReader
	vulnerabilityreport.Plugin
	trivyoperator.PluginContext
	trivyoperator.ConfigData
	SbomReadWriter          sbomreport.ReadWriter
	VulnerabilityReadWriter vulnerabilityreport.ReadWriter
	ExposedSecretReadWriter exposedsecretreport.ReadWriter
}

ScanJobController watches Kubernetes workloads and generates v1alpha1.VulnerabilityReport instances using vulnerability scanner that that implements the Plugin interface.

func (*ScanJobController) SetupWithManager

func (r *ScanJobController) SetupWithManager(mgr ctrl.Manager) error

type ScanJobRequest

type ScanJobRequest struct {
	Workload          client.Object
	Context           context.Context
	ClusterSbomReport map[string]v1alpha1.SbomReportData
}

ScanJobRequest encapsulate workload and context for processing

type ScanJobResult

type ScanJobResult struct {
	Result ctrl.Result
	Error  error
}

ScanJobResult encapsulate processing result and error

type ServerHealthChecker

type ServerHealthChecker interface {
	TrivyServerAvaliable(serverURL string) (bool, error)
}

func NewTrivyServerChecker

func NewTrivyServerChecker(expiration *time.Duration, cache gcache.Cache, httpChecker HttpChecker) ServerHealthChecker

type VulnerabilityReports

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

type WorkloadController

type WorkloadController struct {
	logr.Logger
	etc.Config
	kube.ObjectResolver
	client.Client
	jobs.LimitChecker
	vulnerabilityreport.Plugin
	trivyoperator.PluginContext
	kube.SecretsReader
	trivyoperator.ConfigData
	ServerHealthChecker     ServerHealthChecker
	VulnerabilityReadWriter vulnerabilityreport.ReadWriter
	ExposedSecretReadWriter exposedsecretreport.ReadWriter
	SbomReadWriter          sbomreport.ReadWriter
	SubmitScanJobChan       chan ScanJobRequest
	ResultScanJobChan       chan ScanJobResult
	CacheSyncTimeout        time.Duration
}

WorkloadController watches Kubernetes workloads and generates v1alpha1.VulnerabilityReport instances using vulnerability scanner that that implements the Plugin interface.

func (*WorkloadController) ProcessScanJob

func (r *WorkloadController) ProcessScanJob()

func (*WorkloadController) SetupWithManager

func (r *WorkloadController) SetupWithManager(mgr ctrl.Manager) error

func (*WorkloadController) SubmitScanJob

func (r *WorkloadController) SubmitScanJob(ctx context.Context, owner client.Object, reusedReports map[string]v1alpha1.SbomReportData) error