Secret Detection: Add Scanner Internals and Rename Terminologies
Why is this change being made?
MR Changes
- Rename references:
-
Scan Engine->Scanner - "underlying scan engine" ->
Scan Engine -
Unified SD Scan Engine->Unified SD Scanner
-
- Introduces
Analyzerterminology to represent implementation wrapper for each scan target type. - With the introduction of
Analyzerterm,Adapterbecomes redundant as it would be a subset ofAnalyzerimplementation. So, I've removed the concept of Adapters. - Added a dedicated
Componentssection containing terminologies used in Unified SD Scanner context. We could later move this to - Adds
Scanner Internalssection under Secret Detection Unified Scan Engine ADR to describe the accommodation of multiple engines and interceptors. - Modifies the illustration of high-level design for the Unified Scan Engine to reflect better description of the concept.
Author and Reviewer Checklist
Please verify the check list and ensure to tick them off before the MR is merged.
-
Provided a concise title for this Merge Request (MR) -
Added a description to this MR explaining the reasons for the proposed change, per say why, not just what - Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
-
Assign reviewers for this MR to the correct - The when to get approval handbook section explains when DRI approval is required
- The who can approve handbook section explains how to identify the DRI
- If the MR does not require DRI approval, consider asking someone on your team, such as your manager.
- The approver may merge the MR. If they approve but don't merge, you can merge.
-
For transparency, share this MR with the audience that will be impacted. -
Team: For changes that affect your direct team, share in your group Slack channel -
Department: If the update affects your department, share the MR in your department Slack channel -
Division: If the update affects your division, share the MR in your division Slack channel -
Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR - For high-priority company-wide announcements work with the internal communications team to post the update in #company-fyi and align on a plan to circulate in additional channels like the "While You Were Iterating" Newsletter
-
Commits
- Add Scan Engine Component Internals
Edited by Vishwa Bhat