models

Documentation

Index

• type CustomCheckInstanceModel
• type CustomCheckModel
• type KubernetesTarget
• type OutputModel

Types

type CustomCheckInstanceModel

type CustomCheckInstanceModel struct {
	CheckName    string                 `json:"-" yaml:"-"`
	InstanceName string                 `json:"-" yaml:"-"`
	Targets      []KubernetesTarget     `yaml:"targets"`
	Clusters     []string               `yaml:"clusters"`
	Parameters   map[string]interface{} `yaml:"parameters"`
	Output       OutputModel            `yaml:"output"`
}

CustomCheckInstanceModel is a model for the API endpoint to receive an Instance for a Custom Check in OPA

type CustomCheckModel

type CustomCheckModel struct {
	CheckName string `json:"-" yaml:"-"`
	Version   float32
	Output    OutputModel
	Rego      string
	Instances []CustomCheckInstanceModel `json:"-" yaml:"-"`
}

CustomCheckModel is a model for the API endpoint to receive a Custom Check for OPA

type KubernetesTarget

type KubernetesTarget struct {
	APIGroups []string `json:"apiGroups" yaml:"apiGroups"`
	Kinds     []string `json:"kinds" yaml:"kinds"`
}

KubernetesTarget represents a set of API Versions and Kinds to find Kubernetes objects.

type OutputModel

type OutputModel struct {
	Title       *string
	Severity    *float64
	Remediation *string
	Category    *string
}

OutputModel is a model to represent settings for Action Items created by OPA.