polaris

Documentation

Index

• Variables
• type Check
• type ClusterInfo
• type ContainerResult
• type Converter
  • func NewConverter() Converter
• type PodResult
• type ReadWriter
• type Reader
• type Report
• type Result
• type Scanner
  • func NewScanner(opts kube.ScannerOpts, clientset kubernetes.Interface) *Scanner
  • func (s *Scanner) Scan(ctx context.Context, workload kube.Object, gvk schema.GroupVersionKind) (report starboard.ConfigAudit, owner meta.Object, err error)
• type Writer

Variables

var DefaultConverter = NewConverter()

Types

type Check

type Check struct {
	ID       string `json:"ID"`
	Message  string `json:"Message"`
	Success  bool   `json:"Success"`
	Severity string `json:"Severity"`
	Category string `json:"Category"`
}

type ClusterInfo

type ClusterInfo struct {
	Version     string `json:"Version"`
	Nodes       int    `json:"Nodes"`
	Pods        int    `json:"Pods"`
	Namespaces  int    `json:"Namespaces"`
	Controllers int    `json:"Controllers"`
}

type ContainerResult

type ContainerResult struct {
	Name    string           `json:"Name"`
	Results map[string]Check `json:"Results"`
}

type Converter

type Converter interface {
	Convert(reader io.Reader) (sec.ConfigAudit, error)
}

func NewConverter

func NewConverter() Converter

type PodResult

type PodResult struct {
	Name             string            `json:"Name"`
	Results          map[string]Check  `json:"Results"`
	ContainerResults []ContainerResult `json:"ContainerResults"`
}

type ReadWriter

type ReadWriter interface {
	Writer
	Reader
}

type Reader

type Reader interface {
	Read(ctx context.Context, workload kube.Object) (starboard.ConfigAuditReport, error)
}

Reader is the interface that wraps basic methods for persistent reading of ConfigAudit reports.

Read will return a single ConfigAuditReport that match a specific workload

type Report

type Report struct {
	PolarisOutputVersion string       `json:"PolarisOutputVersion"`
	SourceType           string       `json:"SourceType"`
	SourceName           string       `json:"SourceName"`
	DisplayName          string       `json:"DisplayName"`
	ClusterInfo          *ClusterInfo `json:"ClusterInfo"`
	Results              []Result     `json:"Results"`
}

type Result

type Result struct {
	Name      string    `json:"Name"`
	Namespace string    `json:"Namespace"`
	Kind      string    `json:"Kind"`
	PodResult PodResult `json:"PodResult"`
}

type Scanner

type Scanner struct {
	// contains filtered or unexported fields
}

func NewScanner

func NewScanner(opts kube.ScannerOpts, clientset kubernetes.Interface) *Scanner

func (*Scanner) Scan

func (s *Scanner) Scan(ctx context.Context, workload kube.Object, gvk schema.GroupVersionKind) (report starboard.ConfigAudit, owner meta.Object, err error)

type Writer

type Writer interface {
	Write(ctx context.Context, report sec.ConfigAudit, owner metav1.Object) (err error)
}

Write is the interface that wraps basic methods for persisting ConfigAudit reports.

Write persists the given ConfigAudit report.