Skip to content

Commit

Permalink
fix: support source field in Constraints (#2552)
Browse files Browse the repository at this point in the history
Signed-off-by: davis-haba <davishaba@google.com>
Co-authored-by: Rita Zhang <rita.z.zhang@gmail.com>
  • Loading branch information
davis-haba and ritazh authored Mar 22, 2023
1 parent 3bc8b22 commit df9a9d9
Show file tree
Hide file tree
Showing 17 changed files with 622 additions and 190 deletions.
2 changes: 2 additions & 0 deletions .golangci.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
run:
timeout: 5m
skip-files:
- pkg/target/matchcrd_constant.go

linters-settings:
gocritic:
Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,7 @@ manifests: __controller-gen
paths="./apis/..." \
paths="./pkg/..." \
output:crd:artifacts:config=config/crd/bases
./build/update-match-schema.sh
rm -rf manifest_staging
mkdir -p manifest_staging/deploy/experimental
mkdir -p manifest_staging/charts/gatekeeper
Expand Down
21 changes: 21 additions & 0 deletions build/update-match-schema.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# This script builds a golang string constant containing the YAML code for the
# Match CRD. This is needed to auto generate the JSONSchemaProps for Match. It
# will parse the YAML for the Match CRD, found in $CRD_FILE, and output to
# $GO_FILE.

GO_FILE="./pkg/target/matchcrd_constant.go"
SRC_FILE="./pkg/mutation/match/match_types.go"
CRD_FILE="./config/crd/bases/match.gatekeeper.sh_matchcrd.yaml"

cat << EOF > ${GO_FILE}
package target
// DO NOT MODIFY THIS FILE DIRECTLY!
// This file is generated from $SRC_FILE via "make manifests".
const matchYAML = \`
EOF

# Escape backticks in the yaml, add terminating backtick
cat ${CRD_FILE} | sed "s/\`/\`+\"\`\"+\`/g" >> ${GO_FILE}
echo "\`" >> ${GO_FILE}
209 changes: 209 additions & 0 deletions config/crd/bases/match.gatekeeper.sh_matchcrd.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,209 @@
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.10.0
creationTimestamp: null
name: matchcrd.match.gatekeeper.sh
spec:
group: match.gatekeeper.sh
names:
kind: DummyCRD
listKind: DummyCRDList
plural: matchcrd
singular: dummycrd
scope: Namespaced
versions:
- name: match
schema:
openAPIV3Schema:
description: DummyCRD is a "dummy" CRD to hold the Match object, which we
ultimately need to generate JSONSchemaProps. The TypeMeta and ObjectMeta
fields are required for controller-gen to generate the CRD.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
embeddedMatch:
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names. If
defined, a constraint only applies to resources not in a listed
namespace. ExcludedNamespaces also supports a prefix or suffix based
glob. For example, `excludedNamespaces: [kube-*]` matches both
`kube-system` and `kube-public`, and `excludedNamespaces: [*-system]`
matches both `kube-system` and `gatekeeper-system`.'
items:
description: 'A string that supports globbing at its front or end.
Ex: "kube-*" will match "kube-system" or "kube-public", "*-system"
will match "kube-system" or "gatekeeper-system". The asterisk
is required for wildcard matching.'
pattern: ^(\*|\*-)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\*|-\*)?$
type: string
type: array
kinds:
items:
description: Kinds accepts a list of objects with apiGroups and
kinds fields that list the groups/kinds of objects to which the
mutation will apply. If multiple groups/kinds objects are specified,
only one match is needed for the resource to be in scope.
properties:
apiGroups:
description: APIGroups is the API groups the resources belong
to. '*' is all groups. If '*' is present, the length of the
slice must be one. Required.
items:
type: string
type: array
kinds:
items:
type: string
type: array
type: object
type: array
labelSelector:
description: 'LabelSelector is the combination of two optional fields:
`matchLabels` and `matchExpressions`. These two fields provide
different methods of selecting or excluding k8s objects based on
the label keys and values included in object metadata. All selection
expressions from both sections are ANDed to determine if an object
meets the cumulative requirements of the selector.'
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: A label selector requirement is a selector that
contains values, a key, and an operator that relates the key
and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: operator represents a key's relationship to
a set of values. Valid operators are In, NotIn, Exists
and DoesNotExist.
type: string
values:
description: values is an array of string values. If the
operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values
array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator
is "In", and the values array contains only "value". The requirements
are ANDed.
type: object
type: object
name:
description: 'Name is the name of an object. If defined, it will
match against objects with the specified name. Name also supports
a prefix or suffix glob. For example, `name: pod-*` would match
both `pod-a` and `pod-b`, and `name: *-pod` would match both `a-pod`
and `b-pod`.'
pattern: ^(\*|\*-)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\*|-\*)?$
type: string
namespaceSelector:
description: NamespaceSelector is a label selector against an object's
containing namespace or the object itself, if the object is a namespace.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: A label selector requirement is a selector that
contains values, a key, and an operator that relates the key
and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: operator represents a key's relationship to
a set of values. Valid operators are In, NotIn, Exists
and DoesNotExist.
type: string
values:
description: values is an array of string values. If the
operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values
array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator
is "In", and the values array contains only "value". The requirements
are ANDed.
type: object
type: object
namespaces:
description: 'Namespaces is a list of namespace names. If defined,
a constraint only applies to resources in a listed namespace. Namespaces
also supports a prefix or suffix based glob. For example, `namespaces:
[kube-*]` matches both `kube-system` and `kube-public`, and `namespaces:
[*-system]` matches both `kube-system` and `gatekeeper-system`.'
items:
description: 'A string that supports globbing at its front or end.
Ex: "kube-*" will match "kube-system" or "kube-public", "*-system"
will match "kube-system" or "gatekeeper-system". The asterisk
is required for wildcard matching.'
pattern: ^(\*|\*-)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\*|-\*)?$
type: string
type: array
scope:
description: Scope determines if cluster-scoped and/or namespaced-scoped
resources are matched. Accepts `*`, `Cluster`, or `Namespaced`.
(defaults to `*`)
type: string
source:
description: Source determines whether generated or original resources
are matched. Accepts `Generated`|`Original`|`All` (defaults to `All`).
A value of `Generated` will only match generated resources, while
`Original` will only match regular resources.
enum:
- All
- Generated
- Original
type: string
type: object
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadataDummy:
type: object
type: object
served: true
storage: true
6 changes: 3 additions & 3 deletions config/crd/bases/mutations.gatekeeper.sh_assignmetadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ spec:
location:
type: string
match:
description: Match selects objects to apply mutations to.
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names.
Expand Down Expand Up @@ -337,7 +337,7 @@ spec:
location:
type: string
match:
description: Match selects objects to apply mutations to.
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names.
Expand Down Expand Up @@ -636,7 +636,7 @@ spec:
location:
type: string
match:
description: Match selects objects to apply mutations to.
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ spec:
location:
type: string
match:
description: Match selects objects to apply mutations to.
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names. If defined, a constraint only applies to resources not in a listed namespace. ExcludedNamespaces also supports a prefix or suffix based glob. For example, `excludedNamespaces: [kube-*]` matches both `kube-system` and `kube-public`, and `excludedNamespaces: [*-system]` matches both `kube-system` and `gatekeeper-system`.'
Expand Down Expand Up @@ -250,7 +250,7 @@ spec:
location:
type: string
match:
description: Match selects objects to apply mutations to.
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names. If defined, a constraint only applies to resources not in a listed namespace. ExcludedNamespaces also supports a prefix or suffix based glob. For example, `excludedNamespaces: [kube-*]` matches both `kube-system` and `kube-public`, and `excludedNamespaces: [*-system]` matches both `kube-system` and `gatekeeper-system`.'
Expand Down Expand Up @@ -461,7 +461,7 @@ spec:
location:
type: string
match:
description: Match selects objects to apply mutations to.
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names. If defined, a constraint only applies to resources not in a listed namespace. ExcludedNamespaces also supports a prefix or suffix based glob. For example, `excludedNamespaces: [kube-*]` matches both `kube-system` and `kube-public`, and `excludedNamespaces: [*-system]` matches both `kube-system` and `gatekeeper-system`.'
Expand Down
6 changes: 3 additions & 3 deletions manifest_staging/deploy/gatekeeper.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1067,7 +1067,7 @@ spec:
location:
type: string
match:
description: Match selects objects to apply mutations to.
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names. If defined, a constraint only applies to resources not in a listed namespace. ExcludedNamespaces also supports a prefix or suffix based glob. For example, `excludedNamespaces: [kube-*]` matches both `kube-system` and `kube-public`, and `excludedNamespaces: [*-system]` matches both `kube-system` and `gatekeeper-system`.'
Expand Down Expand Up @@ -1278,7 +1278,7 @@ spec:
location:
type: string
match:
description: Match selects objects to apply mutations to.
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names. If defined, a constraint only applies to resources not in a listed namespace. ExcludedNamespaces also supports a prefix or suffix based glob. For example, `excludedNamespaces: [kube-*]` matches both `kube-system` and `kube-public`, and `excludedNamespaces: [*-system]` matches both `kube-system` and `gatekeeper-system`.'
Expand Down Expand Up @@ -1489,7 +1489,7 @@ spec:
location:
type: string
match:
description: Match selects objects to apply mutations to.
description: Match selects which objects are in scope.
properties:
excludedNamespaces:
description: 'ExcludedNamespaces is a list of namespace names. If defined, a constraint only applies to resources not in a listed namespace. ExcludedNamespaces also supports a prefix or suffix based glob. For example, `excludedNamespaces: [kube-*]` matches both `kube-system` and `kube-public`, and `excludedNamespaces: [*-system]` matches both `kube-system` and `gatekeeper-system`.'
Expand Down
Loading

0 comments on commit df9a9d9

Please sign in to comment.