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{
		strategyTypeRegexParamDesc,
		maxPodsUnavailableParamDesc,
		minPodsUnavailableParamDesc,
		maxSurgeParamDesc,
		minSurgeParamDesc,
	}
)

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 {
	// A regular expression the defines the type of update
	// strategy allowed.
	// +required
	StrategyTypeRegex string

	// The maximum value that be set in a RollingUpdate
	// configuration for the MaxUnavailable.  This can be
	// an integer or a percent.
	MaxPodsUnavailable string

	// The minimum value that be set in a RollingUpdate
	// configuration for the MaxUnavailable.  This can be
	// an integer or a percent.
	MinPodsUnavailable string

	// The maximum value that be set in a RollingUpdate
	// configuration for the MaxSurge.  This can be
	// an integer or a percent.
	MaxSurge string

	// The minimum value that be set in a RollingUpdate
	// configuration for the MaxSurge.  This can be
	// an integer or a percent.
	MinSurge string
}

Params represents the params accepted by this template.

func (*Params) Validate

func (p *Params) Validate() error