Skip to content

Commit a890a8b

Browse files
authored
Update NGF version in getting started document (#2870)
Update NGF version in getting started document
1 parent 80b4d51 commit a890a8b

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

site/content/get-started.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Run the following command:
5353
```shell
5454
kind create cluster --config cluster-config.yaml
5555
```
56+
5657
```text
5758
Creating cluster "kind" ...
5859
✓ Ensuring node image (kindest/node:v1.31.0) 🖼
@@ -75,6 +76,7 @@ If you have cloned [the NGINX Gateway Fabric repository](https://github.com/ngin
7576
```shell
7677
make create-kind-cluster
7778
```
79+
7880
{{< /note >}}
7981

8082
---
@@ -86,8 +88,9 @@ make create-kind-cluster
8688
Use `kubectl` to add the API resources for NGINX Gateway Fabric with the following command:
8789

8890
```shell
89-
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/standard?ref=v1.4.0" | kubectl apply -f -
91+
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/standard?ref=v1.5.0" | kubectl apply -f -
9092
```
93+
9194
```text
9295
customresourcedefinition.apiextensions.k8s.io/gatewayclasses.gateway.networking.k8s.io created
9396
customresourcedefinition.apiextensions.k8s.io/gateways.gateway.networking.k8s.io created
@@ -100,8 +103,9 @@ customresourcedefinition.apiextensions.k8s.io/referencegrants.gateway.networking
100103
To use experimental features, you'll need to install the API resources from the experimental channel instead.
101104

102105
```shell
103-
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.4.0" | kubectl apply -f -
106+
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.5.0" | kubectl apply -f -
104107
```
108+
105109
{{< /note >}}
106110

107111
---
@@ -113,8 +117,9 @@ Use `helm` to install NGINX Gateway Fabric with the following command:
113117
```shell
114118
helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway --set service.create=false
115119
```
120+
116121
```text
117-
Pulled: ghcr.io/nginxinc/charts/nginx-gateway-fabric:1.4.0
122+
Pulled: ghcr.io/nginxinc/charts/nginx-gateway-fabric:1.5.0
118123
Digest: sha256:9bbd1a2fcbfd5407ad6be39f796f582e6263512f1f3a8969b427d39063cc6fee
119124
NAME: ngf
120125
LAST DEPLOYED: Mon Oct 21 14:45:14 2024
@@ -130,6 +135,7 @@ If you installed the API resources from the experimental channel during the last
130135
```shell
131136
helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway --set service.create=false --set nginxGateway.gwAPIExperimentalFeatures.enable=true
132137
```
138+
133139
{{< /note >}}
134140

135141
---
@@ -151,7 +157,7 @@ metadata:
151157
labels:
152158
app.kubernetes.io/name: nginx-gateway-fabric
153159
app.kubernetes.io/instance: ngf
154-
app.kubernetes.io/version: "1.4.0"
160+
app.kubernetes.io/version: "1.5.0"
155161
spec:
156162
type: NodePort
157163
selector:
@@ -175,6 +181,7 @@ Apply it using `kubectl`:
175181
```shell
176182
kubectl apply -f nodeport-config.yaml
177183
```
184+
178185
```text
179186
service/nginx-gateway created
180187
```
@@ -201,13 +208,14 @@ The YAML code in the following sections can be found in the [cafe-example folder
201208

202209
Create the file _cafe.yaml_ with the following contents:
203210

204-
{{< ghcode "https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe.yaml">}}
211+
{{< ghcode `https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe.yaml`>}}
205212

206-
Apply it:
213+
Apply it using `kubectl`:
207214

208215
```shell
209216
kubectl apply -f cafe.yaml
210217
```
218+
211219
```text
212220
deployment.apps/coffee created
213221
service/coffee created
@@ -220,6 +228,7 @@ Verify that the new pods are in the `default` namespace:
220228
```shell
221229
kubectl -n default get pods
222230
```
231+
223232
```text
224233
NAME READY STATUS RESTARTS AGE
225234
coffee-6db967495b-wk2mm 1/1 Running 0 10s
@@ -232,26 +241,28 @@ tea-7b7d6c947d-d4qcf 1/1 Running 0 10s
232241

233242
Create the file _gateway.yaml_ with the following contents:
234243

235-
{{< ghcode "https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/gateway.yaml">}}
244+
{{< ghcode `https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/gateway.yaml`>}}
236245

237246
Apply it using `kubectl`:
238247

239248
```shell
240249
kubectl apply -f gateway.yaml
241250
```
251+
242252
```text
243253
gateway.gateway.networking.k8s.io/gateway created
244254
```
245255

246256
Create the file _cafe-routes.yaml_ with the following contents:
247257

248-
{{< ghcode "https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe-routes.yaml">}}
258+
{{< ghcode `https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe-routes.yaml`>}}
249259

250260
Apply it using `kubectl`:
251261

252262
```shell
253263
kubectl apply -f cafe-routes.yaml
254264
```
265+
255266
```text
256267
httproute.gateway.networking.k8s.io/coffee created
257268
httproute.gateway.networking.k8s.io/tea created
@@ -266,6 +277,7 @@ You can check that all of the expected services are available using `kubectl get
266277
```shell
267278
kubectl get service --all-namespaces
268279
```
280+
269281
```text
270282
NAMESPACE NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
271283
default coffee ClusterIP 10.96.18.163 <none> 80/TCP 2m51s
@@ -280,6 +292,7 @@ You can also use `kubectl describe` on the new resources to check their status:
280292
```shell
281293
kubectl describe httproutes
282294
```
295+
283296
```text
284297
Name: coffee
285298
Namespace: default
@@ -394,6 +407,7 @@ Events: <none>
394407
```shell
395408
kubectl describe gateways
396409
```
410+
397411
```text
398412
Name: gateway
399413
Namespace: default
@@ -480,6 +494,7 @@ You can use `curl` to test the new services by targeting the hostname (_cafe.exa
480494
```shell
481495
curl --resolve cafe.example.com:8080:127.0.0.1 http://cafe.example.com:8080/coffee
482496
```
497+
483498
```text
484499
Server address: 10.244.0.6:8080
485500
Server name: coffee-6db967495b-wk2mm
@@ -491,6 +506,7 @@ Request ID: fb226a54fd94f927b484dd31fb30e747
491506
```shell
492507
curl --resolve cafe.example.com:8080:127.0.0.1 http://cafe.example.com:8080/tea
493508
```
509+
494510
```text
495511
Server address: 10.244.0.7:8080
496512
Server name: tea-7b7d6c947d-d4qcf

0 commit comments

Comments
 (0)