Skip to content

Commit c33c7f4

Browse files
committed
added aviv suggestions
1 parent 7f3be7d commit c33c7f4

File tree

8 files changed

+47
-60
lines changed

8 files changed

+47
-60
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
nd-files:
3+
- content/includes/use-cases/credential-download-instructions.md
4+
- content/waf/configure/compiler.md
5+
- content/waf/install/docker.md
6+
- content/waf/install/kubernetes.md
7+
---
8+
9+
1. Log in to [MyF5](https://my.f5.com/manage/s/).
10+
1. Go to **My Products & Plans > Subscriptions** to see your active subscriptions.
11+
1. Find your NGINX subscription, and select the **Subscription ID** for details.
12+
1. Download the **SSL Certificate**, **Private Key** and **JSON Web Token** files from the subscription page.

content/waf/configure/secure-mtls.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ With a [Virtual machine or bare metal]({{< ref "/waf/install/virtual-environment
155155

156156
{{< /call-out >}}
157157

158-
## Modify Docker compose file
158+
## Modify Docker Compose file
159159

160160
{{< call-out "warning" >}}
161161

@@ -224,5 +224,4 @@ services:
224224
app_protect_bd_config:
225225
app_protect_config:
226226
app_protect_etc_config:
227-
```
228-
227+
```

content/waf/install/disconnected-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,4 @@ docker load -i waf-config-mgr.tar
113113
docker load -i waf-ip-intelligence.tar
114114
```
115115

116-
Ensure your Docker compose files use the tagged images you've transferred.
116+
Ensure your Docker Compose files use the tagged images you've transferred.

content/waf/install/docker.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,10 @@ This page describes how to install F5 WAF for NGINX using Docker.
1717
To complete this guide, you will need the following prerequisites:
1818

1919
- A [supported operating system]({{< ref "/waf/fundamentals/technical-specifications.md#supported-operating-systems" >}}).
20-
- [Docker](https://docs.docker.com/engine/install/) (with Docker compose) installed and running TODO add reason for it.
21-
- An active F5 WAF for NGINX subscription. Available from [MyF5](https://my.f5.com/manage/s/) (Purchased or trial).
22-
- Download the [SSL certificate and private key file](#general-subscription-credentials-needed-for-deployments) associated with your F5 WAF for NGINX subscription from the MyF5 Customer Portal if you are using NGINX Open Source in your deployment.
23-
- Download the [SSL certificate and private key file](#general-subscription-credentials-needed-for-deployments), and the [JWT license file](#additional-subscription-credentials-needed-for-deployments) associated with your F5 WAF for NGINX subscription from the MyF5 Customer Portal if you are using NGINX Plus in your deployment.
24-
- [Docker registry credentials](#additional-subscription-credentials-needed-for-deployments) are needed to access private-registry.nginx.com (For Multi-container and Hybrid configuration)
20+
- [Docker](https://docs.docker.com/engine/install/) (with Docker Compose) installed and running.
21+
- Ensure you have an active F5 WAF for NGINX subscription (purchased or trial) and have downloaded the associated [SSL certificate, private key, and JWT license](#download-your-subscription-credentials) file from the MyF5 Customer Portal. JWT license is not needed when using NGINX Open Source.
22+
- Access to private-registry.nginx.com using [Docker registry credentials](#additional-subscription-credentials-needed-for-deployments) for pulling images need for deployment when using Multi-container and Hybrid configuration.
23+
- [Docker registry credentials](#additional-subscription-credentials-needed-for-deployments) for private-registry.nginx.com, required to pull images for Multi-container and Hybrid configurations.
2524

2625
You should read the [IP intelligence]({{< ref "/waf/policies/ip-intelligence.md" >}}) and [Secure traffic using mTLS]({{< ref "/waf/configure/secure-mtls.md" >}}) topics for additional set-up configuration if you want to use them immediately.
2726

@@ -33,14 +32,11 @@ F5 WAF for NGINX uses built-in default security policy and logging profile after
3332

3433
## Download your subscription credentials
3534

36-
### General subscription credentials needed for deployments
37-
38-
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
39-
40-
### Additional subscription credentials needed for deployments
35+
{{< call-out "note" >}}
36+
If you are using NGINX Open Source for your Multi-container or Hybrid configuration, you do not need the JWT license file.
37+
{{< /call-out >}}
4138

42-
To use NGINX Plus and access private-registry.nginx.com, you will need to download the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
43-
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
39+
{{< include "licensing-and-reporting/download-jwt-ssl-key-from-myf5.md" >}}
4440

4541
{{< call-out "important" >}}
4642
The provided Dockerfile for NGINX Plus automatically handles placing the JWT license file in `/etc/nginx/` during image build. If you use a custom Dockerfile, you must ensure the JWT license is copied to this location.

content/waf/install/kubernetes-plm.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,28 +37,22 @@ These enhancements are only available for Helm-based deployments.
3737
To complete this guide, you will need the following prerequisites:
3838

3939
- A [supported operating system]({{< ref "/waf/fundamentals/technical-specifications.md#supported-operating-systems" >}}).
40-
- [A functional Kubernetes cluster](https://kubernetes.io/docs/setup/)
41-
- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) configured and connected to your cluster
42-
- [Helm](https://helm.sh/docs/intro/install/)
43-
- [Docker](https://docs.docker.com/engine/install/) (with Docker compose) installed and running.
44-
- An active F5 WAF for NGINX subscription in [MyF5](https://my.f5.com/manage/s/) (Purchased or trial).
45-
- Download the [SSL certificate and private key file](#general-subscription-credentials-needed-for-deployments) associated with your 5 NGINX App Protect WAF subscription from the MyF5 Customer Portal if you do not plan of using NGINX Plus in your deployment.
46-
- Download the [SSL certificate and private key file](#general-subscription-credentials-needed-for-deployments), and the [JWT license](#additional-subscription-credentials-needed-for-a-deployments-with-nginx-plus) file associated with your NGINX Plus subscription from the MyF5 Customer Portal if you plan of using NGINX Plus in your deployment.
47-
- [Docker registry credentials](#additional-subscription-credentials-needed-for-deployments) are needed to access private-registry.nginx.com
40+
- [A functional Kubernetes cluster](https://kubernetes.io/docs/setup/) (installed and running).
41+
- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) configured and connected to your cluster.
42+
- [Docker](https://docs.docker.com/engine/install/) (with Docker Compose) installed and running, for pulling and managing container images.
43+
- Ensure you have an active F5 WAF for NGINX subscription (purchased or trial) and have downloaded the associated [SSL certificate, private key, and JWT license](#download-your-subscription-credentials) file from the MyF5 Customer Portal.
44+
- [Docker registry credentials](#additional-subscription-credentials-needed-for-deployments) for private-registry.nginx.com, required to pull images
45+
- [Helm](https://helm.sh/docs/intro/install/) installed, required for deployment.
4846

4947
## Default security policy and logging profile
5048

5149
F5 WAF for NGINX uses built-in default security policy and logging profile after installation. To use custom policies or logging profiles, update your NGINX configuration file accordingly.
5250

5351
## Download your subscription credentials
5452

55-
### General subscription credentials needed for deployments
56-
57-
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
58-
59-
### Additional subscription credentials needed for deployments
60-
61-
To use NGINX Plus and access private-registry.nginx.com, you will need to download the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
53+
{{< call-out "note" >}}
54+
To access private-registry.nginx.com, you will need to download the JWT license file even when using NGINX Open Source as a base image.
55+
{{< /call-out >}}
6256

6357
{{< call-out "note" >}}
6458
If you are deploying with Helm, you will also need the JWT license for the `dockerConfigJson`.
@@ -69,7 +63,7 @@ If you are deploying with Helm, you will also need the JWT license for the `dock
6963
{{< call-out "note" >}} Starting from [NGINX Plus Release 33]({{< ref "nginx/releases.md#r33" >}}), a JWT file is required for each NGINX Plus instance. For more information, see [About Subscription Licenses]({{< ref "/solutions/about-subscription-licenses.md">}}). {{< /call-out >}}
7064

7165
{{< call-out "note" >}}
72-
Setting `appprotect.config.nginxJWT` with the `--set` flag in your Helm command automatically copies the JWT license to `/etc/nginx/license.jwt` inside the NGINX container. No manual JWT file copying or mounting is needed.
66+
When using the provided values.yaml for Helm, setting the `appprotect.config.nginxJWT` value ensures that your JWT license is automatically copied to `/etc/nginx/license.jwt` inside the NGINX container. No additional manual copying of the file is needed when deploying with the provided YAML configuration.
7367
{{< /call-out >}}
7468

7569
## Prepare environment variables

content/waf/install/kubernetes.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,12 @@ It explains the common steps necessary for any Kubernetes-based deployment, then
1919
To complete this guide, you will need the following pre-requisites:
2020

2121
- A [supported operating system]({{< ref "/waf/fundamentals/technical-specifications.md#supported-operating-systems" >}}).
22-
- [A functional Kubernetes cluster](https://kubernetes.io/docs/setup/) TODO add reason for it.
23-
- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) configured and connected to your cluster TODO add reason for it..
24-
- [Docker](https://docs.docker.com/engine/install/) (with Docker compose) installed and running TODO add reason for it.
25-
- An active F5 WAF for NGINX subscription in [MyF5](https://my.f5.com/manage/s/) (Purchased or trial).
26-
- Download the [SSL certificate and private key file](#general-subscription-credentials-needed-for-deployments) associated with your f5 NGINX App Protect WAF subscription from the MyF5 Customer Portal if you plan of using NGINX Open Source in your deployment.
27-
- Download the [SSL certificate, private key, and the JWT license](#additional-subscription-credentials-needed-for-deployments) file associated with your NGINX Plus subscription from the MyF5 Customer Portal if you plan of using NGINX Plus in your deployment.
28-
- [Docker registry credentials](#additional-subscription-credentials-needed-for-deployments) are needed to access private-registry.nginx.com
29-
30-
You will need [Helm](https://helm.sh/docs/intro/install/) installed for a Helm-based deployment.
22+
- [A functional Kubernetes cluster](https://kubernetes.io/docs/setup/) (installed and running).
23+
- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) configured and connected to your cluster.
24+
- [Docker registry credentials](#additional-subscription-credentials-needed-for-deployments) for private-registry.nginx.com, required to pull images
25+
- Ensure you have an active F5 WAF for NGINX subscription (purchased or trial) and have downloaded the associated [SSL certificate, private key, and JWT license](#download-your-subscription-credentials) file from the MyF5 Customer Portal.
26+
- [Access credentials](#additional-subscription-credentials-needed-for-deployments) for private-registry.nginx.com for pulling deployment images.
27+
- [Helm](https://helm.sh/docs/intro/install/) installed, required for deployment.
3128

3229
You should read the [IP intelligence]({{< ref "/waf/policies/ip-intelligence.md" >}}) and [Secure traffic using mTLS]({{< ref "/waf/configure/secure-mtls.md" >}}) topics for additional set-up configuration if you want to use them immediately.
3330

@@ -39,13 +36,9 @@ F5 WAF for NGINX uses built-in default security policy and logging profile after
3936

4037
## Download your subscription credentials
4138

42-
### General subscription credentials needed for deployments
43-
44-
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
45-
46-
### Additional subscription credentials needed for deployments
47-
48-
To use NGINX Plus and access private-registry.nginx.com, you will need to download the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
39+
{{< call-out "note" >}}
40+
To access private-registry.nginx.com, you will need to download the JWT license file even when using NGINX Open Source as a base image.
41+
{{< /call-out >}}
4942

5043
{{< call-out "note" >}}
5144
If you are deploying with Helm, you will also need the JWT license for the `dockerConfigJson`.
@@ -272,7 +265,7 @@ cd nginx-app-protect
272265

273266
You will need to edit the `values.yaml` file for a few changes:
274267

275-
- Update _appprotect.nginx.image.repository_ and _appprotect.nginx.image.tag_ with the image name chosen during when [building the Docker image](#build-the-docker-image).
268+
- Update _appprotect.nginx.image.repository_ and _appprotect.nginx.image.tag_ with the image name chosen during when [building the Docker image](#build-the-docker-image).
276269
- Update _appprotect.config.nginxJWT_ with your JSON web token (Only necessary when using NGINX Plus)
277270
- Update _dockerConfigJson_ to contain the base64 encoded Docker registration credentials
278271

content/waf/install/virtual-environment.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ This page describes how to install F5 WAF for NGINX in a virtual machine or bare
2323
To complete this guide, you will need the following prerequisites:
2424

2525
- A [supported operating system]({{< ref "/waf/fundamentals/technical-specifications.md#supported-operating-systems" >}}).
26-
- An active F5 WAF for NGINX subscription. Available from [MyF5](https://my.f5.com/manage/s/) (Purchased or trial).
27-
- Download the [SSL certificate, private key, and the JWT license](#download-your-subscription-credentials) file associated with your F5 WAF for NGINX subscription from the MyF5 Customer Portal.
26+
- Ensure you have an active F5 WAF for NGINX subscription (purchased or trial) and have downloaded the associated [SSL certificate, private key, and JWT license](#download-your-subscription-credentials) file from the MyF5 Customer Portal.
2827
- A working [NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}). If NGINX Plus is not installed separately it will be installed automatically during F5 WAF for NGINX installation.
2928

3029
Depending on your deployment type, you may have additional requirements:
@@ -39,15 +38,9 @@ F5 WAF for NGINX uses built-in default security policy and logging profile after
3938

4039
## Download your subscription credentials
4140

42-
### General subscription credentials needed for deployments
43-
44-
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
45-
46-
### Additional subscription credentials needed for deployments
47-
4841
To use NGINX Plus, you will need to download the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
4942

50-
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
43+
{{< include "licensing-and-reporting/download-jwt-ssl-key-from-myf5.md" >}}
5144

5245
{{< call-out "note" >}} Starting from [NGINX Plus Release 33]({{< ref "nginx/releases.md#r33" >}}), a JWT file is required for each NGINX Plus instance. For more information, see [About Subscription Licenses]({{< ref "/solutions/about-subscription-licenses.md">}}). {{< /call-out >}}
5346

content/waf/policies/ip-intelligence.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,15 @@ tail -f iprepd.log
7676

7777
Once complete, you can now [Configure policies for IP intelligence](#configure-policies-for-ip-intelligence).
7878

79-
### Modify Docker compose file
79+
### Modify Docker Compose file
8080

8181
{{< call-out "warning" >}}
8282

8383
This section **only** applies to installations using Docker.
8484

8585
{{< /call-out >}}
8686

87-
IP intelligence has its own Docker container, which can be added to an existing Docker compose file for deployment.
87+
IP intelligence has its own Docker container, which can be added to an existing Docker Compose file for deployment.
8888

8989
First, create the required directory:
9090

0 commit comments

Comments
 (0)