rego

Documentation

Index

• type KindMatcher
• type KindMatchers
  • func (k KindMatchers) String() string
• type MatchLabelsMatcher
  • func (m MatchLabelsMatcher) String() string
• type Matchers
• type Parameter
• type Rego
  • func GetAllSeverities(directory string) ([]Rego, error)
  • func GetAllSeveritiesWithoutImports(directory string) ([]Rego, error)
  • func GetViolations(directory string) ([]Rego, error)
  • func (r Rego) Dependencies() []string
  • func (r Rego) Description() string
  • func (r Rego) Enforcement() string
  • func (r Rego) FullSource() string
  • func (r Rego) Kind() string
  • func (r Rego) Matchers() (Matchers, error)
  • func (r Rego) Name() string
  • func (r Rego) Parameters() []Parameter
  • func (r Rego) Path() string
  • func (r Rego) PolicyID() string
  • func (r Rego) Severity() Severity
  • func (r Rego) SkipConstraint() bool
  • func (r Rego) Source() string
  • func (r Rego) Title() string
• type Severity

Types

type KindMatcher

type KindMatcher struct {
	APIGroup string
	Kind     string
}

KindMatcher are the matchers that are applied to constraints.

type KindMatchers

type KindMatchers []KindMatcher

KindMatchers is the slice of KindMatcher

func (KindMatchers) String

func (k KindMatchers) String() string

type MatchLabelsMatcher

type MatchLabelsMatcher map[string]string

MatchLabelsMatcher is the matcher to generate `constraints.spec.match.labelSelector.matchLabels`.

func (MatchLabelsMatcher) String

func (m MatchLabelsMatcher) String() string

type Matchers

type Matchers struct {
	KindMatchers       KindMatchers
	MatchLabelsMatcher MatchLabelsMatcher
}

Matchers are all of the matchers that can be applied to constraints.

type Parameter

type Parameter struct {
	Name    string
	Type    string
	IsArray bool
}

Parameter represents a parameter that the policy uses

type Rego

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

Rego represents a parsed rego file.

func GetAllSeverities

func GetAllSeverities(directory string) ([]Rego, error)

GetAllSeverities gets all of the rego files found in the given directory as well as any subdirectories. Only rego files that contain a valid severity will be returned.

func GetAllSeveritiesWithoutImports

func GetAllSeveritiesWithoutImports(directory string) ([]Rego, error)

GetAllSeveritiesWithoutImports gets all of the Rego files found in the given directory as well as any subdirectories, but does not attempt to parse the imports.

func GetViolations

func GetViolations(directory string) ([]Rego, error)

GetViolations gets all of the files found in the given directory as well as any subdirectories. Only rego files that have a severity of violation will be returned.

func (Rego) Dependencies

func (r Rego) Dependencies() []string

Dependencies returns all of the source for the rego files that this rego file depends on.

func (Rego) Description

func (r Rego) Description() string

Description returns the entire description found in the header comment of the rego file.

func (Rego) Enforcement

func (r Rego) Enforcement() string

Enforcement returns the enforcement action in the header comment Defaults to deny if no enforcement action is specified

func (Rego) FullSource

func (r Rego) FullSource() string

FullSource returns the original source code inside of the rego file including comments except the header

func (Rego) Kind

func (r Rego) Kind() string

Kind returns the Kubernetes Kind of the rego file. The kind of the rego file is determined by the name of the directory that the rego file exists in.

func (Rego) Matchers

func (r Rego) Matchers() (Matchers, error)

Matchers returns all of the matchers found in the rego file.

func (Rego) Name

func (r Rego) Name() string

Name returns the name of the rego file. The name of the rego file is its kind as lowercase.

func (Rego) Parameters

func (r Rego) Parameters() []Parameter

Parameters returns the list of parsed parameters

func (Rego) Path

func (r Rego) Path() string

Path returns the original path of the rego file.

func (Rego) PolicyID

func (r Rego) PolicyID() string

PolicyID returns the identifier of the policy The returned value will be a blank string if an id was not specified in the policy body

func (Rego) Severity

func (r Rego) Severity() Severity

Severity returns the severity of the rego file. When a rego file has multiple rules that are considered to be different severities, the first rule is chosen.

func (Rego) SkipConstraint

func (r Rego) SkipConstraint() bool

SkipConstraint returns whether or not the generation of the Constraint should be skipped It is only set to true when the @skip-constraint tag is present in the comment header block

func (Rego) Source

func (r Rego) Source() string

Source returns the original source code inside of the rego file without any comments.

func (Rego) Title

func (r Rego) Title() string

Title returns the title found in the header comment of the rego file.

type Severity

type Severity string

Severity describes the severity level of the rego file.

const (
	Violation Severity = "Violation"
	Warning   Severity = "Warning"

	// PolicyIDVariable is the name of the variable that contains the policy identifier
	PolicyIDVariable = "policyID"
)

The defined severity levels represent the valid severity levels that a rego file can have.