Skip to content

Commit 83cee4a

Browse files
committed
update docs
1 parent 5400fa9 commit 83cee4a

File tree

8 files changed

+23
-20
lines changed

8 files changed

+23
-20
lines changed

docs/modules/ROOT/pages/ec_opa_bench.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Example with bundle and input data:
1414
opa bench -b ./policy-bundle -i input.json 'data.authz.allow'
1515

1616
To run benchmarks against a running OPA server to evaluate server overhead use the --e2e flag.
17+
To enable more detailed analysis use the --metrics and --benchmem flags.
1718

1819
The optional "gobench" output format conforms to the Go Benchmark Data Format.
1920

docs/modules/ROOT/pages/ec_opa_build.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,14 @@ The 'build' command supports targets (specified by -t):
6464
original policy or data files.
6565
6666
plan The plan target emits a bundle containing a plan, i.e., an intermediate
67-
representation compiled from the input files for each specified entrypoint.
68-
This is for further processing, OPA cannot evaluate a "plan bundle" like it
69-
can evaluate a wasm or rego bundle.
67+
representation compiled from the input files for each specified entrypoint.
68+
This is for further processing, OPA cannot evaluate a "plan bundle" like it
69+
can evaluate a wasm or rego bundle.
7070
71-
The -e flag tells the 'build' command which documents (entrypoints) will be queried by
72-
the software asking for policy decisions, so that it can focus optimization efforts and
71+
The -e flag tells the 'build' command which documents (entrypoints) will be queried by
72+
the software asking for policy decisions, so that it can focus optimization efforts and
7373
ensure that document is not eliminated by the optimizer.
74-
Note: Unless the --prune-unused flag is used, any rule transitively referring to a
74+
Note: Unless the --prune-unused flag is used, any rule transitively referring to a
7575
package or rule declared as an entrypoint will also be enumerated as an entrypoint.
7676
7777
Signing

docs/modules/ROOT/pages/ec_opa_exec.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ After: Decision Logs
2121
By default, the 'exec' command executes the "default decision" (specified in
2222
the OPA configuration) against each input file. This can be overridden by
2323
specifying the --decision argument and pointing at a specific policy decision,
24+
2425
e.g., opa exec --decision /foo/bar/baz ...
2526

2627
[source,shell]
@@ -30,15 +31,15 @@ ec opa exec <path> [<path> [...]] [flags]
3031

3132
== Examples
3233
Loading input from stdin:
33-
documentation exec [<path> [...]] --stdin-input [flags]
34+
opa exec [<path> [...]] --stdin-input [flags]
3435

3536
== Options
3637

3738
-b, --bundle:: set bundle file(s) or directory path(s). This flag can be repeated.
3839
-c, --config-file:: set path of configuration file
3940
--decision:: set decision to evaluate
40-
--fail:: exits with non-zero exit code on undefined result and errors (Default: false)
41-
--fail-defined:: exits with non-zero exit code on defined result and errors (Default: false)
41+
--fail:: exits with non-zero exit code on undefined/empty result and errors (Default: false)
42+
--fail-defined:: exits with non-zero exit code on defined/non-empty result and errors (Default: false)
4243
--fail-non-empty:: exits with non-zero exit code on non-empty result and errors (Default: false)
4344
-f, --format:: set output format (Default: json)
4445
-h, --help:: help for exec (Default: false)

docs/modules/ROOT/pages/ec_opa_inspect.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
= ec opa inspect
22

3-
Inspect OPA bundle(s) or Rego files.
3+
Inspect OPA bundle(s)
44

55
== Synopsis
66

7-
Inspect OPA bundle(s) or Rego files.
7+
Inspect OPA bundle(s).
88

9-
The 'inspect' command provides a summary of the contents in OPA bundle(s) or a single Rego file. Bundles are
10-
gzipped tarballs containing policies and data. The 'inspect' command reads bundle(s) and lists
9+
The 'inspect' command provides a summary of the contents in OPA bundle(s) or a single Rego file.
10+
Bundles are gzipped tarballs containing policies and data. The 'inspect' command reads bundle(s) and lists
1111
the following:
1212

1313
* packages that are contributed by .rego files
@@ -23,10 +23,10 @@ Example:
2323
bundle.tar.gz
2424
$ opa inspect bundle.tar.gz
2525

26-
You can provide exactly one OPA bundle, path to a bundle directory, or direct path to a Rego file to the 'inspect' command
27-
on the command-line. If you provide a path referring to a directory, the 'inspect' command will load that path as a bundle
28-
and summarize its structure and contents. If you provide a path referring to a Rego file, the 'inspect' command will load
29-
that file and summarize its structure and contents.
26+
You can provide exactly one OPA bundle, to a bundle directory, or direct path to a Rego file to the 'inspect'
27+
command on the command-line. If you provide a path referring to a directory, the 'inspect' command will load that path as
28+
a bundle and summarize its structure and contents. If you provide a path referring to a Rego file, the 'inspect' command
29+
will load that file and summarize its structure and contents.
3030

3131
[source,shell]
3232
----

docs/modules/ROOT/pages/ec_opa_run.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Start OPA in interactive or server mode
44

55
== Synopsis
66

7-
Start an instance of the Open Policy Agent (OPA).
7+
Start an instance of OPA.
88

99
To run the interactive shell:
1010

docs/modules/ROOT/pages/ec_opa_test.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ If used with the '--bench' option then tests will be benchmarked.
6565

6666
Example benchmark run:
6767

68-
$ opa test --bench ./example/
68+
$ opa test --bench ./example/
6969

7070
The optional "gobench" output format conforms to the Go Benchmark Data Format.
7171

docs/modules/ROOT/pages/ec_sigstore_initialize.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ ec initialize -mirror <url> -root <url>
4242
-h, --help:: help for initialize (Default: false)
4343
--mirror:: GCS bucket to a SigStore TUF repository, or HTTP(S) base URL, or file:/// for local filestore remote (air-gap) (Default: https://tuf-repo-cdn.sigstore.dev)
4444
--root:: path to trusted initial root. defaults to embedded root
45+
--root-checksum:: checksum of the initial root, required if root is downloaded via http(s). expects sha256 by default, can be changed to sha512 by providing sha512:<checksum>
4546

4647
== Options inherited from parent commands
4748

features/__snapshots__/opa.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Available Commands:
1414
eval Evaluate a Rego query
1515
exec Execute against input files
1616
fmt Format Rego source files
17-
inspect Inspect OPA bundle(s) or Rego files.
17+
inspect Inspect OPA bundle(s)
1818
parse Parse Rego source file
1919
run Start OPA in interactive or server mode
2020
sign Generate an OPA bundle signature

0 commit comments

Comments
 (0)