From 56afe1fce9d1f2cc9d791d67db744acc8a0c7bb4 Mon Sep 17 00:00:00 2001 From: Anais Urlichs <33576047+AnaisUrlichs@users.noreply.github.com> Date: Mon, 26 Jun 2023 11:56:57 +0100 Subject: [PATCH] clarifying a dir path is required for custom policies (#4716) Signed-off-by: AnaisUrlichs --- docs/docs/scanner/misconfiguration/custom/index.md | 3 +++ docs/docs/scanner/misconfiguration/index.md | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/docs/scanner/misconfiguration/custom/index.md b/docs/docs/scanner/misconfiguration/custom/index.md index d31f5e8c35af..94b1fec9c330 100644 --- a/docs/docs/scanner/misconfiguration/custom/index.md +++ b/docs/docs/scanner/misconfiguration/custom/index.md @@ -8,6 +8,9 @@ Once you finish writing custom policies, you can pass the directory where those trivy conf --policy /path/to/custom_policies --namespaces user /path/to/config_dir ``` +!!! Tip + Note: The `--policy` path always needs to refer to a directory. You cannot pass a specific policy file. + As for `--namespaces` option, the detail is described as below. ### File formats diff --git a/docs/docs/scanner/misconfiguration/index.md b/docs/docs/scanner/misconfiguration/index.md index ad8b98c40178..87cc6cc0e4fe 100644 --- a/docs/docs/scanner/misconfiguration/index.md +++ b/docs/docs/scanner/misconfiguration/index.md @@ -346,7 +346,8 @@ trivy conf --policy custom-policy/policy --policy combine/policy --namespaces us For more details, see [Custom Policies](./custom/index.md). !!! tip -You also need to specify `--namespaces` option. + You also need to specify `--namespaces` option. + Furthermore, the `--policy` path always needs to refer to a directory. You cannot pass a specific policy file. ### Pass custom data You can pass directories including your custom data through `--data` option.