report

Documentation

Index

• Constants
• type ClusterPolicyReport
  • func (cr ClusterPolicyReport) GetIdentifier() string
  • func (cr ClusterPolicyReport) GetNewValidation(cor ClusterPolicyReport) []Result
• type PolicyReport
  • func (pr PolicyReport) GetIdentifier() string
  • func (pr PolicyReport) GetNewValidation(or PolicyReport) []Result
• type Priority
• type Report
• type Resource
• type Result
  • func (r Result) GetIdentifier() string
• type Severity
• type Status
• type Summary

Constants

const (
	Fail  Status = "fail"
	Warn  Status = "warn"
	Error Status = "error"
	Pass  Status = "pass"
	Skip  Status = "skip"

	Low    Severity = "low"
	Medium Severity = "medium"
	Heigh  Severity = "heigh"

	Alert       Priority = "error"
	Warning     Priority = "warning"
	Information Priority = "info"
	Debug       Priority = "debug"
)

Types

type ClusterPolicyReport

type ClusterPolicyReport struct {
	Name    string
	Results map[string]Result
	Summary Summary
}

func (ClusterPolicyReport) GetIdentifier

func (cr ClusterPolicyReport) GetIdentifier() string

func (ClusterPolicyReport) GetNewValidation

func (cr ClusterPolicyReport) GetNewValidation(cor ClusterPolicyReport) []Result

type PolicyReport

type PolicyReport struct {
	Name      string
	Namespace string
	Results   map[string]Result
	Summary   Summary
}

func (PolicyReport) GetIdentifier

func (pr PolicyReport) GetIdentifier() string

func (PolicyReport) GetNewValidation

func (pr PolicyReport) GetNewValidation(or PolicyReport) []Result

type Priority

type Priority = string

type Report

type Report interface {
	GetIdentifier() string
}

type Resource

type Resource struct {
	APIVersion string
	Kind       string
	Name       string
	Namespace  string
	UID        string
}

type Result

type Result struct {
	Message   string
	Policy    string
	Rule      string
	Priority  Priority
	Status    Status
	Severity  Severity
	Category  string
	Scored    bool
	Resources []Resource
}

func (Result) GetIdentifier

func (r Result) GetIdentifier() string

type Severity

type Severity = string

type Status

type Status = string

type Summary

type Summary struct {
	Pass  int
	Skip  int
	Warn  int
	Error int
	Fail  int
}