params

Documentation

Index

• Variables
• func ParseAndValidate(m map[string]interface{}) (interface{}, error)
• func WrapInstantiateFunc(f func(p Params) (check.Func, error)) func(interface{}) (check.Func, error)
• type Params
  • func (p *Params) Validate() error

Variables

var (
	ParamDescs = []check.ParameterDesc{
		forbiddenCapabilitiesParamDesc,
		exceptionsParamDesc,
	}
)

Functions

func ParseAndValidate

func ParseAndValidate(m map[string]interface{}) (interface{}, error)

ParseAndValidate instantiates a Params object out of the passed map[string]interface{}, validates it, and returns it. The return type is interface{} to satisfy the type in the Template struct.

func WrapInstantiateFunc

func WrapInstantiateFunc(f func(p Params) (check.Func, error)) func(interface{}) (check.Func, error)

WrapInstantiateFunc is a convenience wrapper that wraps an untyped instantiate function into a typed one.

Types

type Params

type Params struct {

	// List of capabilities that needs to be removed from containers.
	// +noregex
	// +notnegatable
	ForbiddenCapabilities []string `json:"forbiddenCapabilities"`

	// List of capabilities that are exceptions to the above list. This should only be filled
	// when the above contains "all", and is used to forgive capabilities in ADD list.
	// +noregex
	// +notnegatable
	Exceptions []string `json:"exceptions"`
}

Params represents the params accepted by this template.

func (*Params) Validate

func (p *Params) Validate() error