Skip to content

Docs: How to disable/override IaC scanning rules

Connor Gilbert requested to merge connorgilbert/iac-customization into master

What does this MR do?

Add documentation for customizing IaC scanning rules.

People would like to disable certain rules and otherwise control which rules are run against their projects. While we intend to enable this more broadly, we have already implemented this option—just haven't documented it yet.

There are some usability "bumps in the road" with this experience, especially with the requirement for a UUID instead of a name. But we should at least document the feature (available since 14.8) and improve it in the future.

Related issues

SAST & Secret-Detection Custom Rules - Modifyi... (#235359 - closed) (existing feature)

Support for adding custom ruleset queries to SA... (#348371) (future, more generic feature)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Connor Gilbert

Merge request reports