Skip to content

Commit

Permalink
Change template annotation to use k8s-style casing
Browse files Browse the repository at this point in the history 
In open-policy-agent/gatekeeper#2734 (comment)
the decision was made to change the sync data anotation casing from
`requiresSyncData` to `requires-sync-data`.  This better fits k8s
standards.

This PR updates gatekeeper-library templates with the new annotation
key.

Signed-off-by: juliankatz <juliankatz@google.com>
  • Loading branch information
@julianKatz
julianKatz committed Jun 8, 2023
1 parent 62f5520 commit d23e8ea
Show file tree
Hide file tree
Showing 24 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion artifacthub/library/general/horizontalpodautoscaler/1.0.0/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Horizontal Pod Autoscaler"
metadata.gatekeeper.sh/version: 1.0.0
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion artifacthub/library/general/poddisruptionbudget/1.0.1/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Pod Disruption Budget"
metadata.gatekeeper.sh/version: 1.0.1
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion artifacthub/library/general/poddisruptionbudget/1.0.2/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Pod Disruption Budget"
metadata.gatekeeper.sh/version: 1.0.2
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion artifacthub/library/general/storageclass/1.0.1/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Storage Class"
metadata.gatekeeper.sh/version: 1.0.1
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion artifacthub/library/general/storageclass/1.1.0/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Storage Class"
metadata.gatekeeper.sh/version: 1.1.0
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion artifacthub/library/general/uniqueingresshost/1.0.1/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Unique Ingress Host"
metadata.gatekeeper.sh/version: 1.0.1
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion artifacthub/library/general/uniqueingresshost/1.0.2/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Unique Ingress Host"
metadata.gatekeeper.sh/version: 1.0.2
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion artifacthub/library/general/uniqueserviceselector/1.0.1/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Unique Service Selector"
metadata.gatekeeper.sh/version: 1.0.1
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion library/general/horizontalpodautoscaler/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Horizontal Pod Autoscaler"
metadata.gatekeeper.sh/version: 1.0.0
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion library/general/poddisruptionbudget/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Pod Disruption Budget"
metadata.gatekeeper.sh/version: 1.0.2
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion library/general/storageclass/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Storage Class"
metadata.gatekeeper.sh/version: 1.1.0
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion library/general/uniqueingresshost/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Unique Ingress Host"
metadata.gatekeeper.sh/version: 1.0.2
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion library/general/uniqueserviceselector/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Unique Service Selector"
metadata.gatekeeper.sh/version: 1.0.1
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion scripts/require-sync/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
"k8s.io/utils/strings/slices"
)

const syncAnnotation string = "metadata.gatekeeper.sh/requiresSyncData"
const syncAnnotation string = "metadata.gatekeeper.sh/requires-sync-data"

var (
pathFlag = flag.String("path", "", "Path to verify referential templates include sync data.")
Expand Down
2 changes: 1 addition & 1 deletion src/general/horizontalpodautoscaler/constraint.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Horizontal Pod Autoscaler"
metadata.gatekeeper.sh/version: 1.0.0
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion src/general/poddisruptionbudget/constraint.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Pod Disruption Budget"
metadata.gatekeeper.sh/version: 1.0.2
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion src/general/storageclass/constraint.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Storage Class"
metadata.gatekeeper.sh/version: 1.1.0
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion src/general/uniqueingresshost/constraint.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Unique Ingress Host"
metadata.gatekeeper.sh/version: 1.0.2
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
2 changes: 1 addition & 1 deletion src/general/uniqueserviceselector/constraint.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Unique Service Selector"
metadata.gatekeeper.sh/version: 1.0.1
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down
4 changes: 2 additions & 2 deletions website/docs/validation/horizontalpodautoscaler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Horizontal Pod Autoscaler"
metadata.gatekeeper.sh/version: 1.0.0
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down Expand Up @@ -288,4 +288,4 @@ kubectl apply -f https://raw.githubusercontent.com/open-policy-agent/gatekeeper-
</details>
</blockquote></details>
</blockquote></details>
4 changes: 2 additions & 2 deletions website/docs/validation/poddisruptionbudget.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Pod Disruption Budget"
metadata.gatekeeper.sh/version: 1.0.2
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down Expand Up @@ -380,4 +380,4 @@ kubectl apply -f https://raw.githubusercontent.com/open-policy-agent/gatekeeper-
</details>
</blockquote></details>
</blockquote></details>
4 changes: 2 additions & 2 deletions website/docs/validation/storageclass.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Storage Class"
metadata.gatekeeper.sh/version: 1.1.0
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down Expand Up @@ -502,4 +502,4 @@ kubectl apply -f https://raw.githubusercontent.com/open-policy-agent/gatekeeper-
</details>
</blockquote></details>
</blockquote></details>
4 changes: 2 additions & 2 deletions website/docs/validation/uniqueingresshost.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Unique Ingress Host"
metadata.gatekeeper.sh/version: 1.0.2
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down Expand Up @@ -213,4 +213,4 @@ kubectl apply -f https://raw.githubusercontent.com/open-policy-agent/gatekeeper-
</details>
</blockquote></details>
</blockquote></details>
4 changes: 2 additions & 2 deletions website/docs/validation/uniqueserviceselector.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ metadata:
annotations:
metadata.gatekeeper.sh/title: "Unique Service Selector"
metadata.gatekeeper.sh/version: 1.0.1
metadata.gatekeeper.sh/requiresSyncData: |
metadata.gatekeeper.sh/requires-sync-data: |
"[
[
{
Expand Down Expand Up @@ -162,4 +162,4 @@ kubectl apply -f https://raw.githubusercontent.com/open-policy-agent/gatekeeper-
</details>
</blockquote></details>
</blockquote></details>

0 comments on commit d23e8ea

Please sign in to comment.