Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add opa version map to site and version badge to README #2982

Merged
merged 2 commits into from
Aug 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Gatekeeper

![Static Badge](https://img.shields.io/badge/OPA%20Version-v0.54.0-blue)

## How is Gatekeeper different from OPA?

Compared to using [OPA with its sidecar kube-mgmt](https://www.openpolicyagent.org/docs/kubernetes-admission-control.html) (aka Gatekeeper v1.0), Gatekeeper introduces the following functionality:
Expand Down
31 changes: 31 additions & 0 deletions website/docs/opa-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
id: opa-versions
title: OPA Versions
---

Gatekeeper depends on [Open Policy Agent](https://www.openpolicyagent.org/). To see which version of OPA is included in a particular Gatekeeper release, reference the table below.
Copy link
Member

@sozercan sozercan Aug 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for rego-based validation and audit?


| Gatekeeper Version | OPA Version |
| ------------------ | ----------- |
| `v3.13.0` | `v0.54.0` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's the plan/ thinking to automate this 😛 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far that plan is that I want to do it, but don't have much of a plan yet 🙃.

In all seriousness, there do seem to be a couple options for getting this info when releasing. @sozercan and I have discussed some options like the deps.dev API

| `v3.12.0` | `v0.49.2` |
| `v3.11.1` | `v0.47.2` |
| `v3.11.0` | `v0.47.2` |
| `v3.10.0` | `v0.44.0` |
| `v3.9.2` | `v0.44.0` |
| `v3.9.1` | `v0.44.0` |
| `v3.9.0` | `v0.41.0` |
| `v3.8.1` | `v0.39.0` |
| `v3.8.0` | `v0.39.0` |
| `v3.7.2` | `v0.29.4` |
| `v3.7.1` | `v0.29.4` |
| `v3.7.0` | `v0.29.4` |
| `v3.6.0` | `v0.24.0` |
| `v3.5.2` | `v0.24.0` |
| `v3.5.1` | `v0.24.0` |
| `v3.5.0` | `v0.24.0` |
| `v3.4.1` | `v0.24.0` |
| `v3.4.0` | `v0.24.0` |
| `v3.3.0` | `v0.24.0` |
| `v3.2.0` | `v0.19.1` |
| `v3.1.0` | `v0.19.1` |
3 changes: 2 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ module.exports = {
collapsed: false,
items: [
'operations',
'performance-tuning'
'performance-tuning',
'opa-versions'
],
},
{
Expand Down
27 changes: 27 additions & 0 deletions website/versioned_docs/version-v3.10.x/opa-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
id: opa-versions
title: OPA Versions
---

Gatekeeper depends on [Open Policy Agent](https://www.openpolicyagent.org/). To see which version of OPA is included in a particular Gatekeeper release, reference the table below.

| Gatekeeper Version | OPA Version |
| ------------------ | ----------- |
| `v3.10.0` | `v0.44.0` |
| `v3.9.2` | `v0.44.0` |
| `v3.9.1` | `v0.44.0` |
| `v3.9.0` | `v0.41.0` |
| `v3.8.1` | `v0.39.0` |
| `v3.8.0` | `v0.39.0` |
| `v3.7.2` | `v0.29.4` |
| `v3.7.1` | `v0.29.4` |
| `v3.7.0` | `v0.29.4` |
| `v3.6.0` | `v0.24.0` |
| `v3.5.2` | `v0.24.0` |
| `v3.5.1` | `v0.24.0` |
| `v3.5.0` | `v0.24.0` |
| `v3.4.1` | `v0.24.0` |
| `v3.4.0` | `v0.24.0` |
| `v3.3.0` | `v0.24.0` |
| `v3.2.0` | `v0.19.1` |
| `v3.1.0` | `v0.19.1` |
29 changes: 29 additions & 0 deletions website/versioned_docs/version-v3.11.x/opa-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
id: opa-versions
title: OPA Versions
---

Gatekeeper depends on [Open Policy Agent](https://www.openpolicyagent.org/). To see which version of OPA is included in a particular Gatekeeper release, reference the table below.

| Gatekeeper Version | OPA Version |
| ------------------ | ----------- |
| `v3.11.1` | `v0.47.2` |
| `v3.11.0` | `v0.47.2` |
| `v3.10.0` | `v0.44.0` |
| `v3.9.2` | `v0.44.0` |
| `v3.9.1` | `v0.44.0` |
| `v3.9.0` | `v0.41.0` |
| `v3.8.1` | `v0.39.0` |
| `v3.8.0` | `v0.39.0` |
| `v3.7.2` | `v0.29.4` |
| `v3.7.1` | `v0.29.4` |
| `v3.7.0` | `v0.29.4` |
| `v3.6.0` | `v0.24.0` |
| `v3.5.2` | `v0.24.0` |
| `v3.5.1` | `v0.24.0` |
| `v3.5.0` | `v0.24.0` |
| `v3.4.1` | `v0.24.0` |
| `v3.4.0` | `v0.24.0` |
| `v3.3.0` | `v0.24.0` |
| `v3.2.0` | `v0.19.1` |
| `v3.1.0` | `v0.19.1` |
30 changes: 30 additions & 0 deletions website/versioned_docs/version-v3.12.x/opa-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
id: opa-versions
title: OPA Versions
---

Gatekeeper depends on [Open Policy Agent](https://www.openpolicyagent.org/). To see which version of OPA is included in a particular Gatekeeper release, reference the table below.

| Gatekeeper Version | OPA Version |
| ------------------ | ----------- |
| `v3.12.0` | `v0.49.2` |
| `v3.11.1` | `v0.47.2` |
| `v3.11.0` | `v0.47.2` |
| `v3.10.0` | `v0.44.0` |
| `v3.9.2` | `v0.44.0` |
| `v3.9.1` | `v0.44.0` |
| `v3.9.0` | `v0.41.0` |
| `v3.8.1` | `v0.39.0` |
| `v3.8.0` | `v0.39.0` |
| `v3.7.2` | `v0.29.4` |
| `v3.7.1` | `v0.29.4` |
| `v3.7.0` | `v0.29.4` |
| `v3.6.0` | `v0.24.0` |
| `v3.5.2` | `v0.24.0` |
| `v3.5.1` | `v0.24.0` |
| `v3.5.0` | `v0.24.0` |
| `v3.4.1` | `v0.24.0` |
| `v3.4.0` | `v0.24.0` |
| `v3.3.0` | `v0.24.0` |
| `v3.2.0` | `v0.19.1` |
| `v3.1.0` | `v0.19.1` |
31 changes: 31 additions & 0 deletions website/versioned_docs/version-v3.13.x/opa-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
id: opa-versions
title: OPA Versions
---

Gatekeeper depends on [Open Policy Agent](https://www.openpolicyagent.org/). To see which version of OPA is included in a particular Gatekeeper release, reference the table below.

| Gatekeeper Version | OPA Version |
| ------------------ | ----------- |
| `v3.13.0` | `v0.54.0` |
| `v3.12.0` | `v0.49.2` |
| `v3.11.1` | `v0.47.2` |
| `v3.11.0` | `v0.47.2` |
| `v3.10.0` | `v0.44.0` |
| `v3.9.2` | `v0.44.0` |
| `v3.9.1` | `v0.44.0` |
| `v3.9.0` | `v0.41.0` |
| `v3.8.1` | `v0.39.0` |
| `v3.8.0` | `v0.39.0` |
| `v3.7.2` | `v0.29.4` |
| `v3.7.1` | `v0.29.4` |
| `v3.7.0` | `v0.29.4` |
| `v3.6.0` | `v0.24.0` |
| `v3.5.2` | `v0.24.0` |
| `v3.5.1` | `v0.24.0` |
| `v3.5.0` | `v0.24.0` |
| `v3.4.1` | `v0.24.0` |
| `v3.4.0` | `v0.24.0` |
| `v3.3.0` | `v0.24.0` |
| `v3.2.0` | `v0.19.1` |
| `v3.1.0` | `v0.19.1` |
18 changes: 18 additions & 0 deletions website/versioned_docs/version-v3.6.x/opa-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
id: opa-versions
title: OPA Versions
---

Gatekeeper depends on [Open Policy Agent](https://www.openpolicyagent.org/). To see which version of OPA is included in a particular Gatekeeper release, reference the table below.

| Gatekeeper Version | OPA Version |
| ------------------ | ----------- |
| `v3.6.0` | `v0.24.0` |
| `v3.5.2` | `v0.24.0` |
| `v3.5.1` | `v0.24.0` |
| `v3.5.0` | `v0.24.0` |
| `v3.4.1` | `v0.24.0` |
| `v3.4.0` | `v0.24.0` |
| `v3.3.0` | `v0.24.0` |
| `v3.2.0` | `v0.19.1` |
| `v3.1.0` | `v0.19.1` |
21 changes: 21 additions & 0 deletions website/versioned_docs/version-v3.7.x/opa-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
id: opa-versions
title: OPA Versions
---

Gatekeeper depends on [Open Policy Agent](https://www.openpolicyagent.org/). To see which version of OPA is included in a particular Gatekeeper release, reference the table below.

| Gatekeeper Version | OPA Version |
| ------------------ | ----------- |
| `v3.7.2` | `v0.29.4` |
| `v3.7.1` | `v0.29.4` |
| `v3.7.0` | `v0.29.4` |
| `v3.6.0` | `v0.24.0` |
| `v3.5.2` | `v0.24.0` |
| `v3.5.1` | `v0.24.0` |
| `v3.5.0` | `v0.24.0` |
| `v3.4.1` | `v0.24.0` |
| `v3.4.0` | `v0.24.0` |
| `v3.3.0` | `v0.24.0` |
| `v3.2.0` | `v0.19.1` |
| `v3.1.0` | `v0.19.1` |
23 changes: 23 additions & 0 deletions website/versioned_docs/version-v3.8.x/opa-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
id: opa-versions
title: OPA Versions
---

Gatekeeper depends on [Open Policy Agent](https://www.openpolicyagent.org/). To see which version of OPA is included in a particular Gatekeeper release, reference the table below.

| Gatekeeper Version | OPA Version |
| ------------------ | ----------- |
| `v3.8.1` | `v0.39.0` |
| `v3.8.0` | `v0.39.0` |
| `v3.7.2` | `v0.29.4` |
| `v3.7.1` | `v0.29.4` |
| `v3.7.0` | `v0.29.4` |
| `v3.6.0` | `v0.24.0` |
| `v3.5.2` | `v0.24.0` |
| `v3.5.1` | `v0.24.0` |
| `v3.5.0` | `v0.24.0` |
| `v3.4.1` | `v0.24.0` |
| `v3.4.0` | `v0.24.0` |
| `v3.3.0` | `v0.24.0` |
| `v3.2.0` | `v0.19.1` |
| `v3.1.0` | `v0.19.1` |
26 changes: 26 additions & 0 deletions website/versioned_docs/version-v3.9.x/opa-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
id: opa-versions
title: OPA Versions
---

Gatekeeper depends on [Open Policy Agent](https://www.openpolicyagent.org/). To see which version of OPA is included in a particular Gatekeeper release, reference the table below.

| Gatekeeper Version | OPA Version |
| ------------------ | ----------- |
| `v3.9.2` | `v0.44.0` |
| `v3.9.1` | `v0.44.0` |
| `v3.9.0` | `v0.41.0` |
| `v3.8.1` | `v0.39.0` |
| `v3.8.0` | `v0.39.0` |
| `v3.7.2` | `v0.29.4` |
| `v3.7.1` | `v0.29.4` |
| `v3.7.0` | `v0.29.4` |
| `v3.6.0` | `v0.24.0` |
| `v3.5.2` | `v0.24.0` |
| `v3.5.1` | `v0.24.0` |
| `v3.5.0` | `v0.24.0` |
| `v3.4.1` | `v0.24.0` |
| `v3.4.0` | `v0.24.0` |
| `v3.3.0` | `v0.24.0` |
| `v3.2.0` | `v0.19.1` |
| `v3.1.0` | `v0.19.1` |
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.10.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
"collapsed": false,
"items": [
"operations",
"performance-tuning"
"performance-tuning",
"opa-versions"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.11.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
"collapsed": false,
"items": [
"operations",
"performance-tuning"
"performance-tuning",
"opa-versions"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.12.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
"collapsed": false,
"items": [
"operations",
"performance-tuning"
"performance-tuning",
"opa-versions"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.13.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
"collapsed": false,
"items": [
"operations",
"performance-tuning"
"performance-tuning",
"opa-versions"
]
},
{
Expand Down
11 changes: 11 additions & 0 deletions website/versioned_sidebars/version-v3.6.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,17 @@
],
"collapsible": true
},
{
"type": "category",
"label": "Architecture",
"collapsed": false,
"items": [
{
"type": "doc",
"id": "version-v3.6.x/opa-versions"
}
]
},
{
"type": "category",
"label": "Contributing",
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_sidebars/version-v3.7.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,10 @@
{
"type": "doc",
"id": "version-v3.7.x/operations"
},
{
"type": "doc",
"id": "version-v3.7.x/opa-versions"
}
]
},
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.8.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@
"label": "Architecture",
"collapsed": false,
"items": [
"operations"
"operations",
"opa-versions"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.9.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@
"label": "Architecture",
"collapsed": false,
"items": [
"operations"
"operations",
"opa-versions"
]
},
{
Expand Down