Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(guides): remove ZWSPs & align column separators #6852

Merged
merged 2 commits into from
Jan 19, 2024
Merged

docs(guides): remove ZWSPs & align column separators #6852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e548b9b
Remove ZWSPs & align colum separators
katrinleinweber Jan 18, 2024
f1db632
Remove ZWSPs
katrinleinweber Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ You can enclose all your configurations in a file and use it in two different wa
3. Pass the configuration file as argument:

```
docker run -t -v {​​​​path_to_kics_config}​​​​:/kics -v {path_to_host_folder_to_scan}:/path checkmarx/kics scan -p /path --config /kics/kics-config.json
docker run -t -v {path_to_kics_config}:/kics -v {path_to_host_folder_to_scan}:/path checkmarx/kics scan -p /path --config /kics/kics-config.json
```

#### Configuration as Code
Expand Down
14 changes: 7 additions & 7 deletions docs/performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ The values below were obtained after scanning 150 open source projects with KICS
the supported IaC technologies (c.f., Terraform, Ansible, Kubernetes, Docker, AWS Cloudformation).


| IaC Technology | Query Accuracy<sup>1</sup> | Query Coverage<sup>2</sup> | Scanned IaC files​ | Number of Results​ | Average Scan Time​ (s) | Average Project Size (MB) |
| :--- | :--- | :--- | :--- | :--- | :---| :---|
| Terraform​ | 99.7%​ | 46% | 1176​ | 709 | 6.6 | 33.4​ |
| Docker​ | 98.8%​​ | 68%​ | 1017​ | 5109 | 11 | 0.7 |​
| Kubernetes​ | 99.3%​​ | 88.7%​ | 6089​ | 21753 | 7 | 90 |​
| CloudFormation​ | 95%​ | 73%​ | 1769​ | 5343 | 10.2 | 4.8 |​
| Ansible ​ | 100% |​ 54%​ | 3367​ | 1320 | 23.3 | 4.1 |​
| IaC Technology | Query Accuracy<sup>1</sup> | Query Coverage<sup>2</sup> | Scanned IaC files | Number of Results | Average Scan Time (s) | Average Project Size (MB) |
| :--- | :--- | :--- | :--- | :--- | :---| :--- |
| Terraform | 99.7% | 46% | 1176 | 709 | 6.6 | 33.4 |
| Docker | 98.8% | 68% | 1017 | 5109 | 11 | 0.7 |
| Kubernetes | 99.3% | 88.7% | 6089 | 21753 | 7 | 90 |
| CloudFormation | 95% | 73% | 1769 | 5343 | 10.2 | 4.8 |
| Ansible | 100% | 54% | 3367 | 1320 | 23.3 | 4.1 |

---

Expand Down
4 changes: 2 additions & 2 deletions docs/running-kics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Files and directories that are not local will be placed in a temporarily folder
### Local Files

```
docker run -t -v {​​​​path_to_scan}​​​​:/path checkmarx/kics scan -p /path
docker run -t -v {path_to_scan}:/path checkmarx/kics scan -p /path
```

### Archived Files
Expand All @@ -33,7 +33,7 @@ Available archive formats:
- `xz`

```
docker run -t -v {​​​​path_to_scan_zip}​​​​:/path checkmarx/kics scan -p /path
docker run -t -v {path_to_scan_zip}:/path checkmarx/kics scan -p /path
```

More information can be seen [here](https://github.com/hashicorp/go-getter#unarchiving)
Expand Down
Loading