Skip to content

Conversation

@dkleinF5
Copy link

@dkleinF5 dkleinF5 commented Nov 25, 2025

Proposed changes

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@dkleinF5 dkleinF5 requested a review from a team as a code owner November 25, 2025 14:32
@github-actions github-actions bot added documentation Improvements or additions to documentation product/waf Issues related to F5 WAF for NGINX labels Nov 25, 2025
@github-actions
Copy link

github-actions bot commented Nov 25, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@github-actions
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/1485/

@dkleinF5 dkleinF5 changed the title docs: add missing prerequisite for installation [Draft] docs: add missing prerequisite for installation Nov 25, 2025
@dkleinF5 dkleinF5 requested a review from a team as a code owner November 26, 2025 08:08
@dkleinF5
Copy link
Author

I have hereby read the F5 CLA and agree to its terms

@dkleinF5 dkleinF5 force-pushed the waf/missing-prerequisite branch from d366350 to dc87dc4 Compare November 27, 2025 07:11
@ADubhlaoich ADubhlaoich self-requested a review November 27, 2025 11:11
@ADubhlaoich ADubhlaoich changed the base branch from main to waf-release-5.10 November 28, 2025 16:57
@ADubhlaoich ADubhlaoich changed the base branch from waf-release-5.10 to main December 1, 2025 10:09
@dkleinF5 dkleinF5 force-pushed the waf/missing-prerequisite branch from c0adb94 to d54baa0 Compare December 1, 2025 12:34
@dkleinF5 dkleinF5 changed the title [Draft] docs: add missing prerequisite for installation Docs: add missing prerequisite for installation Dec 1, 2025
@dkleinF5 dkleinF5 force-pushed the waf/missing-prerequisite branch from d54baa0 to 9f5a581 Compare December 1, 2025 17:13
Copy link
Contributor

@JTorreG JTorreG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a TODO label

@dkleinF5 dkleinF5 force-pushed the waf/missing-prerequisite branch from dfc4c24 to 04698aa Compare December 2, 2025 07:57
Copy link
Member

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally LGTM: approval pending feedback.

Please run the linting tools on this branch, which can be executed automatically with pre-commit.

Copy link
Member

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some more minor changes for content flow and formatting.

