Various docs edits

This commit is contained in:
Phil Davis
2023-04-21 15:14:24 +05:45
parent 8025b4220e
commit 982acec95c
14 changed files with 39 additions and 39 deletions
+5 -5
View File
@@ -43,7 +43,7 @@ To activate the policies service for a module, it must be started with a yaml co
When using async post-processing via the postprocessing service, the value `policies` must be added to the `POSTPROCESSING_STEPS` configuration in the order in which the evaluation should take place. Example: First check if a file contains questionable content via policies. If it looks okay, continue to check for viruses.
For configuration examples, the [Example Policies](#example-policies) from below are used.
For configuration examples, the [Example Policies](#example-policies) from below are used.
## Modules
@@ -99,7 +99,7 @@ proxy:
query: data.proxy.granted
```
The same can be achieved by setting the following evironment variable:
The same can be achieved by setting the following environment variable:
```yaml
PROXY_POLICIES_QUERY=data.proxy.granted
@@ -113,13 +113,13 @@ policies:
query: data.postprocessing.granted
```
The same can be achieved by setting the following evironment variable:
The same can be achieved by setting the following environment variable:
```yaml
POLICIES_POSTPROCESSING_QUERY=data.postprocessing.granted
```
As soon as that query is configured, the postprocessing service must be informed to use the policies step by setting the environment variable:
As soon as that query is configured, the postprocessing service must be informed to use the policies step by setting the environment variable:
```yaml
POSTPROCESSING_STEPS=policies
@@ -129,7 +129,7 @@ Note that additional steps can be configured and their position in the list defi
## Rego Key Match
To identify available keys for OPA, you need to look at [engine.go](https://github.com/owncloud/ocis/blob/master/services/policies/pkg/engine/engine.go) and the [policies.swagger.json](https://github.com/owncloud/ocis/blob/master/protogen/gen/ocis/services/policies/v0/policies.swagger.json) file. Note that which keys are avaialble depends from which module it is used.
To identify available keys for OPA, you need to look at [engine.go](https://github.com/owncloud/ocis/blob/master/services/policies/pkg/engine/engine.go) and the [policies.swagger.json](https://github.com/owncloud/ocis/blob/master/protogen/gen/ocis/services/policies/v0/policies.swagger.json) file. Note that which keys are available depends on from which module it is used.
## Example Policies