docs: Reorganise examples (#2871)

* Initial attempt at reorganising examples * Rename waf and dos folders * Change App Protect to App Protect WAF * Apply suggestions from code review Co-authored-by: Jodie Putrino <j.putrino@f5.com> * Rename examples folders; rename docs folder and attempt alias Co-authored-by: Jodie Putrino <j.putrino@f5.com>
nginxinc · Aug 25, 2022 · a8c2590 · a8c2590
1 parent 57b9923
commit a8c2590
Show file tree

Hide file tree

Showing 100 changed files with 277 additions and 114 deletions.
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ Read [this doc](https://docs.nginx.com/nginx-ingress-controller/intro/nginx-plus
 
 1. Install the NGINX Ingress Controller using the Kubernetes [manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) or the [helm chart](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/).
 1. Configure load balancing for a simple web application:
-    * Use the Ingress resource. See the [Cafe example](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples/complete-example).
+    * Use the Ingress resource. See the [Cafe example](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples/ingress-resources/complete-example).
     * Or the VirtualServer resource. See the [Basic configuration](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples/custom-resources/basic-configuration) example.
 1. See additional configuration [examples](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples).
 1. Learn more about all available configuration and customization in the [docs](https://docs.nginx.com/nginx-ingress-controller/).

diff --git a/deployments/helm-chart/README.md b/deployments/helm-chart/README.md
@@ -230,7 +230,7 @@ Parameter | Description | Default
 `controller.reportIngressStatus.annotations` | The annotations of the leader election configmap. | {}
 `controller.pod.annotations` | The annotations of the Ingress Controller pod. | {}
 `controller.pod.extraLabels` | The additional extra labels of the Ingress Controller pod. | {}
-`controller.appprotect.enable` | Enables the App Protect module in the Ingress Controller. | false
+`controller.appprotect.enable` | Enables the App Protect WAF module in the Ingress Controller. | false
 `controller.appprotectdos.enable` | Enables the App Protect DoS module in the Ingress Controller. | false
 `controller.appprotectdos.debug` | Enable debugging for App Protect DoS. | false
 `controller.appprotectdos.maxDaemons` | Max number of ADMD instances. | 1

diff --git a/deployments/helm-chart/values.yaml b/deployments/helm-chart/values.yaml
@@ -12,11 +12,11 @@ controller:
   # Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start.
   nginxReloadTimeout: 60000
 
-  ## Support for App Protect
+  ## Support for App Protect WAF
   appprotect:
-    ## Enable the App Protect module in the Ingress Controller.
+    ## Enable the App Protect WAF module in the Ingress Controller.
     enable: false
-    ## Sets log level for App Protect. Allowed values: fatal, error, warn, info, debug, trace
+    ## Sets log level for App Protect WAF. Allowed values: fatal, error, warn, info, debug, trace
     # logLevel: fatal
 
   ## Support for App Protect Dos

diff --git a/docs/content/app-protect-dos/configuration.md b/docs/content/app-protect-dos/configuration.md
@@ -9,7 +9,7 @@ docs: "DOCS-580"
 ---
 
 This document describes how to configure the NGINX App Protect DoS module
-> Check out the complete [NGINX Ingress Controller with App Protect DoS example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v2.3.0/examples/appprotect-dos).
+> Check out the complete [NGINX Ingress Controller with App Protect DoS example for VirtualServer](https://github.com/nginxinc/kubernetes-ingress/tree/v2.3.0/examples/custom-resources/app-protect-dos) and the [NGINX Ingress Controller with App Protect DoS example for Ingress](https://github.com/nginxinc/kubernetes-ingress/tree/v2.3.0/examples/ingress-resources/app-protect-dos).
 
 ## App Protect DoS Configuration
 

diff --git a/docs/content/app-protect-dos/dos-protected.md b/docs/content/app-protect-dos/dos-protected.md
@@ -71,7 +71,7 @@ If you try to create (or update) a resource that violates the structural schema
 * Example of `kubectl` validation:
     ```
     $ kubectl apply -f apdos-protected.yaml
-    error: error validating "examples/appprotect-dos/apdos-protected.yaml": error validating data: ValidationError(DosProtectedResource.spec.enable): invalid type for com.f5.appprotectdos.v1beta1.DosProtectedResource.spec.enable: got "string", expected "boolean"; if you choose to ignore these errors, turn validation off with --validate=false
+    error: error validating "examples/app-protect-dos/apdos-protected.yaml": error validating data: ValidationError(DosProtectedResource.spec.enable): invalid type for com.f5.appprotectdos.v1beta1.DosProtectedResource.spec.enable: got "string", expected "boolean"; if you choose to ignore these errors, turn validation off with --validate=false
     ```
 * Example of Kubernetes API server validation:
     ```

diff --git a/docs/content/app-protect-dos/installation.md b/docs/content/app-protect-dos/installation.md
@@ -7,7 +7,7 @@ toc: true
 docs: "DOCS-583"
 ---
 
-> **Note**: The NGINX Kubernetes Ingress Controller integration with NGINX App Protect requires the use of NGINX Plus.
+> **Note**: The NGINX Kubernetes Ingress Controller integration with NGINX App Protect DoS requires the use of NGINX Plus.
 
 This document provides an overview of the steps required to use NGINX App Protect DoS with your NGINX Ingress Controller deployment. You can visit the linked documents to find additional information and instructions.
 
@@ -63,4 +63,4 @@ Take the steps below to set up and deploy the NGINX Ingress Controller and App P
 3. Enable the App Protect Dos module by adding the `enable-app-protect-dos` [cli argument](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/#cmdoption-enable-app-protect-dos) to your Deployment or DaemonSet file.
 4. [Deploy the Ingress Controller](/nginx-ingress-controller/installation/installation-with-manifests/#3-deploy-the-ingress-controller).
 
-For more information, see the [Configuration guide](/nginx-ingress-controller/app-protect-dos/configuration),the [NGINX Ingress Controller with App Protect DoS example for Ingress](https://github.com/nginxinc/kubernetes-ingress/tree/v2.3.0/examples/appprotect-dos) and the [NGINX Ingress Controller with App Protect DoS example for VirtualServer](https://github.com/nginxinc/kubernetes-ingress/tree/v2.3.0/examples/custom-resources/dos).
+For more information, see the [Configuration guide](/nginx-ingress-controller/app-protect-dos/configuration),the [NGINX Ingress Controller with App Protect DoS example for VirtualServer](https://github.com/nginxinc/kubernetes-ingress/tree/v2.3.0/examples/custom-resources/app-protect-dos) and the [NGINX Ingress Controller with App Protect DoS example for Ingress](https://github.com/nginxinc/kubernetes-ingress/tree/v2.3.0/examples/ingress-resources/app-protect-dos).
diff --git a/docs/content/app-protect/_index.md → docs/content/app-protect-waf/_index.md b/docs/content/app-protect/_index.md → docs/content/app-protect-waf/_index.md
@@ -2,6 +2,7 @@
 title: Using with NGINX App Protect
 description: Learn how to use NGINX Ingress Controller for Kubernetes with NGINX App Protect.
 weight: 1600
+aliases: ["/nginx-ingress-controller/app-protect/"]
 menu:
   docs:
     parent: NGINX Ingress Controller