equals

The equals analyser checks if a value equals a given string. For map inputs, it checks if the value at a specified key equals the given string.

Configuration

Field	Type	Required	Description
value	string	Yes	The string value to compare against
key	string	No	For map inputs, the key whose value to check

Common fields

Field	Description	Required	Default
name	The name of the policy - this is the yaml key in the config file when defining the policy.	Yes	-
description	The description of the policy - if specified, it will be used as the heading for the policy in the output.	No	""
input	The input for the policy - used to select the fact plugin to use.	Yes	-
severity	The severity of the policy when breached (low, normal, high, critical)	No	normal
breach-format	The breach template for the policy. The table below shows the available fields.	No	Empty breach template
remediation	The remediation for the policy. The table below shows the available fields.	No	Empty remediation

Breach template

WARNING

TODO: Add information on how to use go template variables.

Field	Description	Required	Default
type	The type of breach.	Yes	""
key-label	The label for the key.	No	""
key	The key.	No	""
value-label	The label for the value.	No	""
value	The value.	No	""

Remediation

Field	Description	Required	Default
plugin	The plugin to use for remediation.	No	"command"
msg	The message to display when remediation completes successfully.	No	"remediation successful"
...	Any fields required by the plugin.	No	-

Supported Input Formats

• FormatString: Checks if the string value equals the configured value
• FormatMapString: Checks if the value at the specified key equals the configured value

Example Usage