diff --git a/Dockerfile b/Dockerfile index 67ddc04c3bbd3ce786f439f0f4a581cfcf003db2..075b1e3941efde99c5a9dab5e141d45f25675057 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,7 +7,7 @@ FROM openpolicyagent/opa:0.22.0 as base FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} LABEL org.opencontainers.image.title="openpolicyagent/opa" \ - org.opencontainers.image.description="The Open Policy Agent (OPA) is an open source project to policy-enable your service." \ + org.opencontainers.image.description="The Open Policy Agent (OPA) is an open source project to policy-enable the service." \ org.opencontainers.image.licenses="Apache-2.0" \ org.opencontainers.image.url="https://github.com/open-policy-agent/opa" \ org.opencontainers.image.version="0.22.0" \ diff --git a/README.md b/README.md index 65e769fbffe66bf1950313c5d6f84c16b80f4736..6aa6456cdeff588fd5dafd7163e4b4f2852fbe87 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,32 @@ -## Introduction to Open Policy Agent(OPA) +## Open Policy Agent(OPA) The Open Policy Agent (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 let’s you specify policy as code and simple APIs to offload policy decision-making from your software. You can use OPA to enforce policies in microservices, Kubernetes, CI/CD pipelines, API gateways, and more. -## OPA Core Documentation +## OPA Documentation References + +### Introduction to OPA -### Introduction - [Overview]https://www.openpolicyagent.org/docs/latest/ - [Deployments]https://www.openpolicyagent.org/docs/latest/deployments/ - [Example]https://www.openpolicyagent.org/docs/latest/#example - [Rego]https://www.openpolicyagent.org/docs/latest/#rego - [Running OPA]https://www.openpolicyagent.org/docs/latest/#running-opa -- [Next Steps]https://www.openpolicyagent.org/docs/latest/#next-steps - -### Philosophy -For more details about OPA Philosophy [Here]https://www.openpolicyagent.org/docs/latest/philosophy/ - -### Policy Language -For more details about Policy Language [Here]https://www.openpolicyagent.org/docs/latest/policy-language/ - -### Policy Reference -For more details about Policy Reference [Here]https://www.openpolicyagent.org/docs/latest/policy-reference/ - -### Policy Testing -For more details about Policy Testing [Here]https://www.openpolicyagent.org/docs/latest/policy-testing/ - -### Policy Performance -For more details about Policy Performance [Here]https://www.openpolicyagent.org/docs/latest/policy-performance/ -### External Data -For more details about External Data [Here]https://www.openpolicyagent.org/docs/latest/external-data/ +### OPA Integrations -### Integrating OPA -For more details about Integrating OPA [Here]https://www.openpolicyagent.org/docs/latest/integration/ +- See [Docker Hub](https://hub.docker.com/r/openpolicyagent/opa/tags/) for Docker images. +- See [GitHub releases](https://github.com/open-policy-agent/opa/releases) for binary releases and changelogs. +- See + [![GoDoc](https://godoc.org/github.com/open-policy-agent/opa?status.svg)](https://godoc.org/github.com/open-policy-agent/opa/rego) + to integrate OPA with services written in Go. +- See [REST API](https://www.openpolicyagent.org/docs/rest-api.html) to + integrate OPA with services written in other languages. -### Extending OPA -For more details about Extending OPA [Here]https://www.openpolicyagent.org/docs/latest/extensions/ +### Additional OPA document references -### REST API -For more details about REST API [Here]https://www.openpolicyagent.org/docs/latest/rest-api/ +- See [openpolicyagent.org](https://www.openpolicyagent.org) to get started with documentation and tutorials. +- See [blog.openpolicyagent.org](https://blog.openpolicyagent.org) for blog posts about OPA and policy. +- See [ADOPTERS.md](./ADOPTERS.md) for a list of production OPA adopters and use cases. +- See [the Roadmap slides](https://docs.google.com/presentation/d/16QV6gvLDOV3I0_guPC3_19g6jHkEg3X9xqMYgtoCKrs/edit?usp=sharing) for a snapshot of high-level OPA features in-progress and planned. +- Try [play.openpolicyagent.org](https://play.openpolicyagent.org) to experiment with OPA policies. +- Join the conversation on [Slack](https://slack.openpolicyagent.org).