Skip to content

Commit

Permalink
Update docs for "ec opa" command
Browse files Browse the repository at this point in the history
Signed-off-by: Luiz Carvalho <[email protected]>
  • Loading branch information
lcarva committed Sep 30, 2024
1 parent 45df429 commit 337469a
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 11 deletions.
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/ec_opa_bench.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ ec opa bench <query> [flags]
-I, --stdin-input:: read input document from stdin (Default: false)
-t, --target:: set the runtime to exercise (Default: rego)
-u, --unknowns:: set paths to treat as unknown during partial evaluation (Default: [input])
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v0-compatible:: opt-in to OPA features and behaviors prior to the OPA v1.0 release. Takes precedence over --v1-compatible (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)

== Options inherited from parent commands

Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/ec_opa_build.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,8 @@ ec opa build <path> [<path> [...]] [flags]
--signing-key:: set the secret (HMAC) or path of the PEM file containing the private key (RSA and ECDSA)
--signing-plugin:: name of the plugin to use for signing/verification (see https://www.openpolicyagent.org/docs/latest/management-bundles/#signature-plugin
-t, --target:: set the output bundle target type (Default: rego)
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v0-compatible:: opt-in to OPA features and behaviors prior to the OPA v1.0 release. Takes precedence over --v1-compatible (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)
--verification-key:: set the secret (HMAC) or path of the PEM file containing the public key (RSA and ECDSA)
--verification-key-id:: name assigned to the verification key used for bundle verification (Default: default)
Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/ec_opa_check.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ ec opa check <path> [path [...]] [flags]
--rego-v1:: check for Rego v1 compatibility (policies must also be compatible with current OPA version) (Default: false)
-s, --schema:: set schema file path or directory path
-S, --strict:: enable compiler strict mode (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v0-compatible:: opt-in to OPA features and behaviors prior to the OPA v1.0 release. Takes precedence over --v1-compatible (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)

== Options inherited from parent commands

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/ec_opa_deps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ ec opa deps <query> [flags]
-f, --format:: set output format (Default: pretty)
-h, --help:: help for deps (Default: false)
--ignore:: set file and directory names to ignore during loading (e.g., '.*' excludes hidden files) (Default: [])
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)

== Options inherited from parent commands

Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/ec_opa_eval.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,8 @@ ec opa eval <query> [flags]
-t, --target:: set the runtime to exercise (Default: rego)
--timeout:: set eval timeout (default unlimited) (Default: 0s)
-u, --unknowns:: set paths to treat as unknown during partial evaluation (Default: [input])
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v0-compatible:: opt-in to OPA features and behaviors prior to the OPA v1.0 release. Takes precedence over --v1-compatible (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)
--var-values:: show local variable values in pretty trace output (Default: false)

== Options inherited from parent commands
Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/ec_opa_exec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ ec opa exec <path> [<path> [...]] [flags]
--set-file:: override config values with files on the command line (use commas to specify multiple values) (Default: [])
-I, --stdin-input:: read input document from stdin rather than a static file (Default: false)
--timeout:: set exec timeout with a Go-style duration, such as '5m 30s'. (default unlimited) (Default: 0s)
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v0-compatible:: opt-in to OPA features and behaviors prior to the OPA v1.0 release. Takes precedence over --v1-compatible (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)

== Options inherited from parent commands

Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/ec_opa_fmt.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ ec opa fmt [path [...]] [flags]
-h, --help:: help for fmt (Default: false)
-l, --list:: list all files who would change when formatted (Default: false)
--rego-v1:: format module(s) to be compatible with both Rego v1 and current OPA version) (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v0-compatible:: opt-in to OPA features and behaviors prior to the OPA v1.0 release. Takes precedence over --v1-compatible (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)
-w, --write:: overwrite the original source file (Default: false)

== Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/ec_opa_inspect.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ ec opa inspect <path> [<path> [...]] [flags]
-a, --annotations:: list annotations (Default: false)
-f, --format:: set output format (Default: pretty)
-h, --help:: help for inspect (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)

== Options inherited from parent commands

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/ec_opa_parse.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ec opa parse <path> [flags]
-f, --format:: set output format (Default: pretty)
-h, --help:: help for parse (Default: false)
--json-include:: include or exclude optional elements. By default comments are included. Current options: locations, comments. E.g. --json-include locations,-comments will include locations and exclude comments.
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)

== Options inherited from parent commands

Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/ec_opa_run.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,8 @@ ec opa run [flags]
--tls-cipher-suites:: set list of enabled TLS 1.0–1.2 cipher suites (IANA) (Default: [])
--tls-private-key-file:: set path of TLS private key file
--unix-socket-perm:: specify the permissions for the Unix domain socket if used to listen for incoming connections (Default: 755)
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v0-compatible:: opt-in to OPA features and behaviors prior to the OPA v1.0 release. Takes precedence over --v1-compatible (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)
--verification-key:: set the secret (HMAC) or path of the PEM file containing the public key (RSA and ECDSA)
--verification-key-id:: name assigned to the verification key used for bundle verification (Default: default)
-w, --watch:: watch command line files for changes (Default: false)
Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/ec_opa_test.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ ec opa test <path> [path [...]] [flags]
-t, --target:: set the runtime to exercise (Default: rego)
--threshold:: set coverage threshold and exit with non-zero status if coverage is less than threshold % (Default: 0)
--timeout:: set test timeout (default 5s, 30s when benchmarking) (Default: 0s)
--v1-compatible:: opt-in to OPA features and behaviors that will be enabled by default in a future OPA v1.0 release (Default: false)
--v0-compatible:: opt-in to OPA features and behaviors prior to the OPA v1.0 release. Takes precedence over --v1-compatible (Default: false)
--v1-compatible:: opt-in to OPA features and behaviors that are enabled by default in OPA v1.0 (Default: false)
--var-values:: show local variable values in test output (Default: false)
-v, --verbose:: set verbose reporting mode (Default: false)
-w, --watch:: watch command line files for changes (Default: false)
Expand Down

0 comments on commit 337469a

Please sign in to comment.