You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
customresourcedefinition.apiextensions.k8s.io/referencegrants.gateway.networking.k8s.io created
105
101
```
106
102
107
-
---
108
-
109
103
### Install the Helm chart
110
104
111
105
Use `helm` to install NGINX Gateway Fabric, specifying the NodePort configuration that will be set on the
@@ -128,8 +122,6 @@ REVISION: 1
128
122
TEST SUITE: None
129
123
```
130
124
131
-
---
132
-
133
125
## Create an example application
134
126
135
127
In the previous section, you deployed NGINX Gateway Fabric to a local cluster. This section shows you how to deploy a simple web application to test that NGINX Gateway Fabric works.
@@ -138,8 +130,6 @@ In the previous section, you deployed NGINX Gateway Fabric to a local cluster. T
138
130
The YAML code in the following sections can be found in the [cafe-example folder](https://github.com/nginx/nginx-gateway-fabric/tree/main/examples/cafe-example) of the GitHub repository.
139
131
{{< /note >}}
140
132
141
-
---
142
-
143
133
### Create the application resources
144
134
145
135
Create the file _cafe.yaml_ with the following contents:
Create the file _gateway.yaml_ with the following contents:
@@ -217,8 +205,6 @@ httproute.gateway.networking.k8s.io/coffee created
217
205
httproute.gateway.networking.k8s.io/tea created
218
206
```
219
207
220
-
---
221
-
222
208
### Verify the configuration
223
209
224
210
You can check that all of the expected services are available using `kubectl get`:
@@ -431,8 +417,6 @@ Status:
431
417
Events: <none>
432
418
```
433
419
434
-
---
435
-
436
420
## Test NGINX Gateway Fabric
437
421
438
422
By configuring the cluster with the port `31437`, there is implicit port forwarding from your local machine to NodePort, allowing for direct communication to the NGINX Gateway Fabric service.
@@ -463,8 +447,6 @@ URI: /tea
463
447
Request ID: 1b5c8f3a4532ea7d7510cf14ffeb27af
464
448
```
465
449
466
-
---
467
-
468
450
## Next steps
469
451
470
452
-[Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}), for additional ways to install NGINX Gateway Fabric
Copy file name to clipboardExpand all lines: content/ngf/install/build-image.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,15 @@
2
2
title: Build NGINX Gateway Fabric
3
3
weight: 400
4
4
toc: true
5
-
type: how-to
6
-
product: NGF
7
-
docs: DOCS-1431
5
+
nd-content-type: how-to
6
+
nd-product: NGF
7
+
nd-docs: DOCS-1431
8
8
---
9
9
10
10
## Overview
11
11
12
12
While most users will install NGINX Gateway Fabric [with Helm]({{< ref "/ngf/install/helm.md" >}}) or [Kubernetes manifests]({{< ref "/ngf/install/manifests.md" >}}), manually building the [NGINX Gateway Fabric and NGINX images]({{< ref "/ngf/overview/gateway-architecture.md#the-nginx-gateway-fabric-pod" >}}) can be helpful for testing and development purposes. Follow the steps in this document to build the NGINX Gateway Fabric and NGINX images.
13
13
14
-
---
15
-
16
14
## Before you begin
17
15
18
16
Before you can build the NGINX Gateway Fabric and NGINX images, make sure you have the following software
@@ -25,7 +23,6 @@ installed on your machine:
25
23
26
24
If building the NGINX Plus image, you will also need a valid NGINX Plus license certificate (`nginx-repo.crt`) and key (`nginx-repo.key`) in the root of the repo.
Copy file name to clipboardExpand all lines: content/ngf/install/helm.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ weight: 200
4
4
toc: true
5
5
nd-content-type: how-to
6
6
nd-product: NGF
7
-
docs: DOCS-1430
7
+
nd-docs: DOCS-1430
8
8
---
9
9
10
10
## Overview
@@ -18,7 +18,7 @@ To complete this guide, you will need:
18
18
19
19
-[kubectl](https://kubernetes.io/docs/tasks/tools/), a command-line tool for managing Kubernetes clusters.
20
20
-[Helm 3.0 or later](https://helm.sh/docs/intro/install/), for deploying and managing applications on Kubernetes.
21
-
-[Add certificates for secure authentication]({{< ref "/ngf/install/control-plane-certs.md" >}}) in a production environment.
21
+
-[Add certificates for secure authentication]({{< ref "/ngf/install/secure-certificates.md" >}}) in a production environment.
22
22
23
23
{{< important >}} If you’d like to use NGINX Plus, some additional setup is also required: {{</ important >}}
24
24
@@ -192,6 +192,6 @@ Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your K
192
192
## Next steps
193
193
194
194
- [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md">}})
195
-
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md">}})
195
+
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/basic-routing.md">}})
196
196
197
197
For a full list of the Helm Chart configuration parameters, read [the NGINX Gateway Fabric Helm Chart](https://github.com/nginx/nginx-gateway-fabric/blob/v{{< version-ngf >}}/charts/nginx-gateway-fabric/README.md#configuration).
Copy file name to clipboardExpand all lines: content/ngf/install/nginx-plus.md
+4-22Lines changed: 4 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
title: Install NGINX Gateway Fabric with NGINX Plus
3
3
weight: 300
4
4
toc: true
5
-
type: how-to
6
-
product: NGF
7
-
docs: DOCS-000
5
+
nd-content-type: how-to
6
+
nd-product: NGF
7
+
nd-docs: DOCS-000
8
8
---
9
9
10
10
## Overview
@@ -17,22 +17,16 @@ The JWT is required for validating your subscription and reporting telemetry dat
17
17
18
18
{{< note >}} The following Secrets should be created in the same namespace as the NGINX Gateway Fabric control plane (default: nginx-gateway). The control plane will copy these Secrets into any namespaces where NGINX gets deployed. If you need to update the Secrets, update the originals that you created in the control plane namespace, and the control plane will propagate those updates to all duplicated Secrets. {{< /note >}}
19
19
20
-
---
21
-
22
20
## Set up the JWT
23
21
24
22
The JWT needs to be configured before deploying NGINX Gateway Fabric. The JWT will be stored in two Kubernetes Secrets: one for downloading the NGINX Plus container image, and the other for running NGINX Plus.
25
23
26
24
{{< include "/ngf/installation/jwt-password-note.md" >}}
27
25
28
-
---
29
-
30
26
### Download the JWT from MyF5
31
27
32
28
{{< include "/ngf/installation/nginx-plus/download-jwt.md" >}}
33
29
34
-
---
35
-
36
30
### Docker Registry Secret
37
31
38
32
{{< include "/ngf/installation/nginx-plus/docker-registry-secret.md" >}}
@@ -55,8 +49,6 @@ Specify the Secret name in the `nginx-docker-secret` command-line argument of th
55
49
56
50
{{</tabs>}}
57
51
58
-
---
59
-
60
52
### NGINX Plus Secret
61
53
62
54
{{< include "/ngf/installation/nginx-plus/nginx-plus-secret.md" >}}
@@ -81,8 +73,6 @@ Specify the Secret name in the `--usage-report-secret` command-line flag on the
81
73
82
74
{{< note >}} If you are reporting to the default licensing endpoint, then you can now proceed with [installing NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}). Otherwise, follow the steps below to configure reporting to NGINX Instance Manager. {{< /note >}}
83
75
84
-
---
85
-
86
76
### Reporting to NGINX Instance Manager {#nim}
87
77
88
78
If you are deploying NGINX Gateway Fabric in an environment where you need to report to NGINX Instance Manager instead of the default licensing endpoint, a few extra steps may be required.
@@ -105,8 +95,6 @@ Specify the endpoint in the `--usage-report-endpoint` command-line flag on the `
105
95
106
96
{{</tabs>}}
107
97
108
-
---
109
-
110
98
#### CA and Client certificate/key {#nim-cert}
111
99
112
100
To configure a CA cert and/or client certificate and key, a few extra steps are needed.
@@ -143,8 +131,6 @@ Specify the CA Secret name in the `--usage-report-ca-secret` command-line flag o
143
131
144
132
{{< note >}} Once these Secrets are created and configuration options are set, you can now [install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}). {{< /note >}}
145
133
146
-
---
147
-
148
134
## Installation flags to configure usage reporting {#flags}
149
135
150
136
When installing NGINX Gateway Fabric, the following flags can be specified to configure usage reporting to fit your needs:
@@ -167,8 +153,6 @@ If using manifests, the following command-line options should be set as necessar
167
153
-`--usage-report-ca-secret` is the name of the Secret containing the NGINX Instance Manager CA certificate. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway).
168
154
-`--usage-report-client-ssl-secret` is the name of the Secret containing the client certificate and key for authenticating with NGINX Instance Manager. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway).
169
155
170
-
---
171
-
172
156
## What’s reported and how it’s protected {#telemetry}
173
157
174
158
NGINX Plus reports the following data every hour by default:
@@ -184,8 +168,6 @@ NGINX Plus reports the following data every hour by default:
184
168
-**Usage report timestamps**: Start and end times for each usage report.
185
169
-**Kubernetes node details**: Information about Kubernetes nodes.
186
170
187
-
---
188
-
189
171
### Security and privacy of reported data
190
172
191
173
All communication between your NGINX Plus instances, NGINX Instance Manager, and F5’s licensing endpoint (`product.connect.nginx.com`) is protected using **SSL/TLS** encryption.
@@ -219,4 +201,4 @@ There are alternative ways to get an NGINX Plus image for NGINX Gateway Fabric:
219
201
## Next steps
220
202
221
203
-[Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}})
222
-
-[Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})
204
+
-[Routing traffic to applications]({{< ref "/ngf/traffic-management/basic-routing.md" >}})
Copy file name to clipboardExpand all lines: content/ngf/install/secure-certificates.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ helm install \
49
49
--set crds.enabled=true
50
50
```
51
51
52
-
This also enables Gateway API features for cert-manager, which can be useful for [securing your workload traffic]({{< ref "/ngf/traffic-security/integrating-cert-manager.md" >}}).
52
+
This also enables Gateway API features for cert-manager, which can be useful for [securing your workload traffic]({{< ref "/ngf/traffic-security/integrate-cert-manager.md" >}}).
0 commit comments