Skip to content

Commit 857e322

Browse files
committed
feat: Move external IP note for NGF beside shell variable instructions
1 parent e26ca30 commit 857e322

File tree

8 files changed

+37
-53
lines changed

8 files changed

+37
-53
lines changed

content/ngf/traffic-management/advanced-routing.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ The goal is to create a set of rules that will result in client requests being s
2727

2828
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
2929

30-
{{< note >}} In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for. {{< /note >}}
31-
3230
## Coffee applications
3331

3432
### Deploy the Coffee applications
@@ -65,12 +63,16 @@ After creating the Gateway resource, NGINX Gateway Fabric will provision an NGIN
6563

6664
Save the public IP address and port of the NGINX Service into shell variables:
6765

68-
```text
69-
GW_IP=XXX.YYY.ZZZ.III
70-
GW_PORT=<port number>
71-
```
66+
```text
67+
GW_IP=XXX.YYY.ZZZ.III
68+
GW_PORT=<port number>
69+
```
70+
71+
{{< note >}}
72+
73+
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.
7274

73-
{{< note >}}In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.{{< /note >}}
75+
{{< /note >}}
7476

7577
The [HTTPRoute](https://gateway-api.sigs.k8s.io/api-types/httproute/) is typically deployed by the [application developer](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#roles-and-personas_1). To deploy the `coffee` HTTPRoute:
7678

content/ngf/traffic-management/client-settings.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,6 @@ For all the possible configuration options for `ClientSettingsPolicy`, see the [
4040

4141
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
4242

43-
{{< note >}}In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.{{< /note >}}
44-
4543
Create the coffee and tea example applications:
4644

4745
```yaml

content/ngf/traffic-management/https-termination.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,6 @@ In this guide, we will show how to configure HTTPS termination for your applicat
2121

2222
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
2323

24-
{{< note >}}
25-
26-
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.
27-
28-
{{< /note >}}
29-
3024
---
3125

3226
## Set up
@@ -176,7 +170,11 @@ Save the public IP address and ports of the NGINX Service into shell variables:
176170
GW_HTTPS_PORT=<https port number>
177171
```
178172

179-
{{< note >}}In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.{{< /note >}}
173+
{{< note >}}
174+
175+
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.
176+
177+
{{< /note >}}
180178

181179
To create the httproute resources, copy and paste the following into your terminal:
182180

content/ngf/traffic-management/mirror.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,6 @@ sent to the **coffee** application will also be sent to the **tea** application
2323
## Before you begin
2424

2525
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
26-
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
27-
28-
```text
29-
GW_IP=XXX.YYY.ZZZ.III
30-
GW_PORT=<port number>
31-
```
32-
33-
{{< note >}}In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.{{< /note >}}
3426

3527
---
3628

@@ -151,12 +143,16 @@ After creating the Gateway resource, NGINX Gateway Fabric will provision an NGIN
151143

152144
Save the public IP address and port of the NGINX Service into shell variables:
153145

154-
```text
155-
GW_IP=XXX.YYY.ZZZ.III
156-
GW_PORT=<port number>
157-
```
146+
```text
147+
GW_IP=XXX.YYY.ZZZ.III
148+
GW_PORT=<port number>
149+
```
150+
151+
{{< note >}}
152+
153+
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.
158154

159-
{{< note >}}In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.{{< /note >}}
155+
{{< /note >}}
160156

161157
Now create an HTTPRoute that defines a RequestMirror filter that copies all requests sent to `/coffee` to be sent to the **coffee** backend and mirrored to the **tea** backend. Use the following command:
162158

content/ngf/traffic-management/redirects-and-rewrites.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,6 @@ To see an example of a redirect using scheme and port, see the [HTTPS Terminatio
2525

2626
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
2727

28-
{{< note >}}
29-
30-
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.
31-
32-
{{< /note >}}
33-
3428
---
3529

3630
## HTTP rewrites and redirects examples
@@ -73,7 +67,6 @@ In a production environment, you should have a DNS record for the external IP ad
7367

7468
{{< /note >}}
7569

76-
7770
---
7871

7972
## URLRewrite example

content/ngf/traffic-management/request-response-headers.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,6 @@ This guide describes how to configure the headers application to modify the head
2121

2222
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
2323

24-
{{< note >}}
25-
26-
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.
27-
28-
{{< /note >}}
29-
3024
---
3125

3226
## HTTP Header Modifiers examples
@@ -63,8 +57,11 @@ GW_IP=XXX.YYY.ZZZ.III
6357
GW_PORT=<port number>
6458
```
6559

66-
{{< note >}} In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for .{{< /note >}}
60+
{{< note >}}
6761

62+
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.
63+
64+
{{< /note >}}
6865

6966
---
7067

content/ngf/traffic-management/routing-traffic-to-your-app.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,11 @@ Save the public IP address and port of the NGINX Service into shell variables:
148148
GW_PORT=<port number>
149149
```
150150

151-
{{< note >}}In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.{{< /note >}}
151+
{{< note >}}
152+
153+
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.
154+
155+
{{< /note >}}
152156

153157
This Gateway is associated with NGINX Gateway Fabric through the **gatewayClassName** field. The default installation of NGINX Gateway Fabric creates a GatewayClass with the name **nginx**. NGINX Gateway Fabric will only configure Gateways with a **gatewayClassName** of **nginx** unless you change the name via the `--gatewayclass` [command-line flag]({{< ref "/ngf/reference/cli-help.md#static-mode" >}}).
154158

content/ngf/traffic-management/tls-passthrough.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,6 @@ In this guide, we will show how to configure TLS passthrough for your applicatio
2929

3030
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric with experimental features enabled.
3131

32-
{{< note >}}
33-
34-
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the Gateway will forward for.
35-
36-
{{< /note >}}
37-
38-
---
39-
4032
## Set up
4133

4234
Create the `secure-app` application by copying and pasting the following block into your terminal:
@@ -178,7 +170,11 @@ GW_IP=XXX.YYY.ZZZ.III
178170
GW_TLS_PORT=<port number>
179171
```
180172

181-
{{< note >}} In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the Gateway will forward for. {{< /note >}}
173+
{{< note >}}
174+
175+
In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the Gateway will forward for.
176+
177+
{{< /note >}}
182178

183179
Create a TLSRoute that attaches to the Gateway and routes requests to `app.example.com` to the `secure-app` Service:
184180

0 commit comments

Comments
 (0)