From e5e3732d749f565e5be0ef8fe01637e613fd2f28 Mon Sep 17 00:00:00 2001 From: Gabriel Manor Date: Tue, 17 Sep 2024 13:37:59 +0300 Subject: [PATCH] OPAL Updated Readme Proposal --- README.md | 47 ++++++++++++++++++++++++++++++++--------------- 1 file changed, 32 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index cd35f2a50..8a47af596 100644 --- a/README.md +++ b/README.md @@ -36,25 +36,46 @@ Open Policy Administration Layer OPAL is an administration layer for Policy Engines such as Open Policy Agent (OPA), and AWS' Cedar Agent detecting changes to both policy and policy data in realtime and pushing live updates to your agents. OPAL brings open-policy up to the speed needed by live applications. -As your application state changes (whether it's via your APIs, DBs, git, S3 or 3rd-party SaaS services), OPAL will make sure your services are always in sync with the authorization data and policy they need (and only those they need). +As your data state changes (whether it's via your APIs, DBs, git, S3 or 3rd-party SaaS services), OPAL will make sure your services are always in sync with the authorization data and policy they need (and only those they need). -Check out our main site at OPAL.ac, this video briefly explaining OPAL and how it works with OPA, and a deeper dive into it at [this OWASP DevSlop talk](https://www.youtube.com/watch?v=1_Iz0tRQCH4). +Check out OPAL's main site at OPAL.ac -## Why use OPAL? +## OPAL Use Cases OPAL is the easiest way to keep your solution's authorization layer up-to-date in realtime. It aggregates policy and data from across the field and integrates them seamlessly into the authorization layer, and is microservices and cloud-native. -## OPA + OPAL == 💜 +Here are the main use cases of OPAL: +* **End-to-End [Fine-Grained Authorization](https://www.permit.io/blog/what-is-fine-grained-authorization-fga) service** that can be used with any policy language or data store +* [Google-Zanzibar](https://www.permit.io/blog/what-is-google-zanzibar) support for Policy as Code engines such as OPA and AWS Cedar +* Streamline permissions in microservice architectures using [centralized policy configuration with decentralized data](https://www.permit.io/blog/best-practices-for-implementing-hybrid-cloud-security) sources and policy engines +* Manage and automate the deployment of multiple Open Policy Agent engines in a Cloud-Native environment + +simplified + +OPAL uses a client-server stateless architecture. OPAL-Servers publish policy and data updates over a lightweight (websocket) PubSub Channel, which OPAL-clients subscribe to via topics. Upon updates, each client fetches data directly (from the source) to load it into its managed Policy Engine instance. + + +### OPA + OPAL == 💜 While OPA (Open Policy Agent) decouples policy from code in a highly-performant and elegant way, the challenge of keeping policy agents up-to-date remains. This is especially true in applications, where each user interaction or API call may affect access-control decisions. -OPAL runs in the background, supercharging policy-agents, keeping them in sync with events in realtime. +OPAL runs in the background, supercharging policy agents and keeping them in sync with events in real time. -## AWS Cedar + OPAL == 💪 +### AWS Cedar + OPAL == 💪 Cedar is a very powerful policy language, which powers AWS' AVP (Amazon Verified Permissions) - but what if you want to enjoy the power of Cedar on another cloud, locally, or on premise? This is where [Cedar-Agent](https://github.com/permitio/cedar-agent) and OPAL come in. +This [video](https://youtu.be/tG8jrdcc7Zo) briefly explains OPAL and how it works with OPA, and a deeper dive into it at [this OWASP DevSlop talk](https://www.youtube.com/watch?v=1_Iz0tRQCH4). + +## Who's Using OPAL? +OPAL is being used as the core engine of Permit.io Authorization Service and serves in production: +* \> 10,000 policy engines deployment +* \> 100,000 policy changes and data synchronizations every day +* \> 10,000,000 authorization checks every day + +Besides Permit, OPAL is being used in Production in **Tesla**, **Walmart**, **NBA**, **Intel**, **Cisco**, **Credit One**, and 1000s more development teams and companies of any size. + ## Documentation - 📃   [Full documentation is available here](https://docs.opal.ac) @@ -104,22 +125,18 @@ curl -L https://raw.githubusercontent.com/permitio/opal/master/docker/docker-com - 🎨   [Key concepts and design](https://docs.opal.ac/overview/design) - 🏗️   [Architecture](https://docs.opal.ac/overview/architecture) - -
-OPAL uses a client-server stateless architecture. OPAL-Servers publish policy and data updates over a lightweight (websocket) PubSub Channel, which OPAL-clients subscribe to via topics. Upon updates each client fetches data directly (from source) to load it in to its managed OPA instance. -
-simplified
-📖   For further reading check out our [Blog](https://bit.ly/opal_blog). + +📖 For further reading, check out our [Blog](https://io.permit.io/opal-readme-blog) ## Community -Come talk to us about OPAL, or authorization in general - we would love to hear from you ❤️ + We would love to chat with you about OPAL. [Join our Slack community](https://io.permit.io/opal-readme-slack) to chat about authorization, open-source, realtime communication, tech, or anything else! -You can raise questions and ask for features to be added to the road-map in our [**Github discussions**](https://github.com/permitio/opal/discussions), report issues in [**Github issues**](https://github.com/permitio/opal/issues), follow us on Twitter to get the latest OPAL updates, and join our Slack community to chat about authorization, open-source, realtime communication, tech, or anything else! +You can raise questions and ask for features to be added to the road-map in our [**Github discussions**](https://github.com/permitio/opal/discussions), report issues in [**Github issues**](https://github.com/permitio/opal/issues)

-If you are using our project, please consider giving us a ⭐️ +If you like our project, please consider giving us a ⭐️
[![Button][join-slack-link]][badge-slack-link]
[![Button][follow-twitter-link]][badge-twitter-link]