Skip to content
Snippets Groups Projects
Commit 116d0b88 authored by Shane Hutchins's avatar Shane Hutchins
Browse files

Merge branch 'minordocupdate' into 'master'

minor documentation updates

See merge request !480
parents 98ff746f a34d1473
No related branches found
No related tags found
1 merge request!480minor documentation updates
Checking pipeline status
...@@ -7,6 +7,7 @@ ...@@ -7,6 +7,7 @@
The [Open Policy Agent](https://www.openpolicyagent.org) (OPA, pronounced “oh-pa”) is an open source, general-purpose policy engine that unifies policy enforcement across the stack. OPA provides a high-level declarative language that lets you specify policy as code and simple APIs to offload policy decision-making from your software. The [Open Policy Agent](https://www.openpolicyagent.org) (OPA, pronounced “oh-pa”) is an open source, general-purpose policy engine that unifies policy enforcement across the stack. OPA provides a high-level declarative language that lets you specify policy as code and simple APIs to offload policy decision-making from your software.
- For recommended versions please see [OPA Versions](./opa.md#opa-required-and-recommended-versions) - For recommended versions please see [OPA Versions](./opa.md#opa-required-and-recommended-versions)
- For recommended sizing please see [OPA Sizing](./sizing.md#opa-sizing)
- OPA must be configured to poll for new policies in [example init.yaml)(https://community.opengroup.org/osdu/platform/security-and-compliance/policy/-/blob/master/app/tests/gc_init.yaml). - OPA must be configured to poll for new policies in [example init.yaml)(https://community.opengroup.org/osdu/platform/security-and-compliance/policy/-/blob/master/app/tests/gc_init.yaml).
- For testing purposes a low polling is probably best. - For testing purposes a low polling is probably best.
- OPA must also be bootstrapped with an initial bundle for instance and data partition. [example](https://community.opengroup.org/osdu/platform/security-and-compliance/policy/-/blob/master/app/tests/gc_bootstrap_policy.sh) - OPA must also be bootstrapped with an initial bundle for instance and data partition. [example](https://community.opengroup.org/osdu/platform/security-and-compliance/policy/-/blob/master/app/tests/gc_bootstrap_policy.sh)
...@@ -23,13 +24,13 @@ Some of the options for starting OPA include: ...@@ -23,13 +24,13 @@ Some of the options for starting OPA include:
### Entitlement Service ### Entitlement Service
Entitlement service is assumed to be not available for unit tests, however it is required to support integration tests. With headers authorizations (Bearer Token) and data_partition_id, this service is used to determine which groups the request is associated with. [Entitlement service](https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements/-/tree/master/docs?ref_type=heads) is assumed to be not available for unit tests, however it is required to support integration tests. With headers authorizations (Bearer Token) and data_partition_id, this service is used to determine which groups the request is associated with.
The user must be a part of `conf.USER_PERMISION` (service.policy.user by default) or `conf.ADMIN_PERMISION` (service.policy.admin by default) for that particular OSDU data partition or testing will fail. Entitlement can also be bypassed for testing purposes by enabling `conf.MOCK_ENTITLEMENT` The user must be a part of `conf.USER_PERMISION` (service.policy.user by default) or `conf.ADMIN_PERMISION` (service.policy.admin by default) for that particular OSDU data partition or testing will fail. Entitlement can also be bypassed for testing purposes by enabling `conf.MOCK_ENTITLEMENT`
### Legal Service ### Legal Service
Legal service is needed to run some integration tests (directly to get legal tags and indirectly when expecting OPA to talk to legal service). However legal is not directly used by the policy-service. However policies should make OPA call the legal service. [Legal service](https://osdu.pages.opengroup.org/platform/security-and-compliance/legal/) is needed to run some integration tests (directly to get legal tags and indirectly when expecting OPA to talk to legal service). However legal is not directly used by the policy-service. However policies should make OPA call the legal service.
### CLOUD_PROVIDER ### CLOUD_PROVIDER
......
# Release Notes for Policy Service # Release Notes for Policy Service
## M24 Release 0.27
Policy Service v0.27.0 2024/07
### M24 Minor Changes
### M24 Bug Fixes
### M24 Features
## M23 Release 0.26 ## M23 Release 0.26
Policy Service v0.26.0 2024/03 Policy Service v0.26.0 2024/04
### M23 Minor Changes ### M23 Minor Changes
- Version numbers have changed to conform with OSDU [126](https://community.opengroup.org/osdu/platform/security-and-compliance/policy/-/issues/126) - Version numbers have changed to conform with OSDU [126](https://community.opengroup.org/osdu/platform/security-and-compliance/policy/-/issues/126). API reports version 1.0.0
### M23 Bug Fixes ### M23 Bug Fixes
- Upgraded FastAPI to 0.109.2 for security fixes [CVE-2024-24762](https://nvd.nist.gov/vuln/detail/CVE-2024-24762) - Upgraded FastAPI to 0.109.2 for security fixes [CVE-2024-24762](https://nvd.nist.gov/vuln/detail/CVE-2024-24762)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment