report

Documentation

Index

• Constants
• func JsonReport(report *Report) (string, error)
• type Check
• type Report
• type Resource

Constants

const (
	// Passed is the constant value for the Result field of a passed check
	Passed string = "PASSED"
	// Failed is the constant value for the Result field of a failed check
	Failed string = "FAILED"
	// Skipped is the constant value for the Result field of a skipped check
	Skipped string = "SKIPPED"
)

const (
	//JSONOutput is the constant value for output type JSON
	JSONOutput string = "json"
)

Functions

func JsonReport

func JsonReport(report *Report) (string, error)

Types

type Check

type Check struct {
	Name    string `json:"name"`
	Message string `json:"message"`
	Result  string `json:"result"`
}

Check represents the result of a check

type Report

type Report struct {
	Resources []*Resource `json:"resources"`
}

Report represents the final output of the analyzer

type Resource

type Resource struct {
	Kind      string   `json:"kind"`
	Namespace string   `json:"namespace"`
	Name      string   `json:"name"`
	Checks    []*Check `json:"checks"`
}

Resource represents the a resource of the cluster and all the checks done on it