-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Architecture | ||
|
||
This document aims to answer the question *Where is the code that does X?* | ||
|
||
## Project Layout | ||
|
||
The directory structure is broken down as follows: | ||
|
||
- `cmd/` - These CLI tools are primarily used during development for end-to-end testing without needing to pull the library into trivy/tfsec etc. | ||
- `rules` - All of the rules and policies are defined in this directory. | ||
- `pkg/spec` - Logic to handle standardized specs such as CIS. | ||
- `pkg/rules` - This package exposes internal rules, and imports them accordingly (see _rules.go_). | ||
- `test` - Integration tests and other high-level tests that require a full build of the project. | ||
- `scripts` - Usefule generation scripts for bundle generation and verification purposes. |