Skip to content

Commit 338610f

Browse files
dcmiddlefitzthum
authored andcommitted
Cleanup kbs docs
Fix typos and broken links Signed-off-by: Dan Middleton <dmiddleton@nvidia.com>
1 parent e865b87 commit 338610f

4 files changed

Lines changed: 8 additions & 3 deletions

File tree

deps/policy-engine/test_data/policy_5.rego

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ allow if {
1818

1919
data["resource-path"][0] == "myrepo"
2020
data["resource-path"][1] == "secret"
21-
# check that the secret name exists and tht the minimum svn is met
21+
# check that the secret name exists and that the minimum svn is met
2222
resources[data["resource-path"][2]] <= input["submods"]["cpu0"]["ear.veraison.annotated-evidence"]["sample"]["svn"]
2323

2424
}

kbs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,11 @@ The [resource storage backend](./docs/resource_storage_backend.md) where KBS sto
179179
### Config
180180
A custom, [JSON-formatted configuration file](./docs/config.md) can be provided to configure KBS.
181181

182+
### Policies
183+
[Sample policies](./sample_policies/) can be used as a starting point for writing
184+
your own resource policy. Additional example policies used by the policy engine
185+
tests are in [`deps/policy-engine/test_data/`](../deps/policy-engine/test_data/).
186+
182187
### Attestation Token Verification
183188
How KBS verifies attestation tokens, configures trust anchors, and relates AS
184189
token signing to KBS `[attestation_token]` settings is documented in

kbs/docs/resource_storage_backend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,6 @@ echo -n "hello" | gcloud secrets versions add my-test --data-file=-
7575
# the resource kbs:///default/default/my-test
7676
```
7777

78-
### Hashicorp Vault Backend
78+
### HashiCorp Vault / OpenBao Backend
7979

8080
[Vault KV secrets engine backend](./vault_kv.md)

kbs/sample_policies/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
This directory contains sample policy files to configure the policy engine
22
of the KBS. You can use these files to write your own policies.
33

4-
There are also several example policies used [for testing](../test/data).
4+
There are also several example policies used [for testing](../../deps/policy-engine/test_data/).
55

66
| File | Description |
77
| --- | --- |

0 commit comments

Comments
 (0)