api

Documentation

Index

• type Analyze
• type Collect
• type Result
• type Spec
  • func DeserializeSpec(b []byte) (spec Spec, err error)

Types

type Analyze

type Analyze struct {
	V1Alpha1 []v1alpha1.AnalyzerSpec `json:"v1alpha1,omitempty" yaml:"v1alpha1,omitempty" hcl:"v1alpha1,omitempty"`
}

Analyze is the top level analyze object

type Collect

type Collect struct {
	V1 []collecttypes.Spec `json:"v1,omitempty" yaml:"v1,omitempty" hcl:"v1,omitempty"`
}

Collect is the top level collect object

type Result

type Result struct {
	Message      string                   `json:"message" yaml:"message" hcl:"message"`
	Requirement  string                   `json:"requirement,omitempty" yaml:"requirement,omitempty" hcl:"requirement,omitempty"`
	Severity     common.Severity          `json:"severity" yaml:"severity" hcl:"severity"`
	AnalyzerSpec Analyze                  `json:"analyzer_spec" yaml:"analyzer_spec" hcl:"analyzer_spec"`
	Vars         []map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty" hcl:"variables,omitempty"`
	Error        string                   `json:"error,omitempty" yaml:"error,omitempty" hcl:"error,omitempty"`
}

type Spec

type Spec struct {
	Collect Collect `json:"collect" yaml:"collect" hcl:"collect"`
	Analyze Analyze `json:"analyze" yaml:"analyze" hcl:"analyze"`
}

Spec is the top level Analyze document that defines an set of collectors and analysis

func DeserializeSpec

func DeserializeSpec(b []byte) (spec Spec, err error)

DeserializeSpec will deserialize a analyze spec. Possibly support more formats?