engine

Documentation

Overview

Package engine runs Vulcan checks and retrieves the generated reports.

Index

• type Report
  • func Run(checktypeURLs []string, targets []config.Target, cfg config.AgentConfig) (Report, error)

Types

type Report

type Report map[string]report.Report

Report is a collection of reports returned by Vulcan checks and indexed by check ID.

func Run

func Run(checktypeURLs []string, targets []config.Target, cfg config.AgentConfig) (Report, error)

Run runs vulcan checks and returns the generated report. The check list is based on the provided checktypes and targets. These checks are run by a Vulcan agent, which is configured using the specified configuration.