Add document for installing NGF on OpenShift through OperatorHub #1332

shaun-nx · 2025-10-20T09:20:47Z

Proposed changes

This change adds a new page to the NGF Install section on how to install the NGF on OpenShift using the RedHat Operator Hub.

This guide also includes Operator specific configurations as well as troubleshooting.

Closes nginx/nginx-gateway-fabric#3911

Checklist

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

I read the Contributing guidelines
My branch adheres to the Git conventions
My content changes adhere to the F5 NGINX Documentation style guide
If my changes involve potentially sensitive information¹, I have assessed the possible impact
I have waited to ensure my changes pass tests, and addressed any discovered issues

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

Update compatability doc with Port for ParentRef

Update gateway addresses compatibility document.

…omment (#1126) Add a small comment on IP families to gateway addresses compatibility document.

Added mention about unsupported fields for RouteRules and Gateways Closes nginx/nginx-gateway-fabric#3784

feat: Update advanced routing guide for regex path

…cs (#1284) * Add details on BuildOS and InferencePoolCount to Product Telemetry docs * Add InferencePoolCount * Move InferencePool resource into "Count of Resources" section

github-actions · 2025-10-20T09:22:54Z

✅ Deploy Preview will be available once build job completes!

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

content/ngf/install/openshift.md

shaun-nx · 2025-10-21T16:13:22Z

Changing the base branch to main as we need to wait until we have fully published the Operator to Openshift before making this doc available

content/ngf/install/openshift.md

content/ngf/overview/gateway-api-compatibility.md

salonichf5

mentioned a couple of nits but overall looks good. I think this branch needs a rebase with main

great job 🥳

tataruty · 2025-10-22T11:29:50Z

Changing the base branch to main as we need to wait until we have fully published the Operator to Openshift before making this doc available

Did you change base branch too? or only the aim of merge? I see many commits difference

ADubhlaoich

Broadly speaking, the new page needs to be restructured.

It doesn't adhere to our contemporary page standards:

It's missing the documentation metadata
The requirements section is not named correctly
It uses the NGF three letter acronym: we do not use TLAs in public-facing documentation
It uses bash as a formatting language, when shell has been the norm for months
It doesn't use Hugo for list enumeration

Many of the structural issues could have been avoided by using Hugo archetypes, for which we maintain documentation which is part of the Contributing guidelines as the first item in the PR checklist.

Effectively no commits on this branch adhere to the Git conventions as the second item in the PR checklist, though this does not need to be fixed in retrospect as long as the eventual merge message is correct.

shaun-nx · 2025-10-24T15:14:47Z

I made changes to the PR to reflect these points of feedback:

It uses the NGF three letter acronym: we do not use TLAs in public-facing documentation
It uses bash as a formatting language, when shell has been the norm for months

I'm confused by these points

Effectively no commits on this branch adhere to the Git conventions as the second item in the PR checklist

The second items says My branch adheres to the Git conventions. This relates to just the branch, and not the individual commit messages from what I understand. This was never called out as a problem before.

It's missing the documentation metadata

There is a Title and Description in this document. Is there other metadata missing? The most reset set of commits adds nd-content-type, nd-product and nd-docs. Were you referring to these?

The requirements section is not named correctly

This document doesn't have a requirements section at all, so it's not clear what you mean by this. Should we have a requirements section?

It doesn't use Hugo for list enumeration

Again, not sure what this means. The Hugo Content page says **The ordered notation automatically enumerates lists when built by Hugo** but it's still not clear what that relates to.
I did run make docs locally but I'm not sure if that really affected anything regarding this point.

As a point of feedback for the feedback,
If the use shell instead of bash is really important then it feels like that should be enforced by a pre-commit check, especially if it's something that we are willing to block a PR on.

mjang

This is pretty good. I'm guessing that go.mod and go.sum are not part of your proposed change.

content/ngf/install/openshift.md

Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com>

content/ngf/install/openshift.md

ciarams87 · 2025-10-29T08:40:53Z

content/ngf/install/openshift.md

+
+### Create the NginxGatewayFabric custom resource
+
+Create a minimal `NginxGatewayFabric` custom resource for OpenShift. Include this code in a file named `nginx-gateway-fabric.yaml`.


When we install the operator using the OperatorHub, this can be done in the UI

Would it help to say "This can be done in the UI, optionally you can choose to apply the resource directly to the cluster"

Do you have an example of what that looks like in the UI? I didn't apply this in the UI when testing with OKD at the time.

I don't have an example, I'd need access to a cluster, but it would likely be the standard way someone would install an operand (i.e. the NGF control plane in this case).

The flow is:

Click the Create NginxGatewayFabric in the NGINX Gateway Fabric Operator tab.
Toggle the Configure via YAML view to on.
Add the YAML as specified in this example.
Click "Create"

Sounds good. I'll make that adjustment. Thanks @ciarams87 😃

@ciarams87 this should be updated now

go.sum

JTorreG · 2025-10-29T12:05:37Z

I have addressed everything except this in Slack.
leaving this one for @ADubhlaoich

The requirements section is not named correctly

This document doesn't have a requirements section at all, so it's not clear what you mean by this. Should we have a requirements section?

bjee19 · 2025-10-29T19:51:18Z

content/ngf/install/openshift.md

+  1. Navigate to the Red Hat Catalog: https://catalog.redhat.com/en  
+  1. Search for "NGINX Gateway Fabric Operator" in the searchbar at the top
+  1. Select NGINX Gateway Fabric Operator
+  1. Select **Deploy & use**. 


nit: either periods on all bullet items or none

Suggested change

1. Select **Deploy & use**.

1. Select **Deploy & use**

bjee19 · 2025-10-29T19:52:28Z

content/ngf/install/openshift.md

+
+## Integrate with NGINX One Console (optional)
+
+If you want to use NGINX One Console to monitor NGINX Gateway Fabric, create a secret for the dataplane key (replace VALUE with your key).


Might be good to link to our other documentation on setting up this secret / using N1c. Though this could also be fine too.

bjee19 · 2025-10-29T19:56:10Z

content/ngf/install/openshift.md

+  -n nginx-gateway-fabric
+```
+
+Reference this secret in `spec.nginx.nginxOneConsole.dataplaneKeySecretName`.


I feel like more information should be given here. If NGF is already deployed, they'll need to modify the deployment flags I think.

Actually are these on the NginxGatewayFabric talked about below?

bjee19 · 2025-10-29T19:56:23Z

content/ngf/install/openshift.md

+
+## Configure NGINX Plus licensing (optional)
+
+If you plan to use NGINX Plus, set `spec.nginx.plus: true`, add image pull credentials, and create a license secret if needed.


Same as above

sarthyparty and others added 11 commits September 3, 2025 10:16

Update compability doc (#1054)

de86f56

Update compatability doc with Port for ParentRef

NGF: Update gateway addresses compatibility document (#1109)

ecb9222

Update gateway addresses compatibility document.

NGF: Update gateway addresses compatibility document with IP family c…

29a305d

…omment (#1126) Add a small comment on IP families to gateway addresses compatibility document.

New NGF CLI parameter for Trial period enforcement (#1128)

8d59f42

Merge branch 'main' into ngf-release-2.2

bf2aedf

RouteRules and Gateway unsupported fields update (#1268)

6822326

Added mention about unsupported fields for RouteRules and Gateways Closes nginx/nginx-gateway-fabric#3784

NGF: Update advanced routing guide for Regex PathType (#1286)

4b0aa63

feat: Update advanced routing guide for regex path

Merge branch 'main' into ngf-release-2.2

56d6dce

Add details on BuildOS and InferencePoolCount to Product Telemetry do…

2138ce5

…cs (#1284) * Add details on BuildOS and InferencePoolCount to Product Telemetry docs * Add InferencePoolCount * Move InferencePool resource into "Count of Resources" section

Merge branch 'main' into ngf-release-2.2

d67906e

Add document for installing NGF on Openshift through OperatorHub

a03edd0

shaun-nx requested a review from a team as a code owner October 20, 2025 09:20

github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Oct 20, 2025

tataruty reviewed Oct 20, 2025

View reviewed changes

content/ngf/install/openshift.md Outdated Show resolved Hide resolved

shaun-nx requested a review from a team October 20, 2025 15:03

shaun-nx changed the base branch from ngf-release-2.2 to main October 21, 2025 16:12

Merge branch 'main' into ngf/openshift-install

61fc33b

salonichf5 reviewed Oct 21, 2025

View reviewed changes

content/ngf/install/openshift.md Outdated Show resolved Hide resolved

salonichf5 reviewed Oct 21, 2025

View reviewed changes

content/ngf/install/openshift.md Outdated Show resolved Hide resolved

salonichf5 reviewed Oct 21, 2025

View reviewed changes

content/ngf/overview/gateway-api-compatibility.md Show resolved Hide resolved

salonichf5 reviewed Oct 21, 2025

View reviewed changes

Merge branch 'main' into ngf/openshift-install

f075835

ADubhlaoich requested changes Oct 22, 2025

View reviewed changes

ADubhlaoich and others added 3 commits October 22, 2025 14:18

Merge branch 'main' into ngf/openshift-install

3b76707

Merge branch 'main' into ngf/openshift-install

b700813

Merge branch 'main' into ngf/openshift-install

b49beab

shaun-nx added 4 commits October 24, 2025 15:21

Update document to follow "How-to-guide" format

f0e129c

Replace bash with shell

6cd31ce

Fix pre-commit errors

e5642d8

Fix pre-commit errors

0c077c7

shaun-nx requested review from ADubhlaoich, ciarams87, salonichf5 and tataruty October 24, 2025 15:15

mjang reviewed Oct 24, 2025

View reviewed changes

shaun-nx and others added 3 commits October 24, 2025 16:49

Update content/ngf/install/openshift.md

df1dd08

Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com>

Style updates

206474c

Revert changes to go.mod and go.sum

481f9b4

ciarams87 reviewed Oct 26, 2025

View reviewed changes

content/ngf/install/openshift.md Outdated Show resolved Hide resolved

ciarams87 reviewed Oct 26, 2025

View reviewed changes

content/ngf/install/openshift.md Show resolved Hide resolved

shaun-nx added 3 commits October 28, 2025 08:01

Merge branch 'main' into ngf/openshift-install

c4dd1f5

Remove results comment

cbfb720

Merge branch 'main' into ngf/openshift-install

4280760

shaun-nx requested review from ciarams87 and mjang October 29, 2025 08:24

ciarams87 reviewed Oct 29, 2025

View reviewed changes

go.sum Outdated Show resolved Hide resolved

shaun-nx added 3 commits October 29, 2025 08:51

Fix go.sum

78709b9

Update go mod and sum

5ef0e01

Add new line

4a41265

shaun-nx requested a review from ciarams87 October 29, 2025 11:23

shaun-nx added 2 commits October 29, 2025 16:47

Update steps for creating the NginxGatewayFabric resource

483a38d

Adjust headers and numbered lists

b1463fd

bjee19 reviewed Oct 29, 2025

View reviewed changes


		### Create the NginxGatewayFabric custom resource

		Create a minimal `NginxGatewayFabric` custom resource for OpenShift. Include this code in a file named `nginx-gateway-fabric.yaml`.


		## Integrate with NGINX One Console (optional)

		If you want to use NGINX One Console to monitor NGINX Gateway Fabric, create a secret for the dataplane key (replace VALUE with your key).


		## Configure NGINX Plus licensing (optional)

		If you plan to use NGINX Plus, set `spec.nginx.plus: true`, add image pull credentials, and create a license secret if needed.

Add document for installing NGF on OpenShift through OperatorHub #1332

Are you sure you want to change the base?

Add document for installing NGF on OpenShift through OperatorHub #1332

Uh oh!

Conversation

shaun-nx commented Oct 20, 2025

Proposed changes

Checklist

Footnotes

Uh oh!

github-actions bot commented Oct 20, 2025

✅ Deploy Preview will be available once build job completes!

Uh oh!

Uh oh!

shaun-nx commented Oct 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

salonichf5 left a comment

Choose a reason for hiding this comment

Uh oh!

tataruty commented Oct 22, 2025

Uh oh!

ADubhlaoich left a comment

Choose a reason for hiding this comment

Uh oh!

shaun-nx commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mjang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JTorreG commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

shaun-nx commented Oct 24, 2025 •

edited

Loading

JTorreG commented Oct 29, 2025 •

edited

Loading