Skip to content

Commit 729c169

Browse files
ADubhlaoichADubhlaoich
committed
feat: Remove redundant shell variable information
1 parent 9689e86 commit 729c169

File tree

8 files changed

+66
-92
lines changed

8 files changed

+66
-92
lines changed

‎content/ngf/get-started.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -465,8 +465,8 @@ Request ID: 1b5c8f3a4532ea7d7510cf14ffeb27af
465465

466466
---
467467

468-
## See also
468+
## Next steps
469469

470470
- [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}), for additional ways to install NGINX Gateway Fabric
471-
- [How-to guides]({{< ref "/ngf/how-to/" >}}), for configuring your cluster
472471
- [Traffic management]({{< ref "/ngf/traffic-management/" >}}), for more in-depth traffic management configuration
472+
- [How-to guides]({{< ref "/ngf/how-to/" >}}), for configuring your cluster

‎content/ngf/how-to/data-plane-configuration.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -274,15 +274,14 @@ of a few arguments. {{</ note >}}
274274

275275
### Run NGINX Gateway Fabric with NGINX in debug mode
276276

277-
To run NGINX Gateway Fabric with NGINX in debug mode, after[installation]({{< ref "/ngf/install/" >}}), follow these additional steps:
277+
To run NGINX Gateway Fabric with NGINX in debug mode, during [installation]({{< ref "/ngf/install/" >}}), follow these additional steps:
278278

279-
Using Helm: Set `nginx.debug` to true.
279+
- **Helm**: Set _nginx.debug_ to _true_.
280+
- **Manifests**: Set _spec.kubernetes.deployment.container.debug_ field in the _NginxProxy_ resource to _true_.
280281

281-
Using Kubernetes Manifests: In the deployment manifest, set the `spec.kubernetes.deployment.container.debug` field in the `NginxProxy` resource to true.
282+
To change NGINX mode **after** deploying NGINX Gateway Fabric, use the _NginxProxy_ _spec.kubernetes.deployment.container.debug_ field.
282283

283-
If you want to change the NGINX mode after deploying NGINX Gateway Fabric, you can do so through the `NginxProxy` `spec.kubernetes.deployment.container.debug` field.
284-
285-
The following command creates a basic `NginxProxy` configuration that both sets the NGINX log level to `debug` and runs NGINX in `debug` mode.
284+
The following command creates a basic _NginxProxy_ configuration that sets both the NGINX mode and log level to _debug_.
286285

287286
```yaml
288287
kubectl apply -f - <<EOF
@@ -300,7 +299,7 @@ spec:
300299
EOF
301300
```
302301

303-
{{< note >}} When modifying any `deployment` field in the `NginxProxy` resource, any corresponding NGINX instances will be restarted. {{< /note >}}
302+
{{< note >}} When modifying any _deployment_ field in the _NginxProxy_ resource, any corresponding NGINX instances will be restarted. {{< /note >}}
304303

305304
---
306305

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

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,9 @@ The goal is to create a set of rules that will result in client requests being s
2626
## Before you begin
2727

2828
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
29-
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
30-
31-
```text
32-
GW_IP=XXX.YYY.ZZZ.III
33-
GW_PORT=<port number>
34-
```
3529

3630
{{< 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 >}}
3731

38-
---
39-
4032
## Coffee applications
4133

4234
### Deploy the Coffee applications

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

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -39,73 +39,71 @@ For all the possible configuration options for `ClientSettingsPolicy`, see the [
3939
## Before you begin
4040

4141
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
42-
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
4342

44-
```text
45-
GW_IP=XXX.YYY.ZZZ.III
46-
GW_PORT=<port number>
47-
```
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 >}}
4844

49-
{{< 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 >}}
45+
Create the coffee and tea example applications:
5046

51-
- Create the coffee and tea example applications:
47+
```yaml
48+
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/examples/client-settings-policy/app.yaml
49+
```
5250

53-
```yaml
54-
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/examples/client-settings-policy/app.yaml
55-
```
51+
Create a Gateway:
5652

57-
- Create a Gateway:
53+
```yaml
54+
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/examples/client-settings-policy/gateway.yaml
55+
```
5856

59-
```yaml
60-
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/examples/client-settings-policy/gateway.yaml
61-
```
6257
After creating the Gateway resource, NGINX Gateway Fabric will provision an NGINX Pod and Service fronting it to route traffic.
6358

64-
- Create HTTPRoutes for the coffee and tea applications:
59+
Create HTTPRoutes for the coffee and tea applications:
6560

66-
```yaml
67-
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/examples/client-settings-policy/httproutes.yaml
68-
```
61+
```yaml
62+
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/examples/client-settings-policy/httproutes.yaml
63+
```
6964

