ruleset

Documentation

Index

• type CompareOptions
• type CreateDeleteResourceChange
  • func (r CreateDeleteResourceChange) ID() *ResourceIdentifier
• type CreateDeleteResourceChanges
• type EnforceChange
• type Resource
• type ResourceIdentifier
  • func (id *ResourceIdentifier) String() string
• type ResourceRules
• type Ruleset
  • func ParseRuleset(path string) (Ruleset, error)
• type UpdateResourceChange
  • func (r UpdateResourceChange) ID() *ResourceIdentifier
• type UpdateResourceChanges

Types

type CompareOptions

type CompareOptions struct {
	// If enforceAll is enabled, all Enforced must be present
	EnforceAll *bool `yaml:"enforceAll,omitempty"`

	// If ignoreExtraArgs is enabled, extra args not in Enforced or Ignored are ignored
	IgnoreExtraArgs *bool `yaml:"ignoreExtraArgs,omitempty"`

	// If ignoreComputed is enabled, args that result in a computed value are ignored
	// Has no effect on destroyed values
	IgnoreComputed *bool `yaml:"ignoreComputed,omitempty"`

	// If requireAll is enabled, every key in enforced or Ignored must be present
	RequireAll *bool `yaml:"requireAll,omitempty"`

	// If autoFail is enabled, automatically fails before comparison if a matching resource is found
	AutoFail *bool `yaml:"autoFail,omitempty"`

	// If IgnoreNoOp is enabled, skips attributes that have not changed
	// No effect for created or destroyed resource changes
	IgnoreNoOp *bool `yaml:"ignoreNoOp,omitempty"`
}

type CreateDeleteResourceChange

type CreateDeleteResourceChange struct {
	CompareOptions     `yaml:",inline"`
	ResourceIdentifier `yaml:",inline"`
	ResourceRules      `yaml:",inline"`
}

func (CreateDeleteResourceChange) ID

func (r CreateDeleteResourceChange) ID() *ResourceIdentifier

type CreateDeleteResourceChanges

type CreateDeleteResourceChanges struct {
	// If strict is enabled, all created or deleted resources must match a rule
	Strict bool `yaml:"strict,omitempty"`

	// If requireName is enabled, all resources must specify the name of the
	// resource in addition to the resource type
	RequireName bool `yaml:"requireName",omitempty`

	// Default CompareOptions to use for all resources
	Default *CompareOptions `yaml:"default,omitempty"`

	// Resources is a list of resource changes to validate against
	Resources []CreateDeleteResourceChange `yaml:"resources"`
}

type EnforceChange

type EnforceChange struct {
	Value         interface{}              `yaml:"value,omitempty"`
	MatchAny      []interface{}            `yaml:"matchAny,omitempty"`
	EnforceChange map[string]EnforceChange `yaml:",inline"`
}

type Resource

type Resource interface {
	ID() *ResourceIdentifier
}

type ResourceIdentifier

type ResourceIdentifier struct {
	Name string `yaml:"name,omitempty"`
	Type string `yaml:"type,omitempty"`
}

func (*ResourceIdentifier) String

func (id *ResourceIdentifier) String() string

type ResourceRules

type ResourceRules struct {
	Enforced map[string]EnforceChange `yaml:"enforced,omitempty"`
	Ignored  []string                 `yaml:"ignored,omitempty"`
}

type Ruleset

type Ruleset struct {
	CreatedResources   *CreateDeleteResourceChanges `yaml:"createdResources,omitempty"`
	DestroyedResources *CreateDeleteResourceChanges `yaml:"destroyedResources,omitempty"`
	UpdatedResources   *UpdateResourceChanges       `yaml:"updatedResources,omitempty"`
}

func ParseRuleset

func ParseRuleset(path string) (Ruleset, error)

type UpdateResourceChange

type UpdateResourceChange struct {
	CompareOptions     `yaml:",inline"`
	ResourceIdentifier `yaml:",inline"`

	Before *ResourceRules `yaml:"before,omitempty"`
	After  *ResourceRules `yaml:"after,omitempty"`
}

func (UpdateResourceChange) ID

func (r UpdateResourceChange) ID() *ResourceIdentifier

type UpdateResourceChanges

type UpdateResourceChanges struct {
	// If strict is enabled, all updated resources must match a rule
	Strict bool `yaml:"strict,omitempty"`

	// If requireName is enabled, all resources must specify the name of the
	// resource in addition to the resource type
	RequireName bool `yaml:"requireName",omitempty`

	// Default CompareOptions to use for all resources
	Default *CompareOptions `yaml:"default,omitempty"`

	// Resources is a list of resource changes to validate against
	Resources []UpdateResourceChange `yaml:"resources"`
}