policy

Documentation

Index

• type Client
  • func NewClient(opts ...Option) (Client, error)
  • func (c Client) DownloadBuiltinPolicies(ctx context.Context) error
  • func (c Client) LoadBuiltinPolicies() ([]string, error)
  • func (c Client) NeedsUpdate() (bool, error)
• type Metadata
• type Option
  • func WithClock(clock clock.Clock) Option
  • func WithImage(img v1.Image) Option

Types

type Client

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

Client implements policy operations

func NewClient

func NewClient(opts ...Option) (Client, error)

NewClient is the factory method for policy client

func (Client) DownloadBuiltinPolicies

func (c Client) DownloadBuiltinPolicies(ctx context.Context) error

DownloadBuiltinPolicies download default policies from GitHub Pages

func (Client) LoadBuiltinPolicies

func (c Client) LoadBuiltinPolicies() ([]string, error)

LoadBuiltinPolicies loads default policies

func (Client) NeedsUpdate

func (c Client) NeedsUpdate() (bool, error)

NeedsUpdate returns if the default policy should be updated

type Metadata

type Metadata struct {
	Digest           string
	LastDownloadedAt time.Time
}

Metadata holds default policy metadata

type Option

type Option func(*options)

Option is a functional option

func WithClock

func WithClock(clock clock.Clock) Option

WithClock takes a clock

func WithImage

func WithImage(img v1.Image) Option

WithImage takes an OCI v1 Image