Skip to content

Commit

Permalink
docs: Fix bundle configuration example
Browse files Browse the repository at this point in the history
The configuration was using the old 'bundle' key when it should be
using the new 'bundles' key.

Signed-off-by: Torin Sandall <[email protected]>
  • Loading branch information
tsandall committed Aug 6, 2019
1 parent 4033f3d commit 6995cd6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
17 changes: 9 additions & 8 deletions docs/content/bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ services:
bearer:
token: "bGFza2RqZmxha3NkamZsa2Fqc2Rsa2ZqYWtsc2RqZmtramRmYWxkc2tm"

bundle:
bundles:
authz:
service: acmecorp
resource: somedir/bundle.tar.gz
Expand All @@ -69,13 +69,14 @@ https://example.com/service/v1/somedir/bundle.tar.gz
services[0].url resource
```

If the `bundle.resource` field is not defined, the value defaults to `bundles/<name>`
where the `name` is the key value in the configuration. For the example above this is `authz`
and would default to `bundles/authz`.
If the `bundles[_].resource` field is not defined, the value defaults to
`bundles/<name>` where the `name` is the key value in the configuration. For the
example above this is `authz` and would default to `bundles/authz`.

Bundle names can have any valid yaml characters in them, including `/`. This can
be useful when relying on default `resource` behavior with a name like `authz/bundle.tar.gz`
which results in a `resource` of `bundles/authz/bundle.tar.gz`.
Bundle names can have any valid YAML characters in them, including `/`. This can
be useful when relying on default `resource` behavior with a name like
`authz/bundle.tar.gz` which results in a `resource` of
`bundles/authz/bundle.tar.gz`.

See the following section for details on the bundle file format.

Expand Down Expand Up @@ -209,7 +210,7 @@ the Status API.
against other bundles. It is the responsibility of the bundle creator
to ensure the manifest claims roots that are unique to that bundle!
There are *no* ordering guarantees for which bundle loads first and
takes over some root.
takes over some root.

## Debugging Your Bundles

Expand Down
4 changes: 2 additions & 2 deletions docs/content/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -494,8 +494,8 @@ opa run \
--addr=https://localhost:8181 \
--tls-cert-file=/var/tmp/server.crt \
--tls-private-key-file=/var/tmp/server.key \
--set=bundle.service=default \
--set=bundle.name=myapp_authz_bundle \
--set=bundles.authz.service=default \
--set=bundles.authz.resource=myapp_authz_bundle \
--set=services.default.url=https://control.acmecorp.com \
--set-file=services.default.credentials.bearer.token=/var/tmp/secret-bearer-token
```
Expand Down

0 comments on commit 6995cd6

Please sign in to comment.