Commit Graph

1757 Commits

Author SHA1 Message Date
Charlie Egan e00c4b473a docs: Note package repos are community maintained (#8053)
We are not monitoring these for their freshness etc.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-18 15:19:25 +00:00
dependabot[bot] 066ca43b74 build(deps): bump js-yaml from 3.14.1 to 3.14.2 in /docs
Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.14.1 to 3.14.2.
- [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nodeca/js-yaml/compare/3.14.1...3.14.2)

---
updated-dependencies:
- dependency-name: js-yaml
  dependency-version: 3.14.2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-18 09:26:40 +01:00
Stephan Renatus 6904178b3e docs: bump glob dep (CVE-2025-64756)
We're not using the glob CLI at all. But this fixes the trivy scan result.

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-11-18 09:20:26 +01:00
Charlie Egan e395010cd4 docs: Update the policy language intro (#8050)
We had some feedback this was not easy to understand.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-14 08:11:10 +00:00
Charlie Egan ff80b822a3 docs: Improve ground value and assignment docs (#8047)
Fixes https://github.com/open-policy-agent/opa/issues/6025

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-12 15:23:13 +00:00
Charlie Egan 1f7c280304 docs: Address pages with similar titles (#8046)
Fixes https://github.com/open-policy-agent/opa/issues/2244

These new titles should make for more clear search engine results too,
as well as local search.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-12 13:58:13 +00:00
Charlie Egan 9c63119151 website: Improve not found page content (#8042)
Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-12 12:02:27 +00:00
Charlie Egan e081630f93 docs: Update terraform guide with notes about plan (#8043)
Fixes https://github.com/open-policy-agent/opa/issues/2005

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-12 11:10:54 +00:00
Charlie Egan fb8f6c4a4a website: Process feedback form on netlify (#8040)
This new function allows netlify to process the form's notification hook
itself and post to slack without zapier.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-11 11:22:50 +00:00
Eugeniusz Shymko 130adb167d docs/ocp: datasource example uses wrong AWS S3 URL (#8039)
Current url to s3 is broken. Correct form is: https://bucket-name.s3.region-code.amazonaws.com where the s3 comes before the region.

Source official Amazon docs:
https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html

Signed-off-by: Eugene <20545718+SuchSkill@users.noreply.github.com>
2025-11-10 19:41:06 +01:00
Charlie Egan b4d025e7b7 docs/regal: Replicate sidebar fixes (#8036)
See https://github.com/open-policy-agent/regal/pull/1763

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-10 18:05:27 +00:00
Charlie Egan 22e4f50f09 website: Address styling issue in regal logo (#8037)
Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-10 17:54:23 +00:00
Charlie Egan 1b7e7de85a website: Docs versioning (#8038)
Only revert the docs content to the latest release. Retain all other
parts of the site the same.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-10 17:41:26 +00:00
Charlie Egan b1e04b8c5d website: Add bar to show survey link (#8035)
Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-10 17:38:11 +01:00
Charlie Egan 7f8de1047b website/docs: Fix remaining broken links (#8034)
- some were false positives where the react components I had made were
  not working with the checker. (CLI and Builtins refs)
- Others related to pages moved around etc, pages that used to be
  headings and so on.
- also address gtag loading issue by correctly configure via plugin.

From now, a broken anchor is fatal at build time.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-10 16:13:55 +00:00
Charlie Egan ad1c5e71ae website: Use Regal in regal page titles (#8033)
Rather than Open Policy Agent, which was confusing

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-10 12:39:23 +00:00
Charlie Egan 9439e22dd9 docs: Address some broken links (#8022)
Addresses some items from https://github.com/open-policy-agent/opa/issues/8005

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-07 19:14:29 +01:00
Charlie Egan e68a697af8 website: checkout relative to docs dir (#8024)
Missed in https://github.com/open-policy-agent/opa/pull/8023

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-06 14:42:37 +00:00
Charlie Egan 054612935b website: Build prod Regal content from main (#8023)
* website: Build prod Regal content from main

This is because the content for Regal is managed in another repo and so
we must be able to update it without an OPA release.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* docs: Update regal docs from v0.37.0

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

---------

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-06 14:22:50 +00:00
Charlie Egan bdf2ee1044 docs: Update the archive to have an edge link
This is in the admonition at the top but is now included in the archive
page too.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-05 09:48:56 +01:00
Stephan Renatus 2dd86a576f docs: add example for Compile API's table mapping
Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-11-05 09:48:29 +01:00
Charlie Egan 4c31c81a0f website: Remove unused lunr dependency
https://app.netlify.com/projects/openpolicyagent/deploys/6908b1fae94d6a0007407fd6

Addresses these two issues:

1:45:52 PM: npm warn deprecated mkdirp@0.3.0: Legacy versions of mkdirp are no longer supported. Please update to mkdirp 1.x. (Note that the API surface has changed to use Promises in 1.x.)
1:45:52 PM: npm warn deprecated gauge@3.0.2: This package is no longer supported.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-11-04 07:21:33 +01:00
Johan Fylling fb4b7d9554 docs: Moving CLI Reference to Operations in TOC (#8001)
Signed-off-by: Johan Fylling <johan.dev@fylling.se>
2025-10-30 11:11:20 +01:00
Charlie Egan c7746a0612 docs: Address some broken anchors (#8000)
Some are runtime generated in the report and so are false positives. But
there are still others that need to be addressed, this is just the easy
ones.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-10-30 11:04:48 +01:00
Charlie Egan 4aa4554f8e website: Fix build issues (#7999)
There are some build issues related to a new netlify base image.

https://app.netlify.com/projects/openpolicyagent/deploys/69020ac6a2fe410008c643de

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-10-29 15:21:03 +00:00
Stephan Renatus 9a864c6398 compile: add support for "any value at all", as IS NOT NULL (#7998)
* compile: support "equal to whatever" as "IS NOT NULL"

Fixes https://github.com/open-policy-agent/opa/issues/7996.

This only deals with SQL targets for starters.

This issue also came out of the discussion with @huntkalio.

* compile: expand support for "_ = <unknown>" to prisma

It seems like the translation is pretty straightforward here, so
let's include it.

Reference: https://www.prisma.io/docs/orm/prisma-client/queries/filtering-and-sorting#filter-for-non-null-fields

* docs/compile: mention fragment addition

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-10-29 13:38:28 +01:00
Charlie Egan 087f942f25 docs: Update based on slack feedback (#7990)
* docs: Update policy-reference page with intro

I hope this addresses some of the pain shared in:
https://openpolicyagent.slack.com/archives/C08V59T3NAF/p1761232592164519

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* docs: Revise server, net, port diagram

We had some valid feedback that this was disjointed with the following
text.

https://openpolicyagent.slack.com/archives/C08V59T3NAF/p1761298015276409

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* docs: Correct typo in keyword link

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

---------

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-10-29 10:58:16 +00:00
Stephan Renatus ef9c6303fb docs/devel: update for removed vendor/
Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-10-16 10:44:33 +02:00
Stephan Renatus f2f3c265fb docs/index: update some download instructions (re: arm64 <-> static)
While the static binaries will not go away, let's steer people towards
the binaries with less confusing names, now that we (are going to) have
them.

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-10-16 10:34:05 +02:00
Stephan Renatus f21be61a91 docs/ocp/deployment: add segment on database migrations (#7952)
This has landed: https://github.com/open-policy-agent/opa-control-plane/pull/108.

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-10-13 13:13:21 +02:00
Joel Coenraadts 81535fa4cf Adds ecosystem project Moat (#7963)
* Adds ecosystem project Moat

Moat is an OPA control plane project specifically for managing access to data. The
first target system is Trino, with many future target systems including those which
do not directly support OPA.

Signed-off-by: jcoenraadts <joel@bytelab.com>

* Changes reserved name "OPA Control Plane"  to "Data Control Plane"

This change is to avoid confusion with the officially released OPA Control Plane

Signed-off-by: jcoenraadts <joel@bytelab.com>

---------

Signed-off-by: jcoenraadts <joel@bytelab.com>
Co-authored-by: jcoenraadts <joel@bytelab.com>
2025-10-06 13:37:31 +00:00
Igor Rodzik e8fd2baa33 Correct in OCP docs information regarding supported datasources
In previous version of the docs, S3 and git were listed as separate,
supported types of datasources, which was unclear. Added changes state that there
is only one type supported, extend example how to use it and add link
to Secrets section.

Signed-off-by: Igor Rodzik <igor.rodzik@gmail.com>
2025-10-06 14:17:26 +02:00
Michael Grosser e048c1984d add opa test --fail-on-empty to allow making bad -r or empty folders fail (#7960)
Signed-off-by: Michael Grosser <michael@grosser.it>
2025-10-03 16:12:05 +02:00
Stephan Renatus 7eae60ded3 docs: OCP HTTP API updates (#7951)
* docs/ocp: add DELETE to API reference

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>

* docs/ocp: add /v1/secrets HTTP docs

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>

---------

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-10-01 17:29:31 +02:00
Charlie Egan fbc4b4fdcf website: FOUC squashing on the homepage
https://en.wikipedia.org/wiki/Flash_of_unstyled_content

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-10-01 10:42:31 +02:00
Charlie Egan 9834088aea website: Update docusaurus
This needed a few other dependency edits/additions and updates to file loading
too.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-10-01 10:41:36 +02:00
Charlie Egan 6d0b581ebb docs: Update link checker config (#7949)
We have a lot of false positives in
https://github.com/open-policy-agent/opa/issues/7888, this ignores some
domains that appear to block the scanning tool as `ERROR`.

Fixes https://github.com/open-policy-agent/opa/issues/7888

https://github.com/open-policy-agent/regal/pull/1704 fixes a number of
others found in the Regal docs.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-10-01 08:38:21 +00:00
Stephan Renatus 8a2afe88b5 docs: add Compile API data filtering docs (#7939)
* docs/policy-performance: remove "n/a" in "Reason", add naked ref

Upon reading this again, I found it confusing. I think it's slightly
less so now.

Also adds a row for the lonely statements supported in the next release.

* docs: integrate data filtering docs

This is everything we've had in EOPA, with updated cross-references,
updated annotations (custom -> compile) and headers.

This is work done in another repository, so I'll collect co-authors on
this commit message's trailers.

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
Co-authored-by: Philip Conrad <philip@chariot-chaser.net>
Co-authored-by: Chris Hendrix <chendrix@users.noreply.github.com>
2025-10-01 09:43:43 +02:00
Charlie Egan 2d1faeb620 docs: remove k8s primer line numbers comments (#7946)
https://openpolicyagent.slack.com/archives/C08V59T3NAF/p1759159399901459

The feedback is positive, but I thought we could make it clearer and get
rid of the line numbers in comments.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-09-30 10:24:26 +01:00
Charlie Egan 768a95c031 docs: Add some more detail to the AI guidelines (#7945)
Some ideas from the team, some from myself and the rest from these
resources here:

* https://github.com/open-telemetry/community/blob/main/policies/genai.md
* https://www.linuxfoundation.org/legal/generative-ai

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-09-29 16:36:18 +01:00
Stephan Renatus 85a0e2a28c Compile API: switch to compile annotation key (#7936)
* ast: add compile annotation key

This used to be

```
  custom:
    unknowns: [ ... ]
    mask_rule: ...
```

and now becomes
```
  compile:
    unknowns: [ ... ]
    mask_rule: ...
```

* server: adapt compile handler annotations processing

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-09-24 10:53:17 +02:00
Charlie Egan 162edffed0 docs: Add Style Guide to policy authoring docs (#7932)
Based on changes in https://github.com/open-policy-agent/rego-style-guide/pull/40

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-09-23 17:45:36 +02:00
Charlie Egan 008c9da55f docs: Update references to cheat sheet and awesome-opa (#7930)
This also adds the cheat sheet to the docs site

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2025-09-23 16:00:15 +01:00
Dmitrijs Minajevs f8fb507361 docs/ocp: Update docs on Azure object storage (#7921)
Signed-off-by: Dmitrijs Minajevs <dmitrijs.minajevs@if.lv>
2025-09-22 14:50:40 +00:00
Stephan Renatus 3d2b936c4a docs/rest-api: add basic Compile API docs (#7922)
We have more extensive docs to port over, but this isn't the right place
for those. So let's get these in first.

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
Co-authored-by: Charlie Egan <git@charlieegan3.com>
2025-09-22 15:12:27 +02:00
Stephan Renatus 885a5b4a56 docs/ocp: fix inline-transform example (#7913)
The previous rego policy snippet wasn't valid. It's got to be a query,
either referencing a rule defined in one of the sources, or an inline
query like in the updated example.

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-09-22 12:54:23 +00:00
Charlie Le 5816e4f4f8 Update Envoy tutorial for new versions and images
I wasn't able to find an arm64 variant of docker.io/openpolicyagent/opa:latest-envoy, but I was able to find it for docker.io/openpolicyagent/opa:latest-envoy-static.

I was able to go through this tutorial with a newer version of kind, so I thought I'd update that version, too.

Signed-off-by: Charlie Le <charlie_le@apple.com>
2025-09-20 20:39:00 +02:00
Ashutosh Narkar 3a314c611e docs: Update OCP install instructions
Signed-off-by: Ashutosh Narkar <anarkar4387@gmail.com>
2025-09-20 08:29:51 +02:00
Stephan Renatus cb9764160d docs/ocp: update API reference (#7906)
These names were added in
https://github.com/open-policy-agent/opa-control-plane/pull/71

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-09-18 08:58:35 +00:00
Stephan Renatus 206ca63bc8 docs/ocp: fix wrong example on concepts page (#7907)
Fixes https://github.com/open-policy-agent/opa-control-plane/issues/73.

Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2025-09-18 09:54:27 +01:00