Skip to main content

Terraform

This article shows you how to analyze your Terraform projects and modules using preZero.

Requirements

See Prerequisites for more information.

Analyzing your Terraform projects and modules

To analyze your Terraform projects and modules, run:

sl analyze --app <name> --terraform [<path>]
ParameterDescription
--app <name>The name of the project/module to be analyzed (maximum length: 100 characters)
--terraformThe flag identifying the application is a Terraform project
<path>The path to the project/module to be analyzed

See the CLI reference for additional sl analyze options.

Additional parameters

The analysis accepts additional parameters after a double hyphen --.

For example, the following skips the test1.tf file inside the tests directory:

sl analyze --app <name> --terraform . -- --skip-path tests/test1.tf
ParameterDescription
--skip-path <path>Path (file or directory) to skip, using regular expression logic, relative to the current working directory. Word boundaries are not implicit; i.e., specifying "dir1" will skip any directory or subdirectory named "dir1". Can be specified multiple times

Tagging results with your branch name

To include the branch name in your preZero results, allowing you to distinguish one set of results from another, add the following to your invocation of Qwiet:

sl analyze --tag branch=`git symbolic-ref --short HEAD`

If you're working in a GitHub environment (e.g., GitHub Actions), you can also use --tag branch=${{ github.head_ref }} to populate your branch name.

If you don't provide a branch name, but Qwiet detects one available in your environment, it will use that name.