use gw-api style for namespace selector

Signed-off-by: Guy Daich <guy.daich@sap.com>
envoyproxy · Jan 29, 2025 · acfea54 · acfea54
1 parent e9dee32
commit acfea54
Show file tree

Hide file tree

Showing 8 changed files with 134 additions and 81 deletions.
diff --git a/api/v1alpha1/policy_helpers.go b/api/v1alpha1/policy_helpers.go
@@ -38,19 +38,28 @@ type TargetSelector struct {
 	// MatchLabels are the set of label selectors for identifying the targeted resource
 	MatchLabels map[string]string `json:"matchLabels"`
 
-	// NamespaceSelector determines if the label selectors specified in MatchLabels are applied in
-	// the policy namespace or across all namespaces.
+	// Namespaces determines if the resource from all namespaces or the current namespace
+	// are considered when matching by label selectors specified in MatchLabels.
 	// Note: when referencing targets in a different namespace, appropriate ReferenceGrants must be
 	// configured to allow the selection.
 	// +optional
 	// +notImplementedHide
-	NamespaceSelector *NamespaceSelector `json:"namespaceSelector,omitempty"`
+	Namespaces *TargetSelectorNamespaces `json:"namespaces,omitempty"`
 }
 
-// NamespaceSelector is a selector for selecting either all namespaces or the current namespace.
-type NamespaceSelector struct {
-	// Boolean describing whether all namespaces are selected.
-	Any bool `json:"any,omitempty"`
+type FromNamespaces string
+
+const (
+	// FromNamespacesAll indicates that the target selector should apply to targets from all namespaces
+	FromNamespacesAll FromNamespaces = "All"
+)
+
+// TargetSelectorNamespaces determines which namespaces are used when selecting policy targets.
+type TargetSelectorNamespaces struct {
+	// Indicates where targets would be selected for the Policy's TargetSelector.
+	// +kubebuilder:validation:Enum=All
+	// +kubebuilder:validation:Required
+	FromNamespaces FromNamespaces `json:"omitempty"`
 }
 
 func (p PolicyTargetReferences) GetTargetRefs() []gwapiv1a2.LocalPolicyTargetReferenceWithSectionName {

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml
@@ -1504,17 +1504,21 @@ spec:
                       description: MatchLabels are the set of label selectors for
                         identifying the targeted resource
                       type: object
-                    namespaceSelector:
+                    namespaces:
                       description: |-
-                        NamespaceSelector determines if the label selectors specified in MatchLabels are applied in
-                        the policy namespace or across all namespaces.
+                        Namespaces determines if the resource from all namespaces or the current namespace
+                        are considered when matching by label selectors specified in MatchLabels.
                         Note: when referencing targets in a different namespace, appropriate ReferenceGrants must be
                         configured to allow the selection.
                       properties:
-                        any:
-                          description: Boolean describing whether all namespaces are
-                            selected.
-                          type: boolean
+                        omitempty:
+                          description: Indicates where targets would be selected for
+                            the Policy's TargetSelector.
+                          enum:
+                          - All
+                          type: string
+                      required:
+                      - omitempty
                       type: object
                   required:
                   - kind

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_clienttrafficpolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_clienttrafficpolicies.yaml
@@ -614,17 +614,21 @@ spec:
                       description: MatchLabels are the set of label selectors for
                         identifying the targeted resource
                       type: object
-                    namespaceSelector:
+                    namespaces:
                       description: |-
-                        NamespaceSelector determines if the label selectors specified in MatchLabels are applied in
-                        the policy namespace or across all namespaces.
+                        Namespaces determines if the resource from all namespaces or the current namespace
+                        are considered when matching by label selectors specified in MatchLabels.
                         Note: when referencing targets in a different namespace, appropriate ReferenceGrants must be
                         configured to allow the selection.
                       properties:
-                        any:
-                          description: Boolean describing whether all namespaces are
-                            selected.
-                          type: boolean
+                        omitempty:
+                          description: Indicates where targets would be selected for
+                            the Policy's TargetSelector.
+                          enum:
+                          - All
+                          type: string
+                      required:
+                      - omitempty
                       type: object
                   required:
                   - kind

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyextensionpolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyextensionpolicies.yaml
@@ -1197,17 +1197,21 @@ spec:
                       description: MatchLabels are the set of label selectors for
                         identifying the targeted resource
                       type: object
-                    namespaceSelector:
+                    namespaces:
                       description: |-
-                        NamespaceSelector determines if the label selectors specified in MatchLabels are applied in
-                        the policy namespace or across all namespaces.
+                        Namespaces determines if the resource from all namespaces or the current namespace
+                        are considered when matching by label selectors specified in MatchLabels.
                         Note: when referencing targets in a different namespace, appropriate ReferenceGrants must be
                         configured to allow the selection.
                       properties:
-                        any:
-                          description: Boolean describing whether all namespaces are
-                            selected.
-                          type: boolean
+                        omitempty:
+                          description: Indicates where targets would be selected for
+                            the Policy's TargetSelector.
+                          enum:
+                          - All
+                          type: string
+                      required:
+                      - omitempty
                       type: object
                   required:
                   - kind

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml
@@ -4413,17 +4413,21 @@ spec:
                       description: MatchLabels are the set of label selectors for
                         identifying the targeted resource
                       type: object
-                    namespaceSelector:
+                    namespaces:
                       description: |-
-                        NamespaceSelector determines if the label selectors specified in MatchLabels are applied in
-                        the policy namespace or across all namespaces.
+                        Namespaces determines if the resource from all namespaces or the current namespace
+                        are considered when matching by label selectors specified in MatchLabels.
                         Note: when referencing targets in a different namespace, appropriate ReferenceGrants must be
                         configured to allow the selection.
                       properties:
-                        any:
-                          description: Boolean describing whether all namespaces are
-                            selected.
-                          type: boolean
+                        omitempty:
+                          description: Indicates where targets would be selected for
+                            the Policy's TargetSelector.
+                          enum:
+                          - All
+                          type: string
+                      required:
+                      - omitempty
                       type: object
                   required:
                   - kind

diff --git a/site/content/en/latest/api/extension_types.md b/site/content/en/latest/api/extension_types.md
@@ -1801,6 +1801,20 @@ _Appears in:_
 | `after` | _[EnvoyFilter](#envoyfilter)_ |  true  |  | After defines the filter that should come after the filter.<br />Only one of Before or After must be set. |
 
 
+#### FromNamespaces
+
+_Underlying type:_ _string_
+
+
+
+_Appears in:_
+- [TargetSelectorNamespaces](#targetselectornamespaces)
+
+| Value | Description |
+| ----- | ----------- |
+| `All` | FromNamespacesAll indicates that the target selector should apply to targets from all namespaces<br /> | 
+
+
 #### GRPCActiveHealthChecker
 
 
@@ -2898,20 +2912,6 @@ _Appears in:_
 | `OpenTelemetry` |  | 
 
 
-#### NamespaceSelector
-
-
-
-NamespaceSelector is a selector for selecting either all namespaces or the current namespace.
-
-_Appears in:_
-- [TargetSelector](#targetselector)
-
-| Field | Type | Required | Default | Description |
-| ---   | ---  | ---      | ---     | ---         |
-| `any` | _boolean_ |  true  |  | Boolean describing whether all namespaces are selected. |
-
-
 #### OIDC
 
 
@@ -4318,6 +4318,20 @@ _Appears in:_
 | `matchLabels` | _object (keys:string, values:string)_ |  true  |  | MatchLabels are the set of label selectors for identifying the targeted resource |
 
 
+#### TargetSelectorNamespaces
+
+
+
+TargetSelectorNamespaces determines which namespaces are used when selecting policy targets.
+
+_Appears in:_
+- [TargetSelector](#targetselector)
+
+| Field | Type | Required | Default | Description |
+| ---   | ---  | ---      | ---     | ---         |
+| `omitempty` | _[FromNamespaces](#fromnamespaces)_ |  true  |  | Indicates where targets would be selected for the Policy's TargetSelector. |
+
+
 #### Timeout
 
 

diff --git a/site/content/zh/latest/api/extension_types.md b/site/content/zh/latest/api/extension_types.md
@@ -1801,6 +1801,20 @@ _Appears in:_
 | `after` | _[EnvoyFilter](#envoyfilter)_ |  true  |  | After defines the filter that should come after the filter.<br />Only one of Before or After must be set. |
 
 
+#### FromNamespaces
+
+_Underlying type:_ _string_
+
+
+
+_Appears in:_
+- [TargetSelectorNamespaces](#targetselectornamespaces)
+
+| Value | Description |
+| ----- | ----------- |
+| `All` | FromNamespacesAll indicates that the target selector should apply to targets from all namespaces<br /> | 
+
+
 #### GRPCActiveHealthChecker
 
 
@@ -2898,20 +2912,6 @@ _Appears in:_
 | `OpenTelemetry` |  | 
 
 
-#### NamespaceSelector
-
-
-
-NamespaceSelector is a selector for selecting either all namespaces or the current namespace.
-
-_Appears in:_
-- [TargetSelector](#targetselector)
-
-| Field | Type | Required | Default | Description |
-| ---   | ---  | ---      | ---     | ---         |
-| `any` | _boolean_ |  true  |  | Boolean describing whether all namespaces are selected. |
-
-
 #### OIDC
 
 
@@ -4318,6 +4318,20 @@ _Appears in:_
 | `matchLabels` | _object (keys:string, values:string)_ |  true  |  | MatchLabels are the set of label selectors for identifying the targeted resource |
 
 
+#### TargetSelectorNamespaces
+
+
+
+TargetSelectorNamespaces determines which namespaces are used when selecting policy targets.
+
+_Appears in:_
+- [TargetSelector](#targetselector)
+
+| Field | Type | Required | Default | Description |
+| ---   | ---  | ---      | ---     | ---         |
+| `omitempty` | _[FromNamespaces](#fromnamespaces)_ |  true  |  | Indicates where targets would be selected for the Policy's TargetSelector. |
+
+
 #### Timeout