10000 chore: fix README file with new scripts directory · coder/coder@7660085 · GitHub
[go: up one dir, main page]

Skip to content

Commit 7660085

Browse files
committed
chore: fix README file with new scripts directory
1 parent e49fd2d commit 7660085

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

coderd/rbac/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,9 @@ Authorization Patterns:
149149
- OPA Playground: https://play.openpolicyagent.org/
150150
- OPA CLI (`opa eval`): useful for experimenting with different inputs and understanding how the policy behaves under various conditions.
151151
`opa eval` returns the constraints that must be satisfied for a rule to evaluate to `true`.
152+
- `opa eval` requires an `input.json` file containing the input data to run the policy against.
153+
You can generate this file using the [gen_input.go](../../scripts/rbac-authz/gen_input.go) script.
154+
Note: the script currently produces a fixed input. You may need to tweak it for your specific use case.
152155

153156
### Full Evaluation
154157

@@ -188,7 +191,7 @@ To capture memory and CPU profiles, use the following flags:
188191
- `-memprofile memprofile.out`
189192
- `-cpuprofile cpuprofile.out`
190193

191-
The script [`benchmark_authz.sh`](./scripts/benchmark_authz.sh) runs the `authz` benchmark tests on the current Git branch or compares benchmark results between two branches using [`benchstat`](https://pkg.go.dev/golang.org/x/perf/cmd/benchstat).
194+
The script [`benchmark_authz.sh`](../../scripts/rbac-authz/benchmark_authz.sh) runs the `authz` benchmark tests on the current Git branch or compares benchmark results between two branches using [`benchstat`](https://pkg.go.dev/golang.org/x/perf/cmd/benchstat).
192195
`benchstat` compares the performance of a baseline benchmark against a new benchmark result and highlights any statistically significant differences.
193196

194197
- To run benchmark on the current branch:

0 commit comments

Comments
 (0)
0