Skip to content

Commit dad8210

Browse files
committed
made changes from suggestions
1 parent d55253b commit dad8210

File tree

5 files changed

+109
-23
lines changed

5 files changed

+109
-23
lines changed

content/includes/waf/install-build-image.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ Your folder should contain the following files:
1111
- _nginx.conf_
1212
- _entrypoint.sh_
1313
- _Dockerfile_
14-
- _custom_log_format.json_ (Optional)
14+
- _custom_log_format.json_
1515

16-
To build an image for NGINX Plus, use the following command, replacing `<your-image-name>` as appropriate:
16+
#### Building an image with NGINX Plus
17+
To build an image for NGINX Plus, use the following command that are not RHEL-based, replacing `<your-image-name>` as appropriate:
1718

1819
```shell
1920
sudo docker build --no-cache --platform linux/amd64 --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-key,src=nginx-repo.key --secret id=license-jwt,src=license.jwt -t <your-image-name> .
@@ -25,7 +26,8 @@ A RHEL-based system would use the following command instead:
2526
podman build --no-cache --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-key,src=nginx-repo.key --secret id=license-jwt,src=license.jwt -t <your-image-name> .
2627
```
2728

28-
To build an image for NGINX Open Source, use the following command, replacing `<your-image-name>` as appropriate:
29+
#### Building an image with NGINX Open Source
30+
To build an image for NGINX Open Source, use the following command that are not RHEL-based, replacing `<your-image-name>` as appropriate:
2931

