engine

Documentation

Overview

Package engine contains the interfaces necessary to implement policy execution.

Index

• func ContainerPolicy(ctx context.Context) []string
• func OperatorPolicy(ctx context.Context) []string
• func RootExceptionContainerPolicy(ctx context.Context) []string
• func ScratchContainerPolicy(ctx context.Context) []string
• type CheckEngine
  • func NewForConfig(ctx context.Context, cfg certification.Config) (CheckEngine, error)

Functions

func ContainerPolicy

func ContainerPolicy(ctx context.Context) []string

ContainerPolicy returns the names of checks in the container policy.

func OperatorPolicy

func OperatorPolicy(ctx context.Context) []string

OperatorPolicy returns the names of checks in the operator policy.

func RootExceptionContainerPolicy

func RootExceptionContainerPolicy(ctx context.Context) []string

RootExceptionContainerPolicy returns the names of checks in the container policy with root exception.

func ScratchContainerPolicy

func ScratchContainerPolicy(ctx context.Context) []string

ScratchContainerPolicy returns the names of checks in the container policy with scratch exception.

Types

type CheckEngine

type CheckEngine interface {
	// ExecuteChecks should execute all checks in a policy and internally
	// store the results. Errors returned by ExecuteChecks should reflect
	// errors in pre-validation tasks, and not errors in individual check
	// execution itself.
	ExecuteChecks(context.Context) error
	// Results returns the outcome of executing all checks.
	Results(context.Context) runtime.Results
}

CheckEngine defines the functionality necessary to run all checks for a policy, and return the results of that check execution.

func NewForConfig

func NewForConfig(ctx context.Context, cfg certification.Config) (CheckEngine, error)