Skip to content

Commit 4f04e2c

Browse files
authored
rename bundleSource objects (#10550)
* rename bundleSource objects so they can be used for both policy and logconf * update codegen
1 parent fb70ad0 commit 4f04e2c

19 files changed

Lines changed: 158 additions & 156 deletions

File tree

config/crd/bases/k8s.nginx.org_policies.yaml

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -880,14 +880,14 @@ spec:
880880
InsecureSkipVerify disables TLS certificate verification when fetching bundles.
881881
Not recommended for production use.
882882
type: boolean
883-
policyName:
884-
description: PolicyName is the policy name on the management
883+
name:
884+
description: Name is the policy/logconf name on the management
885885
plane. Required for NIM and N1C; forbidden for HTTPS.
886886
maxLength: 63
887887
type: string
888-
policyNamespace:
889-
description: PolicyNamespace is the namespace/tenant on the
890-
management plane. Required for N1C only.
888+
namespace:
889+
description: Namespace is the namespace/tenant on the management
890+
plane. Required for N1C only.
891891
maxLength: 63
892892
type: string
893893
pollInterval:
@@ -977,14 +977,14 @@ spec:
977977
InsecureSkipVerify disables TLS certificate verification when fetching bundles.
978978
Not recommended for production use.
979979
type: boolean
980-
policyName:
981-
description: PolicyName is the policy name on the management
980+
name:
981+
description: Name is the policy/logconf name on the management
982982
plane. Required for NIM and N1C; forbidden for HTTPS.
983983
maxLength: 63
984984
type: string
985-
policyNamespace:
986-
description: PolicyNamespace is the namespace/tenant on
987-
the management plane. Required for N1C only.
985+
namespace:
986+
description: Namespace is the namespace/tenant on the
987+
management plane. Required for N1C only.
988988
maxLength: 63
989989
type: string
990990
pollInterval:
@@ -1081,14 +1081,15 @@ spec:
10811081
InsecureSkipVerify disables TLS certificate verification when fetching bundles.
10821082
Not recommended for production use.
10831083
type: boolean
1084-
policyName:
1085-
description: PolicyName is the policy name on the management
1086-
plane. Required for NIM and N1C; forbidden for HTTPS.
1084+
name:
1085+
description: Name is the policy/logconf name on the
1086+
management plane. Required for NIM and N1C; forbidden
1087+
for HTTPS.
10871088
maxLength: 63
10881089
type: string
1089-
policyNamespace:
1090-
description: PolicyNamespace is the namespace/tenant
1091-
on the management plane. Required for N1C only.
1090+
namespace:
1091+
description: Namespace is the namespace/tenant on the
1092+
management plane. Required for N1C only.
10921093
maxLength: 63
10931094
type: string
10941095
pollInterval:

deploy/crds.yaml

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1051,14 +1051,14 @@ spec:
10511051
InsecureSkipVerify disables TLS certificate verification when fetching bundles.
10521052
Not recommended for production use.
10531053
type: boolean
1054-
policyName:
1055-
description: PolicyName is the policy name on the management
1054+
name:
1055+
description: Name is the policy/logconf name on the management
10561056
plane. Required for NIM and N1C; forbidden for HTTPS.
10571057
maxLength: 63
10581058
type: string
1059-
policyNamespace:
1060-
description: PolicyNamespace is the namespace/tenant on the
1061-
management plane. Required for N1C only.
1059+
namespace:
1060+
description: Namespace is the namespace/tenant on the management
1061+
plane. Required for N1C only.
10621062
maxLength: 63
10631063
type: string
10641064
pollInterval:
@@ -1148,14 +1148,14 @@ spec:
11481148
InsecureSkipVerify disables TLS certificate verification when fetching bundles.
11491149
Not recommended for production use.
11501150
type: boolean
1151-
policyName:
1152-
description: PolicyName is the policy name on the management
1151+
name:
1152+
description: Name is the policy/logconf name on the management
11531153
plane. Required for NIM and N1C; forbidden for HTTPS.
11541154
maxLength: 63
11551155
type: string
1156-
policyNamespace:
1157-
description: PolicyNamespace is the namespace/tenant on
1158-
the management plane. Required for N1C only.
1156+
namespace:
1157+
description: Namespace is the namespace/tenant on the
1158+
management plane. Required for N1C only.
11591159
maxLength: 63
11601160
type: string
11611161
pollInterval:
@@ -1252,14 +1252,15 @@ spec:
12521252
InsecureSkipVerify disables TLS certificate verification when fetching bundles.
12531253
Not recommended for production use.
12541254
type: boolean
1255-
policyName:
1256-
description: PolicyName is the policy name on the management
1257-
plane. Required for NIM and N1C; forbidden for HTTPS.
1255+
name:
1256+
description: Name is the policy/logconf name on the
1257+
management plane. Required for NIM and N1C; forbidden
1258+
for HTTPS.
12581259
maxLength: 63
12591260
type: string
1260-
policyNamespace:
1261-
description: PolicyNamespace is the namespace/tenant
1262-
on the management plane. Required for N1C only.
1261+
namespace:
1262+
description: Namespace is the namespace/tenant on the
1263+
management plane. Required for N1C only.
12631264
maxLength: 63
12641265
type: string
12651266
pollInterval:

docs/crd/k8s.nginx.org_policies.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,8 @@ The `.spec` object supports the following fields:
147147
| `waf.apBundleSource` | `object` | ApBundleSource fetches the WAF policy bundle from N1C, NIM, or an HTTPS endpoint. Mutually exclusive with ApPolicy and ApBundle. |
148148
| `waf.apBundleSource.enablePolling` | `boolean` | EnablePolling enables background polling to automatically detect and fetch updated bundles at the configured PollInterval. When false, the bundle is fetched once on policy creation or update; subsequent updates require modifying the Policy resource to trigger a new fetch. |
149149
| `waf.apBundleSource.insecureSkipVerify` | `boolean` | InsecureSkipVerify disables TLS certificate verification when fetching bundles. Not recommended for production use. |
150-
| `waf.apBundleSource.policyName` | `string` | PolicyName is the policy name on the management plane. Required for NIM and N1C; forbidden for HTTPS. |
151-
| `waf.apBundleSource.policyNamespace` | `string` | PolicyNamespace is the namespace/tenant on the management plane. Required for N1C only. |
150+
| `waf.apBundleSource.name` | `string` | Name is the policy/logconf name on the management plane. Required for NIM and N1C; forbidden for HTTPS. |
151+
| `waf.apBundleSource.namespace` | `string` | Namespace is the namespace/tenant on the management plane. Required for N1C only. |
152152
| `waf.apBundleSource.pollInterval` | `string` | PollInterval is how often to re-fetch the bundle when enablePolling is true. Minimum 1m. Default 5m. Ignored when enablePolling is false. |
153153
| `waf.apBundleSource.retryAttempts` | `integer` | RetryAttempts is the number of retry attempts on transient failure. Range 1–10. |
154154
| `waf.apBundleSource.secret` | `string` | Secret is the name of a Kubernetes Secret in the same namespace as the Policy. For HTTPS: kubernetes.io/tls (tls.crt + tls.key for client mTLS; optional ca.crt for server CA). For N1C: nginx.com/waf-bundle Secret with a 'token' field containing the API token. For NIM: nginx.com/waf-bundle Secret with a 'token' field (bearer auth) or 'username'+'password' fields (basic auth). |
@@ -164,8 +164,8 @@ The `.spec` object supports the following fields:
164164
| `waf.securityLog.apLogBundleSource` | `object` | ApLogBundleSource fetches the log profile bundle from N1C, NIM, or an HTTPS endpoint. Mutually exclusive with ApLogConf and ApLogBundle. Requires apBundleSource on the parent WAF. |
165165
| `waf.securityLog.apLogBundleSource.enablePolling` | `boolean` | EnablePolling enables background polling to automatically detect and fetch updated bundles at the configured PollInterval. When false, the bundle is fetched once on policy creation or update; subsequent updates require modifying the Policy resource to trigger a new fetch. |
166166
| `waf.securityLog.apLogBundleSource.insecureSkipVerify` | `boolean` | InsecureSkipVerify disables TLS certificate verification when fetching bundles. Not recommended for production use. |
167-
| `waf.securityLog.apLogBundleSource.policyName` | `string` | PolicyName is the policy name on the management plane. Required for NIM and N1C; forbidden for HTTPS. |
168-
| `waf.securityLog.apLogBundleSource.policyNamespace` | `string` | PolicyNamespace is the namespace/tenant on the management plane. Required for N1C only. |
167+
| `waf.securityLog.apLogBundleSource.name` | `string` | Name is the policy/logconf name on the management plane. Required for NIM and N1C; forbidden for HTTPS. |
168+
| `waf.securityLog.apLogBundleSource.namespace` | `string` | Namespace is the namespace/tenant on the management plane. Required for N1C only. |
169169
| `waf.securityLog.apLogBundleSource.pollInterval` | `string` | PollInterval is how often to re-fetch the bundle when enablePolling is true. Minimum 1m. Default 5m. Ignored when enablePolling is false. |
170170
| `waf.securityLog.apLogBundleSource.retryAttempts` | `integer` | RetryAttempts is the number of retry attempts on transient failure. Range 1–10. |
171171
| `waf.securityLog.apLogBundleSource.secret` | `string` | Secret is the name of a Kubernetes Secret in the same namespace as the Policy. For HTTPS: kubernetes.io/tls (tls.crt + tls.key for client mTLS; optional ca.crt for server CA). For N1C: nginx.com/waf-bundle Secret with a 'token' field containing the API token. For NIM: nginx.com/waf-bundle Secret with a 'token' field (bearer auth) or 'username'+'password' fields (basic auth). |
@@ -182,8 +182,8 @@ The `.spec` object supports the following fields:
182182
| `waf.securityLogs[].apLogBundleSource` | `object` | ApLogBundleSource fetches the log profile bundle from N1C, NIM, or an HTTPS endpoint. Mutually exclusive with ApLogConf and ApLogBundle. Requires apBundleSource on the parent WAF. |
183183
| `waf.securityLogs[].apLogBundleSource.enablePolling` | `boolean` | EnablePolling enables background polling to automatically detect and fetch updated bundles at the configured PollInterval. When false, the bundle is fetched once on policy creation or update; subsequent updates require modifying the Policy resource to trigger a new fetch. |
184184
| `waf.securityLogs[].apLogBundleSource.insecureSkipVerify` | `boolean` | InsecureSkipVerify disables TLS certificate verification when fetching bundles. Not recommended for production use. |
185-
| `waf.securityLogs[].apLogBundleSource.policyName` | `string` | PolicyName is the policy name on the management plane. Required for NIM and N1C; forbidden for HTTPS. |
186-
| `waf.securityLogs[].apLogBundleSource.policyNamespace` | `string` | PolicyNamespace is the namespace/tenant on the management plane. Required for N1C only. |
185+
| `waf.securityLogs[].apLogBundleSource.name` | `string` | Name is the policy/logconf name on the management plane. Required for NIM and N1C; forbidden for HTTPS. |
186+
| `waf.securityLogs[].apLogBundleSource.namespace` | `string` | Namespace is the namespace/tenant on the management plane. Required for N1C only. |
187187
| `waf.securityLogs[].apLogBundleSource.pollInterval` | `string` | PollInterval is how often to re-fetch the bundle when enablePolling is true. Minimum 1m. Default 5m. Ignored when enablePolling is false. |
188188
| `waf.securityLogs[].apLogBundleSource.retryAttempts` | `integer` | RetryAttempts is the number of retry attempts on transient failure. Range 1–10. |
189189
| `waf.securityLogs[].apLogBundleSource.secret` | `string` | Secret is the name of a Kubernetes Secret in the same namespace as the Policy. For HTTPS: kubernetes.io/tls (tls.crt + tls.key for client mTLS; optional ca.crt for server CA). For N1C: nginx.com/waf-bundle Secret with a 'token' field containing the API token. For NIM: nginx.com/waf-bundle Secret with a 'token' field (bearer auth) or 'username'+'password' fields (basic auth). |

examples/custom-resources/security-monitoring-v5/waf-n1c.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ spec:
88
apBundleSource:
99
type: N1C
1010
url: "https://<tenant>.console.ves.volterra.io"
11-
policyName: "<policy_name>"
12-
policyNamespace: "default"
11+
name: "<policy_name>"
12+
namespace: "default"
1313
secret: "n1c-credentials"
1414
enablePolling: true
1515
pollInterval: "5m"
@@ -18,8 +18,8 @@ spec:
1818
apLogBundleSource:
1919
type: N1C
2020
url: "https://<tenant>.console.ves.volterra.io"
21-
policyName: "secops_dashboard"
22-
policyNamespace: "default"
21+
name: "secops_dashboard"
22+
namespace: "default"
2323
secret: "n1c-credentials"
2424
enablePolling: true
2525
pollInterval: "5m"

examples/custom-resources/security-monitoring-v5/waf-nim.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ spec:
88
apBundleSource:
99
type: NIM
1010
url: "https://<nim_host>"
11-
policyName: "<policy_name>"
11+
name: "<policy_name>"
1212
secret: "nim-credentials"
1313
enablePolling: true
1414
pollInterval: "5m"
@@ -17,7 +17,7 @@ spec:
1717
apLogBundleSource:
1818
type: NIM
1919
url: "https://<nim_host>"
20-
policyName: "<log_profile_name>"
20+
name: "<log_profile_name>"
2121
secret: "nim-credentials"
2222
enablePolling: true
2323
pollInterval: "5m"

examples/custom-resources/waf-management-plane/waf-n1c.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ spec:
88
apBundleSource:
99
type: N1C
1010
url: "https://<tenant>.console.ves.volterra.io"
11-
policyName: "<policy_name>"
12-
policyNamespace: "default"
11+
name: "<policy_name>"
12+
namespace: "default"
1313
secret: "n1c-credentials"
1414
enablePolling: true
1515
pollInterval: "5m"
@@ -18,8 +18,8 @@ spec:
1818
apLogBundleSource:
1919
type: N1C
2020
url: "https://<tenant>.console.ves.volterra.io"
21-
policyName: "secops_dashboard"
22-
policyNamespace: "default"
21+
name: "secops_dashboard"
22+
namespace: "default"
2323
secret: "n1c-credentials"
2424
enablePolling: true
2525
pollInterval: "5m"

examples/custom-resources/waf-management-plane/waf-nim.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ spec:
88
apBundleSource:
99
type: NIM
1010
url: "https://<nim_host>"
11-
policyName: "<policy_name>"
11+
name: "<policy_name>"
1212
secret: "nim-credentials"
1313
enablePolling: true
1414
pollInterval: "5m"
@@ -17,7 +17,7 @@ spec:
1717
apLogBundleSource:
1818
type: NIM
1919
url: "https://<nim_host>"
20-
policyName: "<log_profile_name>"
20+
name: "<log_profile_name>"
2121
secret: "nim-credentials"
2222
enablePolling: true
2323
pollInterval: "5m"

examples/ingress-resources/security-monitoring-v5/waf-n1c.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ spec:
88
apBundleSource:
99
type: N1C
1010
url: "https://<tenant>.console.ves.volterra.io"
11-
policyName: "<policy_name>"
12-
policyNamespace: "default"
11+
name: "<policy_name>"
12+
namespace: "default"
1313
secret: "n1c-credentials"
1414
enablePolling: true
1515
pollInterval: "5m"
@@ -18,8 +18,8 @@ spec:
1818
apLogBundleSource:
1919
type: N1C
2020
url: "https://<tenant>.console.ves.volterra.io"
21-
policyName: "secops_dashboard"
22-
policyNamespace: "default"
21+
name: "secops_dashboard"
22+
namespace: "default"
2323
secret: "n1c-credentials"
2424
enablePolling: true
2525
pollInterval: "5m"

examples/ingress-resources/security-monitoring-v5/waf-nim.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ spec:
88
apBundleSource:
99
type: NIM
1010
url: "https://<nim_host>"
11-
policyName: "<policy_name>"
11+
name: "<policy_name>"
1212
secret: "nim-credentials"
1313
enablePolling: true
1414
pollInterval: "5m"
@@ -17,7 +17,7 @@ spec:
1717
apLogBundleSource:
1818
type: NIM
1919
url: "https://<nim_host>"
20-
policyName: "<log_profile_name>"
20+
name: "<log_profile_name>"
2121
secret: "nim-credentials"
2222
enablePolling: true
2323
pollInterval: "5m"

examples/ingress-resources/waf-management-plane/waf-n1c.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ spec:
88
apBundleSource:
99
type: N1C
1010
url: "https://<tenant>.console.ves.volterra.io"
11-
policyName: "<policy_name>"
12-
policyNamespace: "default"
11+
name: "<policy_name>"
12+
namespace: "default"
1313
secret: "n1c-credentials"
1414
enablePolling: true
1515
pollInterval: "5m"
@@ -18,8 +18,8 @@ spec:
1818
apLogBundleSource:
1919
type: N1C
2020
url: "https://<tenant>.console.ves.volterra.io"
21-
policyName: "secops_dashboard"
22-
policyNamespace: "default"
21+
name: "secops_dashboard"
22+
namespace: "default"
2323
secret: "n1c-credentials"
2424
enablePolling: true
2525
pollInterval: "5m"

0 commit comments

Comments
 (0)