3032
```shell
3133
sudo docker build --no-cache --platform linux/amd64 --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-key,src=nginx-repo.key -t <your-image-name> .

content/waf/install/docker.md

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,13 @@ This page describes how to install F5 WAF for NGINX using Docker.
1616

1717
To complete this guide, you will need the following prerequisites:
1818

19+
- A [supported operating system]({{< ref "/waf/fundamentals/technical-specifications.md#supported-operating-systems" >}}).
1920
- Active F5 NGINX App Protect WAF subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial)
2021
- [Docker](https://docs.docker.com/engine/install/) (with Docker compose) installed and running.
21-
- Docker registry credentials are needed to access private-registry.nginx.com (For Multi-container and Hybrid configuration)
22+
- Active F5 NGINX App Protect WAF subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
23+
- Download the [SSL certificate and private key file]({{< ref "/waf/install/docker.md#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.
24+
- Download the [SSL certificate, private key, and the JWT license file]({{< ref "/waf/install/docker.md#General subscription credentials needed for deployments" >}}) associated with your NGINX Plus subscription from the MyF5 Customer Portal if you plan of using NGINX Plus in your deployment.
25+
- [Docker registry credentials]({{< ref "/waf/install/docker.md#Additional Requirement for NGINX Plus Users" >}}) are needed to access private-registry.nginx.com (For Multi-container and Hybrid configuration)
2226

2327
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.
2428

@@ -52,7 +56,15 @@ The steps you should follow on this page are dependent on your configuration typ
5256

5357
## Configure Docker for the F5 Container Registry
5458

55-
{{< include "waf/install-services-registry.md" >}}
59+
You will need Docker registry credentials to access private-registry.nginx.com for either the Multi-container or Hybrid configuration.
60+
61+
Create a directory and copy your [certificate and key]({{< ref "/waf/install/docker.md#Shared Requirements" >}}) to this directory:
62+
63+
```shell
64+
mkdir -p /etc/docker/certs.d/private-registry.nginx.com
65+
cp <path-to-your-nginx-repo.crt> /etc/docker/certs.d/private-registry.nginx.com/client.cert
66+
cp <path-to-your-nginx-repo.key> /etc/docker/certs.d/private-registry.nginx.com/client.key
67+
```
5668

5769
You should now move to the section based on your configuration type:
5870

@@ -312,7 +324,51 @@ If you are not using using `custom_log_format.json` or the IP intelligence featu
312324

313325
### Build the Docker image
314326

315-
{{< include "waf/install-build-image.md" >}}
327+
Your folder should contain the following files:
328+
329+
- _nginx-repo.crt_
330+
- _nginx-repo.key_
331+
- _license.jwt_
332+
- _nginx.conf_
333+
- _entrypoint.sh_
334+
- _Dockerfile_
335+
- _custom_log_format.json_
336+
337+
To build an image, use the following command for system that are not RHEL-based, replacing `<your-image-name>` as appropriate:
338+
339+
```shell
340+
sudo docker build --no-cache --platform linux/amd64 --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-key,src=nginx-repo.key --secret id=license-jwt,src=license.jwt -t <your-image-name> .
341+
```
342+
343+
A RHEL-based system would use the following command instead:
344+
345+
```shell
346+
podman build --no-cache --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-key,src=nginx-repo.key --secret id=license-jwt,src=license.jwt -t <your-image-name> .
347+
```
348+
349+
{{< call-out "note" >}}
350+
351+
The `--no-cache` option is used to ensure the image is built from scratch, installing the latest versions of NGINX Plus and F5 WAF for NGINX.
352+
353+
{{< /call-out >}}
354+
355+
Verify that your image has been created using the `docker images` command:
356+
357+
```shell
358+
docker images <your-image-name>
359+
```
360+
361+
Create a container based on this image, replacing <your-container-name> as appropriate:
362+
363+
```shell
364+
docker run --name <your-container-name> -p 80:80 -d <your-image-name>
365+
```
366+
367+
Verify the new container is running using the `docker ps` command:
368+
369+
```shell
370+
docker ps
371+
```
316372

317373
### Update configuration files
318374

content/waf/install/kubernetes-plm.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,30 @@ These enhancements are only available for Helm-based deployments.
3636

3737
To complete this guide, you will need the following prerequisites:
3838

39+
- A [supported operating system]({{< ref "/waf/fundamentals/technical-specifications.md#supported-operating-systems" >}}).
3940
- [A functional Kubernetes cluster](https://kubernetes.io/docs/setup/)
4041
- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) configured and connected to your cluster
4142
- [Helm](https://helm.sh/docs/intro/install/)
4243
- [Docker](https://docs.docker.com/engine/install/) (with Docker compose) installed and running.
43-
- Docker registry credentials are needed to access private-registry.nginx.com
44-
- Active F5 NGINX App Protect WAF subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial)
44+
- Active F5 NGINX App Protect WAF subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial), which includes the necessary **SSL Certificate** and **Private Key files**.
45+
- Active F5 NGINX App Protect WAF subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
46+
- Download the [SSL certificate and private key file]({{< ref "/waf/install/kubernetes-plm.md#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.
47+
- Download the [SSL certificate, private key, and the JWT license]({{< ref "/waf/install/kubernetes-plm.md#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.
48+
- Docker registry credentials in [MyF5](https://my.f5.com/manage/s/) required to access private-registry.nginx.com. (Same as the **JSON Web Token** for NGINX Plus).
4549

4650
## Download your subscription credentials
4751

48-
1. Log in to [MyF5](https://my.f5.com/manage/s/).
49-
1. Go to **My Products & Plans > Subscriptions** to see your active subscriptions.
50-
1. Find your NGINX subscription, and select the **Subscription ID** for details.
51-
1. Download the **SSL Certificate** and **Private Key files** from the subscription page.
52-
1. Download the **JSON Web Token** file from the subscription page.
52+
### General subscription credentials needed for deployments
53+
54+
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
55+
56+
### Additional subscription credentials needed for a deployments with NGINX Plus
57+
58+
To use NGINX Plus, you will need to download the the JWT license file associated with your F5 NGINX App Protect WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
59+
60+
> **Note:** If you are deploying with Helm, you will also need the JWT license for the `dockerConfigJson`.
61+
62+
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
5363

5464
## Prepare environment variables
5565

content/waf/install/kubernetes.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,14 @@ It explains the common steps necessary for any Kubernetes-based deployment, then
1818

1919
To complete this guide, you will need the following pre-requisites:
2020

21-
- [A functional Kubernetes cluster](https://kubernetes.io/docs/setup/)
22-
- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) configured and connected to your cluster
23-
- Active F5 NGINX App Protect WAF subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial)
21+
- A [supported operating system]({{< ref "/waf/fundamentals/technical-specifications.md#supported-operating-systems" >}}).
22+
- [A functional Kubernetes cluster](https://kubernetes.io/docs/setup/).
23+
- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) configured and connected to your cluster.
2424
- [Docker](https://docs.docker.com/engine/install/) (with Docker compose) installed and running.
25-
- Docker registry credentials are needed to access private-registry.nginx.com
25+
- Active F5 NGINX App Protect WAF subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
26+
- Download the [SSL certificate and private key file]({{< ref "/waf/install/kubernetes.md#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.
27+
- Download the [SSL certificate, private key, and the JWT license]({{< ref "/waf/install/kubernetes.md#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.
28+
- Docker registry credentials in [MyF5](https://my.f5.com/manage/s/) is required to access private-registry.nginx.com (Same as the SSL certificate and private key file ).
2629

2730
You will need [Helm](https://helm.sh/docs/intro/install/) installed for a Helm-based deployment.
2831

@@ -34,11 +37,14 @@ To review supported operating systems, read the [Technical specifications]({{< r
3437

3538
## Download your subscription credentials
3639

40+
### General subscription credentials needed for deployments
41+
3742
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
3843

39-
### Download your JSON web token
44+
### Additional subscription credentials needed for a deployments with NGINX Plus
45+
46+
To use NGINX Plus, you will need to download the the JWT license file associated with your F5 NGINX App Protect WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
4047

41-
To use NGINX Plus, you will need to download the the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:
4248
> **Note:** If you are deploying with Helm, you will also need the JWT license for the `dockerConfigJson`.
4349
4450
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}

content/waf/install/virtual-environment.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,28 @@ 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-
- Active F5 NGINX App Protect WAF subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial)
26+
Active F5 NGINX App Protect WAF subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
27+
- Download the [SSL certificate and private key file]({{< ref "/waf/install/virtual-environment.md#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.
28+
- Download the [SSL certificate, private key, and the JWT license]({{< ref "/waf/install/virtual-environment.md#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.
2729
- A working [NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) optional if not yet installed (NGINX will be installed automatically during F5 WAF for NGINX installation)
30+
- F5 NGINX App Protect will work by default with the default values (like default policy, logging profile, etc) unless the user sets custom configurations
2831

2932
Depending on your deployment type, you may have additional requirements:
3033

31-
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.
34+
You should read the [IP intelligence]({{< ref "/waf/policies/ip-intelligence.md" >}}) topics for additional set-up configuration if you want to use them immediately.
3235

3336
{{< include "waf/install-selinux-warning.md" >}}
34-
### Required: Download JWT License for NGINX Plus Installation
35-
If you choose to install NGINX automatically with F5 WAF for NGINX, make sure to download your JWT license from MyF5 before you begin
37+
## Download your subscription credentials
38+
39+
### General subscription credentials needed for deployments
40+
41+
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
42+
43+
### Additional subscription credentials needed for a deployments with NGINX Plus
44+
45+
To use NGINX Plus, you will need to download the the JWT license file associated with your F5 NGINX App Protect WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
46+
47+
3648
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
3749

3850
## Platform-specific instructions

0 commit comments

Comments
 (0)