70-
- Save the public IP address and port of the NGINX Service into shell variables:
65+
Save the public IP address and port of the NGINX Service into shell variables:
7166

72-
```text
73-
GW_IP=XXX.YYY.ZZZ.III
74-
GW_PORT=<port number>
75-
```
67+
```text
68+
GW_IP=XXX.YYY.ZZZ.III
69+
GW_PORT=<port number>
70+
```
7671

77-
{{< 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 >}}
72+
{{< note >}}
7873

74+
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.
7975

80-
- Test the configuration:
76+
{{< /note >}}
8177

82-
You can send traffic to the coffee and tea applications using the external IP address and port for the NGINX Service.
78+
Test the configuration:
8379

84-
Send a request to coffee:
80+
You can send traffic to the coffee and tea applications using the external IP address and port for the NGINX Service.
8581

86-
```shell
87-
curl --resolve cafe.example.com:$GW_PORT:$GW_IP http://cafe.example.com:$GW_PORT/coffee
88-
```
82+
Send a request to coffee:
8983

90-
This request should receive a response from the coffee Pod:
84+
```shell
85+
curl --resolve cafe.example.com:$GW_PORT:$GW_IP http://cafe.example.com:$GW_PORT/coffee
86+
```
87+
88+
This request should receive a response from the coffee Pod:
9189

92-
```text
93-
Server address: 10.244.0.9:8080
94-
Server name: coffee-76c7c85bbd-cf8nz
95-
```
90+
```text
91+
Server address: 10.244.0.9:8080
92+
Server name: coffee-76c7c85bbd-cf8nz
93+
```
9694

97-
Send a request to tea:
95+
Send a request to tea:
9896

99-
```shell
100-
curl --resolve cafe.example.com:$GW_PORT:$GW_IP http://cafe.example.com:$GW_PORT/tea
101-
```
97+
```shell
98+
curl --resolve cafe.example.com:$GW_PORT:$GW_IP http://cafe.example.com:$GW_PORT/tea
99+
```
102100

103-
This request should receive a response from the tea Pod:
101+
This request should receive a response from the tea Pod:
104102

105-
```text
106-
Server address: 10.244.0.9:8080
107-
Server name: tea-76c7c85bbd-cf8nz
108-
```
103+
```text
104+
Server address: 10.244.0.9:8080
105+
Server name: tea-76c7c85bbd-cf8nz
106+
```
109107

110108
---
111109

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

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,12 @@ In this guide, we will show how to configure HTTPS termination for your applicat
2020
## Before you begin
2121

2222
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
23-
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
2423

25-
```text
26-
GW_IP=XXX.YYY.ZZZ.III
27-
GW_PORT=<port number>
28-
```
24+
{{< note >}}
2925

30-
Save the ports of NGINX Gateway Fabric:
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.
3127

32-
```text
33-
GW_HTTP_PORT=<http port number>
34-
GW_HTTPS_PORT=<https port number>
35-
```
36-
37-
{{< 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 >}}
28+
{{< /note >}}
3829

3930
---
4031

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,12 @@ To see an example of a redirect using scheme and port, see the [HTTPS Terminatio
2424
## Before you begin
2525

2626
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
27-
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
2827

29-
```text
30-
GW_IP=XXX.YYY.ZZZ.III
31-
GW_PORT=<port number>
32-
```
28+
{{< note >}}
3329

34-
{{< 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 >}}
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 >}}
3533

3634
---
3735

@@ -69,7 +67,11 @@ GW_IP=XXX.YYY.ZZZ.III
6967
GW_PORT=<port number>
7068
```
7169

72-
{{< 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 >}}
70+
{{< note >}}
71+
72+
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.
73+
74+
{{< /note >}}
7375

7476

7577
---

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,12 @@ This guide describes how to configure the headers application to modify the head
2020
## Before you begin
2121

2222
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
23-
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
2423

25-
```text
26-
GW_IP=XXX.YYY.ZZZ.III
27-
GW_PORT=<port number>
28-
```
24+
{{< note >}}
2925

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 >}}
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 >}}
3129

3230
---
3331

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,6 @@ You can route traffic to your Kubernetes applications using the Gateway API and
2020
## Before you begin
2121

2222
- [Install]({{< ref "/ngf/install/" >}}) NGINX Gateway Fabric.
23-
- Save the public IP address and port of NGINX Gateway Fabric into shell variables:
24-
25-
```text
26-
GW_IP=XXX.YYY.ZZZ.III
27-
GW_PORT=<port number>
28-
```
2923

3024
---
3125

0 commit comments

Comments
 (0)