diff --git a/documentation/docs/getting-started/tldr.mdx b/documentation/docs/getting-started/tldr.mdx index e40547e3..b6a98249 100644 --- a/documentation/docs/getting-started/tldr.mdx +++ b/documentation/docs/getting-started/tldr.mdx @@ -11,7 +11,7 @@ The OPAL server sends instructions to the OPAL-clients (via pub/sub subscription OPAL tracks [policies from Git](/tutorials/track_a_git_repo) or from [API bundle servers](/tutorials/track_an_api_bundle_server). With Git - directories with policy-code (e.g. `.rego` or `.cedar` files) are automatically mapped to topics - which a client can subscribe to with `OPAL_POLICY_SUBSCRIPTION_DIRS` -Every time you push a change, OPAL server will notify the subscribing OPAL-clients to load the new policy. +Every time you push a change, the OPAL server will notify the subscribing OPAL-clients to load the new policy. ### Data @@ -19,9 +19,13 @@ OPAL tracks data from various sources via webhooks and [Fetch-Providers](/tutori [Initial data is indicated by the server](getting-started/running-opal/run-opal-server/data-sources) based on `OPAL_DATA_CONFIG_SOURCES`. Subsequent data updates are triggered via [the data update webhook](/tutorials/trigger_data_updates). -Every time the policy agent (or it's managing OPAL-client) restarts data and policy are loaded from scratch. +Every time the policy agent (or it's managing OPAL-client) restarts, the data and policy are loaded from scratch. #### Data as part of policy bundle -Data can also be loaded with the policy as part of `data.json` files in folders next to policy file. -The folder path is used as the key path in the policy engine cache. (Avoid race conditions with regular data updates, by directing data from each to different keys) +Data can also be loaded with the policy as part of `data.json` files, located in the folders next to the policy file. + +:::note +The **folder path** is used as the **key path** in the policy engine cache. +In order to avoid race conditions between policy data updates and regular data updates, make sure the key paths used by your policy-data and the ones used by your data-updates are different. +:::