doctena-org/octorules-sync

Run doctena-org/octorules to deploy your WAF rules config.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
config_pathPath, relative to your repository root, of the config file you would like octorules to use.noconfig.yaml
doitSet "--doit" to apply changes, leave empty to plan only.no""
forceSet "Yes" to bypass safety thresholds, leave empty to enforce them.no""
checksumPass a plan checksum to octorules sync for drift protection. Only used when doit is "--doit".no""
phasesSpace separated list of rule phases to sync (e.g. "cache_rules redirect_rules"). Leave empty for all phases.no""
zonesSpace separated list of zones to sync, leave empty to sync all zones in the config file.no""
lintRun octorules lint before plan/sync? Set "Yes" to enable.noNo
lint_severityMinimum lint severity: "error", "warning", or "info".nowarning
lint_planCloudflare plan tier for lint entitlement checks (e.g. "free", "enterprise"). Defaults to "enterprise". Other providers ignore this.no""
auditRun octorules audit (IP overlap, IP shadow, CDN range, zone drift checks) before plan/sync? Set "Yes" to enable.noNo
audit_checksSpace separated list of audit checks to run (e.g. "ip-overlap cdn-ranges"). Leave empty for all checks.no""
audit_severityMinimum audit severity: "error", "warning", or "info".nowarning
audit_logPath to write a JSON-lines audit log of sync results. Empty = disabled.no""
add_pr_commentAdd plan as a comment, when triggered by a pull request?noNo
pr_comment_tokenProvide a token to use, if you set add_pr_comment to Yes.no""
namedescription
log`octorules` command output
planPlanned changes from octorules
exit_codeThe exit code from octorules. For plan: 0 = no changes, 2 = changes detected, 1 = error. For sync: 0 = success, 1 = error.
checksumSHA-256 plan checksum for drift protection (plan mode only).
lint_exit_codeExit code from octorules lint: 0 = clean, 1 = errors, 2 = warnings only, empty = lint disabled.
lint_resultsLint results text. Empty when disabled or clean.
audit_exit_codeExit code from octorules audit: 0 = clean, 1 = errors, 2 = warnings only, empty = audit disabled.
audit_resultsAudit results text. Empty when disabled or clean.