Comment on lines 21 to 23
- An active F5 WAF for NGINX subscription. Available from [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
- Download the [SSL certificate and private key file]({{< ref "/waf/install/docker.md#General subscription credentials needed for deployments" >}}) associated with your F5 WAF for NGINX WAF subscription from the MyF5 Customer Portal if you are using NGINX Open Source in your deployment.
- Download the [SSL certificate and private key file]({{< ref "/waf/install/docker.md#General subscription credentials needed for deployments" >}}), and the [JWT license file]({{< ref "/waf/install/docker.md#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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- An active F5 WAF for NGINX subscription. Available from [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
- Download the [SSL certificate and private key file]({{< ref "/waf/install/docker.md#General subscription credentials needed for deployments" >}}) associated with your F5 WAF for NGINX WAF subscription from the MyF5 Customer Portal if you are using NGINX Open Source in your deployment.
- Download the [SSL certificate and private key file]({{< ref "/waf/install/docker.md#General subscription credentials needed for deployments" >}}), and the [JWT license file]({{< ref "/waf/install/docker.md#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.
- An active F5 WAF for NGINX subscription. Available from [MyF5](https://my.f5.com/manage/s/) (Purchased or trial).

Hyperlinking a later section could cause the reader to skip additional important context in this section.

The instructions with the links are also redundant: there's no point linking to the same place twice.

The majority of readers will be reading the page sequentially from top to bottom, so there is no need to add extra emphasis to a requirement you will be giving them instructions to fulfill anyway.

Comment on lines 34 to 45
## Download your subscription credentials
### General subscription credentials needed for deployments

{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}

### Additional subscription credentials needed for deployments
To use NGINX Plus and access private-registry.nginx.com, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Download your subscription credentials
### General subscription credentials needed for deployments
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
### Additional subscription credentials needed for deployments
To use NGINX Plus and access private-registry.nginx.com, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
## Download your subscription credentials
### General subscription credentials needed for deployments
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}
### Additional subscription credentials needed for deployments
To use NGINX Plus and access private-registry.nginx.com, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}

All headings are meant to be surrounded by blank lines, which are detected by the linting tools on this branch, which can be executed automatically with pre-commit.

These requirements will be directly enforced by CI/CD in the future, so I recommend you begin using these tools.

Comment on lines 44 to 46
- An ctive F5 WAF for NGINX subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
- 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.
- Download the [SSL certificate and private key file]({{< ref "/waf/install/kubernetes-plm.md#General subscription credentials needed for deployments" >}}), 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- An ctive F5 WAF for NGINX subscription in [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
- 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.
- Download the [SSL certificate and private key file]({{< ref "/waf/install/kubernetes-plm.md#General subscription credentials needed for deployments" >}}), 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.
- An active F5 WAF for NGINX subscription in [MyF5](https://my.f5.com/manage/s/) (Purchased or trial).

See earlier note about redundancy.


{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}}

### Additional subscription credentials needed for deployments
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Additional subscription credentials needed for deployments
### Additional subscription credentials needed for deployments

Comment on lines 26 to 28
- An active F5 WAF for NGINX subscription. Available from [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
- Download the [SSL certificate, private key, and the JWT license]({{< ref "/waf/install/virtual-environment.md#Download your subscription credentials" >}}) file associated with your F5 WAF for NGINX subscription from the MyF5 Customer Portal.
- 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- An active F5 WAF for NGINX subscription. Available from [MyF5](https://my.f5.com/manage/s/) (purchased or trial).
- Download the [SSL certificate, private key, and the JWT license]({{< ref "/waf/install/virtual-environment.md#Download your subscription credentials" >}}) file associated with your F5 WAF for NGINX subscription from the MyF5 Customer Portal.
- 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.
- An active F5 WAF for NGINX subscription. Available from [MyF5](https://my.f5.com/manage/s/) (Purchased or trial).

@dkleinF5 dkleinF5 force-pushed the waf/missing-prerequisite branch 2 times, most recently from 5645ca7 to 23eddc1 Compare December 3, 2025 15:34
@dkleinF5 dkleinF5 requested a review from ADubhlaoich December 3, 2025 15:34
@dkleinF5 dkleinF5 force-pushed the waf/missing-prerequisite branch from 6826e84 to 219e2d9 Compare December 4, 2025 13:33

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To build an image for NGINX Plus, use the following command that are not RHEL-based, replacing `<your-image-name>` as appropriate:
To build an image for NGINX Plus, use the following command that is not RHEL-based, replacing `<your-image-name>` as appropriate:


### Additional subscription credentials needed for deployments

To use NGINX Plus and access private-registry.nginx.com, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To use NGINX Plus and access private-registry.nginx.com, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
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:

- _Dockerfile_
- _custom_log_format.json_

To build an image, use the following command for system that are not RHEL-based, replacing `<your-image-name>` as appropriate:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To build an image, use the following command for system that are not RHEL-based, replacing `<your-image-name>` as appropriate:
To build an image, use the following command for a system that is not RHEL-based, replacing `<your-image-name>` as appropriate:


#### Download Docker images

[Access to NGINX repo private-registry.nginx.com]({{< ref "/waf/install/docker.md#Configure Docker for the F5 Container Registry" >}}) is needed to pull the following container images
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Access to NGINX repo private-registry.nginx.com]({{< ref "/waf/install/docker.md#Configure Docker for the F5 Container Registry" >}}) is needed to pull the following container images
[Access to NGINX repo private-registry.nginx.com]({{< ref "/waf/install/docker.md#configure-docker-for-the-f5-container-registry" >}}) is needed to pull the following container images


#### Download Docker images

[Access to NGINX repo private-registry.nginx.com]({{< ref "/waf/install/docker.md#Configure Docker for the F5 Container Registry" >}}) is needed to pull the following container images
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Access to NGINX repo private-registry.nginx.com]({{< ref "/waf/install/docker.md#Configure Docker for the F5 Container Registry" >}}) is needed to pull the following container images
[Access to NGINX repo private-registry.nginx.com]({{< ref "/waf/install/docker.md#configure-docker-for-the-f5-container-registry" >}}) is needed to pull the following container images


### Additional subscription credentials needed for deployments

To use NGINX Plus and access private-registry.nginx.com, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To use NGINX Plus and access private-registry.nginx.com, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
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:


### Additional subscription credentials needed for deployments

To use NGINX Plus and access private-registry.nginx.com, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To use NGINX Plus and access private-registry.nginx.com, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
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:


### Additional subscription credentials needed for deployments

To use NGINX Plus, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To use NGINX Plus, you will need to download the the JWT license file associated with your F5 WAF for NGINX WAF subscription from the [MyF5](https://my.f5.com/manage/s/) Customer Portal:
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:

```

#### Building an image with NGINX Open Source
To build an image for NGINX Open Source, use the following command that are not RHEL-based, replacing `<your-image-name>` as appropriate:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To build an image for NGINX Open Source, use the following command that are not RHEL-based, replacing `<your-image-name>` as appropriate:
To build an image for NGINX Open Source, use the following command that is not RHEL-based, replacing `<your-image-name>` as appropriate:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/waf Issues related to F5 WAF for NGINX

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants