8000 Revert "Add WAF Bundle example (#3656)" (#3677) · nginx/kubernetes-ingress@df264ff · GitHub
[go: up one dir, main page]
Skip to content

Commit df264ff

Browse files
jjngxjjngx
authored
Revert "Add WAF Bundle example (#3656)" (#3677)
This reverts commit b649666.
1 parent b649666 commit df264ff

File tree

3 files changed

+1
-59
lines changed

3 files changed

+1
-59
lines changed

‎docs/content/app-protect-waf/configuration.md‎

< 8000 div class="DiffFileHeader-module__hide-on-mobile--dxRfz">
Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The NGINX Ingress Controller has a set of global configuration parameters that a
1919

2020
You can enable and configure NGINX App Protect WAF on the Custom Resources (VirtualServer, VirtualServerRoute) or on the Ingress-resource basis.
2121

22-
To configure NGINX App Protect WAF on a VirtualServer resource, you would create a Policy Custom Resource referencing the `APPolicy` Custom Resource or `APPolicy` Bundle, and add this to the VirtualServer definition. Additional information can be found in the [Policy resource documentation](/nginx-ingress-controller/configuration/policy-resource/#waf).
22+
To configure NGINX App Protect WAF on a VirtualServer resource, you would create a Policy Custom Resource referencing the APPolicy Custom Resource, and add this to the VirtualServer definition. See the documentation on the [App Protect WAF Policy](/nginx-ingress-controller/configuration/policy-resource/#waf).
2323

2424
To configure NGINX App Protect WAF on an Ingress resource, you would apply the [App Protect annotations](/nginx-ingress-controller/configuration/ingress-resources/advanced-configuration-with-annotations/#app-protect) to each desired resource.
2525

@@ -209,29 +209,6 @@ spec:
209209
tag: Fruits
210210
```
211211

212-
## App Protect WAF Bundles
213-
214-
You can define App Protect WAF bundles for VirtualServers by creating policy bundles and putting them on a mounted volume accessible from NGINX Ingress Controller.
215-
216-
217-
For example, you can configure a policy by referencing generated WAF Policy Bundle:
218-
219-
> **Note**: Currently we do not support `securityLogs` for policy bundles.
220-
221-
```yaml
222-
apiVersion: k8s.nginx.org/v1
223-
kind: Policy
224-
metadata:
225-
name: <policy_name>
226-
spec:
227-
waf:
228-
enable: true
229-
apBundle: "<policy_bundle_name>.tgz"
230-
```
231-
232-
> **Note**: Before applying the policy, a WAF Policy Bundle must be created, copied to a volume, and the volume must be mounted to `/etc/nginx/waf/bundles`.
233-
234-
235212
## OpenAPI Specification in NGINX Ingress Controller
236213

237214
The OpenAPI Specification defines the spec file format needed to describe RESTful APIs. The spec file can be written either in JSON or YAML. Using a spec file simplifies the work of implementing API protection. Refer to the [OpenAPI Specification](#https://github.com/OAI/OpenAPI-Specification) (formerly called Swagger) for details.

‎docs/content/app-protect-waf/installation.md‎

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -60,39 +60,7 @@ Take the steps below to set up and deploy the NGINX Ingress Controller and App P
6060
> **Important**: You must have an admin role to configure RBAC in your Kubernetes cluster.
6161
6262
2. [Create the common Kubernetes resources](/nginx-ingress-controller/installation/installation-with-manifests/#2-create-common-resources).
63-
6463
3. Enable the App Protect WAF module by adding the `enable-app-protect` [cli argument](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/#cmdoption-enable-app-protect) to your Deployment or DaemonSet file.
65-
66-
If you intend to use the NGINX Ingress Controller with the AppProtect WAF module and policy bundles, follow these additional steps:
67-
68-
- Skip configuring custom resource definition for `APPolicy` `APLogConf` and `APUserSig`.
69-
70-
- Create and configure [Persistent Volume and Persistent Volume Claim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) in your Kubernetes cluster.
71-
72-
- Modify NGINX Ingress Controller Deployment or DaemonSet file to include volumes and volume mounts.
73-
74-
Make the following changes:
75-
76-
Add `volumes` section to deployment template spec:
77-
```yaml
78-
...
79-
volumes:
80-
- name: <volume_name>
81-
persistentVolumeClaim:
82-
claimName: <claim_name>
83-
...
84-
```
85-
Add volume mounts to `containers` section:
86-
```yaml
87-
...
88-
volumeMounts:
89-
- name: <volume_mount_name>
90-
mountPath: /etc/nginx/waf/bundles
91-
...
92-
```
93-
94-
> **Important**: NGINX Ingress Controller requires the volume mount path to be `/etc/nginx/waf/bundles`
95-
9664
4. [Deploy the Ingress Controller](/nginx-ingress-controller/installation/installation-with-manifests/#3-deploy-the-ingress-controller).
9765
9866
For more information, see the [Configuration guide](/nginx-ingress-controller/app-protect/configuration) and the NGINX Ingress Controller with App Protect example resources on GitHub [for VirtualServer resources](https://github.com/nginxinc/kubernetes-ingress/tree/v3.0.2/examples/custom-resources/app-protect-waf) and [for Ingress resources](https://github.com/nginxinc/kubernetes-ingress/tree/v3.0.2/examples/ingress-resources/app-protect-waf).

‎docs/content/installation/installation-with-manifests.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,6 @@ Create a custom resource definition for [GlobalConfiguration](/nginx-ingress-con
9494
9595
3. If you would like to use the App Protect WAF module, create the following additional resources:
9696
97-
> **Note** This step can be skipped if you are using App Protect WAF module with policy bundles.
98-
99-
10097
Create a custom resource definition for `APPolicy`, `APLogConf` and `APUserSig`:
10198
10299
```

0 commit comments

Comments
 (0)
0