commands

Documentation

Index

• func GetKindFromPath(path string) string
• func NewDefaultCommand() *cobra.Command
• type Document
• type Header
• type KindMatcher
• type Matchers
  • func GetMatchersFromComments(comments []string) Matchers

Functions

func GetKindFromPath

func GetKindFromPath(path string) string

GetKindFromPath returns the kind of the resource based on its file path.

func NewDefaultCommand

func NewDefaultCommand() *cobra.Command

NewDefaultCommand creates a new default command

Types

type Document

type Document struct {
	Header   Header
	Severity string
	URL      string
	Rego     string
}

Document is a single policy document.

type Header

type Header struct {
	Title       string
	Description string
	Resources   string
}

Header is the header comment block found on a Rego policy.

type KindMatcher

type KindMatcher struct {
	APIGroup string
	Kind     string
}

KindMatcher are the matchers that are applied to constraints.

type Matchers

type Matchers struct {
	KindMatchers []KindMatcher
}

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

func GetMatchersFromComments

func GetMatchersFromComments(comments []string) Matchers

GetMatchersFromComments returns all of the matchers found in the collection of comments.