policy

Documentation

Index

• type Option
• type Options
• type Policy
• type Report
  • func (r Report) Valid() bool

Types

type Option

type Option func(*Options)

Option is a functional option used to pass in arguments to a Policy.

type Options

type Options struct {
	Pipeline *pipeline.Pipeline
	Tasks    map[string]*task.Task
}

Options defines the set of options available to a Policy.

type Policy

type Policy interface {
	Compliance(*metadata.Metadata, ...Option) Report
	Pipeline(*pipeline.Pipeline) Option
	Tasks(map[string]*task.Task) Option
}

Policy is an interface that policies must implement.

type Report

type Report struct {
	Errors []error
}

Report summarizes the compliance of a policy.

func (Report) Valid

func (r Report) Valid() bool

Valid checks if a report is valid.