Skip to content

Commit

Permalink
Deployed ee339b5 to dev with MkDocs 1.3.0 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
knqyf263 committed Aug 14, 2024
1 parent 7b7b28b commit e2de6c8
Show file tree
Hide file tree
Showing 13 changed files with 188 additions and 188 deletions.
2 changes: 1 addition & 1 deletion dev/docs/configuration/filtering/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4329,7 +4329,7 @@ <h3 id="by-severity">By Severity</h3>

</details>

<div class="highlight"><pre><span></span><code>trivy conf --severity HIGH,CRITICAL examples/misconf/mixed
<div class="highlight"><pre><span></span><code>trivy config --severity HIGH,CRITICAL examples/misconf/mixed
</code></pre></div>
<details>
<summary>Result</summary>
Expand Down
2 changes: 1 addition & 1 deletion dev/docs/configuration/skipping/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4261,7 +4261,7 @@ <h2 id="file-patterns">File patterns</h2>
<p>A file pattern contains the analyzer it is used for, and the pattern itself, joined by a semicolon. For example:
<div class="highlight"><pre><span></span><code>--file-patterns &quot;dockerfile:.*.docker&quot; --file-patterns &quot;kubernetes:*.tpl&quot; --file-patterns &quot;pip:requirements-.*\.txt&quot;
</code></pre></div></p>
<p>The prefixes are listed <a href="https://github.com/aquasecurity/trivy/tree/08cc14bd2171afdc1973c6d614dd0d1fb82b7623/pkg/fanal/analyzer/const.go">here</a></p>
<p>The prefixes are listed <a href="https://github.com/aquasecurity/trivy/tree/ee339b5ed714b8b9edb52444a42ff5350ac3bc97/pkg/fanal/analyzer/const.go">here</a></p>
<div class="footnote">
<hr />
<ol>
Expand Down
2 changes: 1 addition & 1 deletion dev/docs/coverage/iac/cloudformation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4156,7 +4156,7 @@ <h2 id="misconfiguration">Misconfiguration</h2>
It evaluates properties, functions, and other elements within CloudFormation files to detect misconfigurations.</p>
<h3 id="value-overrides">Value Overrides</h3>
<p>You can provide <code>cf-params</code> with path to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html">CloudFormation Parameters</a> file to Trivy to scan your CloudFormation code with parameters.</p>
<div class="highlight"><pre><span></span><code>trivy conf --cf-params params.json ./infrastructure/cf
<div class="highlight"><pre><span></span><code>trivy config --cf-params params.json ./infrastructure/cf
</code></pre></div>
<p>You can check a <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/deploy.html#supported-json-syntax">CloudFormation Parameters Example</a></p>
<h2 id="secret">Secret</h2>
Expand Down
6 changes: 3 additions & 3 deletions dev/docs/coverage/iac/helm/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4213,7 +4213,7 @@ <h3 id="value-overrides">Value overrides</h3>
When override values are passed to the Helm scanner, the values will be used during the Manifest rendering process and will become part of the scanned artifact.</p>
<h4 id="setting-inline-value-overrides">Setting inline value overrides</h4>
<p>Overrides can be set inline on the command line</p>
<div class="highlight"><pre><span></span><code>trivy conf --helm-set securityContext.runAsUser<span class="o">=</span><span class="m">0</span> ./charts/mySql
<div class="highlight"><pre><span></span><code>trivy config --helm-set securityContext.runAsUser<span class="o">=</span><span class="m">0</span> ./charts/mySql
</code></pre></div>
<h4 id="setting-value-file-overrides">Setting value file overrides</h4>
<p>Overrides can be in a file that has the key=value set.</p>
Expand All @@ -4222,15 +4222,15 @@ <h4 id="setting-value-file-overrides">Setting value file overrides</h4>
<span class="nt">securityContext</span><span class="p">:</span><span class="w"></span>
<span class="w"> </span><span class="nt">runAsUser</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span><span class="w"></span>
</code></pre></div>
<div class="highlight"><pre><span></span><code>trivy conf --helm-values overrides.yaml ./charts/mySql
<div class="highlight"><pre><span></span><code>trivy config --helm-values overrides.yaml ./charts/mySql
</code></pre></div>
<h4 id="setting-value-as-explicit-string">Setting value as explicit string</h4>
<p>the <code>--helm-set-string</code> is the same as <code>--helm-set</code> but explicitly retains the value as a string</p>
<div class="highlight"><pre><span></span><code>trivy config --helm-set-string <span class="nv">name</span><span class="o">=</span><span class="nb">false</span> ./infrastructure/tf
</code></pre></div>
<h4 id="setting-specific-values-from-files">Setting specific values from files</h4>
<p>Specific override values can come from specific files</p>
<div class="highlight"><pre><span></span><code>trivy conf --helm-set-file <span class="nv">environment</span><span class="o">=</span>dev.values.yaml ./charts/mySql
<div class="highlight"><pre><span></span><code>trivy config --helm-set-file <span class="nv">environment</span><span class="o">=</span>dev.values.yaml ./charts/mySql
</code></pre></div>
<h2 id="secret">Secret</h2>
<p>The secret scan is performed on plain text files, with no special treatment for Helm.
Expand Down
8 changes: 4 additions & 4 deletions dev/docs/coverage/iac/terraform/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4241,23 +4241,23 @@ <h1 id="terraform">Terraform</h1>
</table>
<p>Trivy can scan Terraform Plan files (snapshots) or their JSON representations. To create a Terraform Plan and scan it, run the following command:
<div class="highlight"><pre><span></span><code>terraform plan --out tfplan
trivy conf tfplan
trivy config tfplan
</code></pre></div></p>
<p>To scan a Terraform Plan representation in JSON format, run the following command:
<div class="highlight"><pre><span></span><code>terraform show -json tfplan &gt; tfplan.json
trivy conf tfplan.json
trivy config tfplan.json
</code></pre></div></p>
<h2 id="misconfiguration">Misconfiguration</h2>
<p>Trivy recursively searches directories and scans all found Terraform files.
It also evaluates variables, imports, and other elements within Terraform files to detect misconfigurations.</p>
<h3 id="value-overrides">Value Overrides</h3>
<p>You can provide <code>tf-vars</code> files to Trivy to override default values specified in the Terraform HCL code.</p>
<div class="highlight"><pre><span></span><code>trivy conf --tf-vars dev.terraform.tfvars ./infrastructure/tf
<div class="highlight"><pre><span></span><code>trivy config --tf-vars dev.terraform.tfvars ./infrastructure/tf
</code></pre></div>
<h3 id="exclude-downloaded-terraform-modules">Exclude Downloaded Terraform Modules</h3>
<p>By default, downloaded modules are also scanned.
If you don't want to scan them, you can use the <code>--tf-exclude-downloaded-modules</code> flag.</p>
<div class="highlight"><pre><span></span><code>trivy conf --tf-exclude-downloaded-modules ./configs
<div class="highlight"><pre><span></span><code>trivy config --tf-exclude-downloaded-modules ./configs
</code></pre></div>
<h2 id="secret">Secret</h2>
<p>The secret scan is performed on plain text files, with no special treatment for Terraform.</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/docs/scanner/misconfiguration/custom/debug/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4036,7 +4036,7 @@ <h1 id="debugging-checks">Debugging checks</h1>
<p class="admonition-title">Tip</p>
<p>Only failed checks show traces. If you want to debug a passed check, you need to make it fail on purpose.</p>
</div>
<div class="highlight"><pre><span></span><code>$ trivy conf --trace configs/
<div class="highlight"><pre><span></span><code>$ trivy config --trace configs/
<span class="m">2022</span>-05-16T13:47:58.853+0100 INFO Detected config files: <span class="m">1</span>

