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{
		flagRolesNotFoundParamDesc,
		resourcesParamDesc,
		verbsParamDesc,
	}
)

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 {
	// Set to true to flag the roles that are referenced in bindings but not found in the context
	FlagRolesNotFound bool `json:"flagRolesNotFound"`
	// An array of regular expressions specifying resources. e.g. ^secrets$ for secrets and ^*$ for any resources
	// +notnegatable
	Resources []string `json:"resources"`
	// An array of regular expressions specifying verbs. e.g. ^create$ for create and ^*$ for any k8s verbs
	// +notnegatable
	Verbs []string `json:"verbs"`
}

Params represents the params accepted by this template.

func (*Params) Validate

func (p *Params) Validate() error