-
Couldn't load subscription status.
- Fork 121
Add document for installing NGF on OpenShift through OperatorHub #1332
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 22 commits
de86f56
ecb9222
29a305d
8d59f42
bf2aedf
6822326
4b0aa63
56d6dce
2138ce5
d67906e
a03edd0
61fc33b
f075835
3b76707
b700813
b49beab
020f81c
892135f
f0e129c
6cd31ce
e5642d8
0c077c7
df1dd08
206474c
481f9b4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| title: Build NGINX Gateway Fabric | ||
| weight: 400 | ||
| weight: 500 | ||
| toc: true | ||
| nd-content-type: how-to | ||
| nd-product: NGF | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,220 @@ | ||||||
| --- | ||||||
| title: Install NGINX Gateway Fabric on OpenShift using OperatorHub | ||||||
| description: Deploy F5 NGINX Gateway Fabric on Red Hat OpenShift through OperatorHub and configure it using the NginxGatewayFabric custom resource. | ||||||
| weight: 400 | ||||||
| toc: true | ||||||
| nd-content-type: how-to | ||||||
| nd-product: NGF | ||||||
| nd-docs: DOCS-1851 | ||||||
| --- | ||||||
|
|
||||||
| ## Overview | ||||||
|
|
||||||
| This guide details how to install F5 NGINX Gateway Fabric on Red Hat OpenShift through OperatorHub and configure it with the `NginxGatewayFabric` custom resource. | ||||||
|
||||||
| This guide details how to install F5 NGINX Gateway Fabric on Red Hat OpenShift through OperatorHub and configure it with the `NginxGatewayFabric` custom resource. | |
| This guide details how to install F5 NGINX Gateway Fabric on Red Hat OpenShift through OperatorHub. You can then configure it with the `NginxGatewayFabric` custom resource. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I discourage marketing terms in docs. It hurts credibility with our target audience
| NGINX Gateway Fabric provides first-class OpenShift support with Universal Base Image (UBI)-based images. Use the `-ubi` tags shown in the custom resource definition (CRD) examples. Defaults are compatible with OpenShift Security Context Constraints (SCCs) for non-root operation. If your cluster enforces custom SCCs or policies, bind the appropriate SCC to NGINX Gateway Fabric service accounts. | |
| NGINX Gateway Fabric provides OpenShift support with Universal Base Image (UBI)-based images. Use the `-ubi` tags shown in the custom resource definition (CRD) examples. Defaults are compatible with OpenShift Security Context Constraints (SCCs) for non-root operation. If your cluster enforces custom SCCs or policies, bind the appropriate SCC to NGINX Gateway Fabric service accounts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ciarams87 @mkingst what are your thoughts on this one?
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I presume you mean the UI, not the product (which includes NIM, N Plus, etc.)
| ### Integrate with NGINX One (optional) | |
| ### Integrate with NGINX One Console (optional) |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| If you want NGINX Gateway Fabric to connect to NGINX One, create a secret for the dataplane key (replace VALUE with your key). | |
| 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). |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Create a minimal `NginxGatewayFabric` custom resource for OpenShift. | |
| Create a minimal `NginxGatewayFabric` custom resource for OpenShift. Include this code in a file named `nginx-gateway-fabric.yaml`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incorrect - the data plane will only be provisioned when a Gateway object has been created
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a thing called GatewayClass? If not, I'd rephrase this to the actual directive:
| Verify that deployments and services are running, and confirm the GatewayClass: | |
| Verify that deployments and services are running, and confirm the `gatewayclass`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, GatewayClass is an Object in the Gateway API.
https://gateway-api.sigs.k8s.io/api-types/gatewayclass/
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This implies steps 1-8.
Also, our style guide discourages words like "simple"
| 9. Create a simple Gateway and HTTPRoute to validate routing: | |
| Create a Gateway and HTTPRoute to validate routing: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| github.com/nginxinc/nginx-hugo-theme v1.0.11 h1:vsiqkg+Ba7CN05SaY9HEPbPinz3Y1xjNZ/qdhhp7Hrc= | ||
| github.com/nginxinc/nginx-hugo-theme v1.0.11/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= | ||
| github.com/nginxinc/nginx-hugo-theme v1.0.15 h1:X9G9ihCB7ceGXEgJgiYKvMHGCV/xMUBOR3aKAuT7aEA= | ||
| github.com/nginxinc/nginx-hugo-theme v1.0.15/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= |
Uh oh!
There was an error while loading. Please reload this page.