Dockerfile <span class="o">(</span>dockerfile<span class="o">)</span>
Expand Down
4 changes: 2 additions & 2 deletions dev/docs/scanner/misconfiguration/custom/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4310,7 +4310,7 @@ <h1 id="custom-checks">Custom Checks</h1>
<h2 id="overview">Overview</h2>
<p>You can write custom checks in <a href="https://www.openpolicyagent.org/docs/latest/policy-language/">Rego</a>.
Once you finish writing custom checks, you can pass the check files or the directory where those checks are stored with --config-check` option.</p>
<div class="highlight"><pre><span></span><code>trivy conf --config-check /path/to/policy.rego --config-check /path/to/custom_checks --namespaces user /path/to/config_dir
<div class="highlight"><pre><span></span><code>trivy config --config-check /path/to/policy.rego --config-check /path/to/custom_checks --namespaces user /path/to/config_dir
</code></pre></div>
<p>As for <code>--namespaces</code> option, the detail is described as below.</p>
<h3 id="file-formats">File formats</h3>
Expand Down Expand Up @@ -4429,7 +4429,7 @@ <h3 id="package">Package</h3>
</div>
<p>By default, only <code>builtin.*</code> packages will be evaluated.
If you define custom packages, you have to specify the package prefix via <code>--namespaces</code> option. By default, Trivy only runs in its own namespace, unless specified by the user. Note that the custom namespace does not have to be <code>user</code> as in this example. It could be anything user-defined.</p>
<div class="highlight"><pre><span></span><code>trivy conf --config-check /path/to/custom_checks --namespaces user /path/to/config_dir
<div class="highlight"><pre><span></span><code>trivy config --config-check /path/to/custom_checks --namespaces user /path/to/config_dir
</code></pre></div>
<p>In this case, <code>user.*</code> will be evaluated.
Any package prefixes such as <code>main</code> and <code>user</code> are allowed.</p>
Expand Down
10 changes: 5 additions & 5 deletions dev/docs/scanner/misconfiguration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4365,7 +4365,7 @@ <h2 id="type-detection">Type detection</h2>
<p>For example, the following example holds IaC files for Terraform, CloudFormation, Kubernetes, Helm Charts, and Dockerfile in the same directory.</p>
<div class="highlight"><pre><span></span><code>$ ls iac/
Dockerfile deployment.yaml main.tf mysql-8.8.26.tar
$ trivy conf --severity HIGH,CRITICAL ./iac
$ trivy config --severity HIGH,CRITICAL ./iac
</code></pre></div>
<details>
<summary>Result</summary>
Expand Down Expand Up @@ -4586,23 +4586,23 @@ <h3 id="enabling-a-subset-of-misconfiguration-scanners">Enabling a subset of mis
<h3 id="loading-custom-checks">Loading custom checks</h3>
<p>You can load check files or directories including your custom checks using the <code>--config-check</code> flag.
This can be repeated for specifying multiple files or directories.</p>
<div class="highlight"><pre><span></span><code>trivy conf --config-check custom-policy/policy --config-check combine/policy --config-check policy.rego --namespaces user myapp
<div class="highlight"><pre><span></span><code>trivy config --config-check custom-policy/policy --config-check combine/policy --config-check policy.rego --namespaces user myapp
</code></pre></div>
<p>You can load checks bundle as OCI Image from a Container Registry using the <code>--checks-bundle-repository</code> flag.</p>
<div class="highlight"><pre><span></span><code>trivy conf --checks-bundle-repository myregistry.local/mychecks --namespaces user myapp
<div class="highlight"><pre><span></span><code>trivy config --checks-bundle-repository myregistry.local/mychecks --namespaces user myapp
</code></pre></div>
<h3 id="passing-custom-data">Passing custom data</h3>
<p>You can pass directories including your custom data through <code>--data</code> option.
This can be repeated for specifying multiple directories.</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span> examples/misconf/custom-data
trivy conf --config-check ./policy --data ./data --namespaces user ./configs
trivy config --config-check ./my-check --data ./data --namespaces user ./configs
</code></pre></div>
<p>For more details, see <a href="custom/data/">Custom Data</a>.</p>
<h3 id="passing-namespaces">Passing namespaces</h3>
<p>By default, Trivy evaluates checks defined in <code>builtin.*</code>.
If you want to evaluate custom checks in other packages, you have to specify package prefixes through <code>--namespaces</code> option.
This can be repeated for specifying multiple packages.</p>
<div class="highlight"><pre><span></span><code>trivy conf --config-check ./policy --namespaces main --namespaces user ./configs
<div class="highlight"><pre><span></span><code>trivy config --config-check ./my-check --namespaces main --namespaces user ./configs
</code></pre></div>
<h3 id="private-terraform-registries">Private terraform registries</h3>
<p>Trivy can download terraform code from private registries.
Expand Down
2 changes: 1 addition & 1 deletion dev/search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit e2de6c8

Please sign in to comment.