Documentation
¶
Overview ¶
Package actions provide necessary interfaces and implementations for processing actions, such as remediation and alerts.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlertStatus ¶ added in v0.2.0
type AlertStatus string
AlertStatus represents alert state.
const ( AlertStatusOn AlertStatus = "on" AlertStatusOff AlertStatus = "off" AlertStatusError AlertStatus = "error" AlertStatusSkipped AlertStatus = "skipped" AlertStatusNotAvailable AlertStatus = "not_available" )
AlertStatus constants represent alert states.
type EvalStatus ¶ added in v0.2.0
type EvalStatus string
EvalStatus represents evaluation status.
const ( EvalStatusSuccess EvalStatus = "success" EvalStatusFailure EvalStatus = "failure" EvalStatusError EvalStatus = "error" EvalStatusSkipped EvalStatus = "skipped" EvalStatusPending EvalStatus = "pending" )
EvalStatus constants represent evaluation statuses.
type RemediationStatus ¶ added in v0.2.0
type RemediationStatus string
RemediationStatus represents remediation state.
const ( RemediationStatusSuccess RemediationStatus = "success" RemediationStatusFailure RemediationStatus = "failure" RemediationStatusError RemediationStatus = "error" RemediationStatusSkipped RemediationStatus = "skipped" RemediationStatusNotAvailable RemediationStatus = "not_available" RemediationStatusPending RemediationStatus = "pending" )
RemediationStatus constants represent remediation states.
type RuleActionsEngine ¶
type RuleActionsEngine struct {
// contains filtered or unexported fields
}
RuleActionsEngine is the engine responsible for processing all actions i.e., remediation and alerts
func NewRuleActions ¶
func NewRuleActions( ctx context.Context, ruletype *minderv1.RuleType, provider provinfv1.Provider, actionConfig *models.ActionConfiguration, ) (*RuleActionsEngine, error)
NewRuleActions creates a new rule actions engine
func (*RuleActionsEngine) DoActions ¶
func (rae *RuleActionsEngine) DoActions( ctx context.Context, ent protoreflect.ProtoMessage, params engif.ActionsParams, ) enginerr.ActionsError
DoActions processes all actions i.e., remediation and alerts
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package alert provides necessary interfaces and implementations for processing alerts.
|
Package alert provides necessary interfaces and implementations for processing alerts. |
|
noop
Package noop provides a fallback alert engine for cases where no alert is set.
|
Package noop provides a fallback alert engine for cases where no alert is set. |
|
pull_request_comment
Package pull_request_comment provides necessary interfaces and implementations for processing pull request comment alerts.
|
Package pull_request_comment provides necessary interfaces and implementations for processing pull request comment alerts. |
|
security_advisory
Package security_advisory provides necessary interfaces and implementations for creating alerts of type security advisory.
|
Package security_advisory provides necessary interfaces and implementations for creating alerts of type security advisory. |
|
Package remediate provides necessary interfaces and implementations for remediating rules.
|
Package remediate provides necessary interfaces and implementations for remediating rules. |
|
gh_branch_protect
Package gh_branch_protect provides the github branch protection remediation engine
|
Package gh_branch_protect provides the github branch protection remediation engine |
|
noop
Package noop provides a fallback remediation engine for cases where no remediation is set.
|
Package noop provides a fallback remediation engine for cases where no remediation is set. |
|
pull_request
Package pull_request provides the pull request remediation engine
|
Package pull_request provides the pull request remediation engine |
|
rest
Package rest provides the REST remediation engine
|
Package rest provides the REST remediation engine |
Click to show internal directories.
Click to hide internal directories.