Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Check ¶
type Check struct {
Name string `json:"name"`
Description string `json:"description"`
Remediation string `json:"remediation"`
Scope *ObjectKindsDesc `json:"scope"`
Template string `json:"template"`
Params map[string]interface{} `json:"params,omitempty"`
}
A Check represents a single check. It is serializable.
type ChecksConfig ¶
type ChecksConfig struct {
// AddAllBuiltIn, if set, adds all built-in checks. This allows users to
// explicitly opt-out of checks that are not relevant using Exclude.
// +flagName=add-all-built-in
AddAllBuiltIn bool `json:"addAllBuiltIn"`
// DoNotAutoAddDefaults, if set, prevents the automatic addition of default checks.
// +flagName=do-not-auto-add-defaults
DoNotAutoAddDefaults bool `json:"doNotAutoAddDefaults"`
// Exclude is a list of check names to exclude.
// +flagName=exclude
Exclude []string `json:"exclude"`
// Include is a list of check names to include. If a check is in both Include and Exclude,
// Exclude wins.
// +flagName=include
Include []string `json:"include"`
// IgnorePaths is a list of path to ignore from applying checks
// +flagName=ignore-paths
IgnorePaths []string `json:"ignorePaths"`
}
ChecksConfig is the config that determines which checks to run.
type Config ¶
type Config struct {
// +flagName=-
CustomChecks []Check `json:"customChecks,omitempty"`
Checks ChecksConfig `json:"checks,omitempty"`
}
Config represents the config file format.
type ObjectKindsDesc ¶
type ObjectKindsDesc struct {
ObjectKinds []string `json:"objectKinds"`
}
ObjectKindsDesc describes a list of supported object kinds for a check template.
Click to show internal directories.
Click to hide internal directories.