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
feat: Update NGF Get started guide and installation documents (#224)
This commit adds explicit guidance at the top of the Get started guide,
directing the reader towards the Installation section for a production
deployment. It also removes mention of the experimental channel, which
is an unnecessary use case for trying NGF.
It also creates uniformity in the Helm and Manifest deployment
documentation, by matching how sections are formatted, and creating an
include file for identical instructions on upgrading the API resources.
To upgrade your Gateway API resources, take the following steps:
6
+
7
+
- Use [Technical specifications]({{< ref "/ngf/reference/technical-specifications.md" >}}) to verify your Gateway API resources are compatible with your NGINX Gateway Fabric version.
8
+
- Review the [release notes](https://github.com/kubernetes-sigs/gateway-api/releases) for any important upgrade-specific information.
9
+
10
+
To upgrade the Gateway API resources, run the following command:
If you installed the API resources from the experimental channel during the last step, you will need to enable the _nginxGateway.gwAPIExperimentalFeatures_ option:
Create the file _nodeport-config.yaml_ with the following contents:
148
136
149
-
{{< note >}}
150
-
The highlighted _nodePort_ values should equal the _containerPort_ values from _cluster-config.yaml_[when you created the kind cluster](#set-up-a-kind-cluster).
151
-
{{< /note >}}
152
-
153
137
```yaml {linenos=true, hl_lines=[20, 25]}
154
138
apiVersion: v1
155
139
kind: Service
@@ -178,20 +162,23 @@ spec:
178
162
nodePort: 31438
179
163
```
180
164
165
+
{{< note >}}
166
+
The highlighted _nodePort_ values should equal the _containerPort_ values from _cluster-config.yaml_ [when you created the kind cluster](#set-up-a-kind-cluster).
167
+
{{< /note >}}
168
+
181
169
Apply it using `kubectl`:
182
170
183
171
```shell
184
172
kubectl apply -f nodeport-config.yaml
185
173
```
186
-
187
174
```text
188
175
service/nginx-gateway created
189
176
```
190
177
191
178
{{< warning >}}
192
179
The NodePort resource must be deployed in the same namespace as NGINX Gateway Fabric.
193
180
194
-
If you are making customizations, ensure your `labels:` and `selectors:` also match the labels of the NGINX Gateway Fabric Deployment.
181
+
If you are making customizations, ensure your `labels:` and `selectors:` also match the labels of the NGINX Gateway Fabric deployment.
Copy file name to clipboardExpand all lines: content/ngf/installation/installing-ngf/helm.md
+8-22Lines changed: 8 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,6 @@ docs: DOCS-1430
11
11
12
12
Learn how to install, upgrade, and uninstall NGINX Gateway Fabric in a Kubernetes cluster using Helm.
13
13
14
-
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.x need to install an NGINX Plus JWT
15
-
Secret before upgrading. Follow the steps in the [Before you begin](#before-you-begin) section to create the Secret. If you use a different name than the default `nplus-license` name, specify the Secret name by setting `--set nginx.usage.secretName=<secret-name>` when running `helm upgrade`. {{< /important >}}
16
-
17
14
---
18
15
19
16
## Before you begin
@@ -30,15 +27,15 @@ To complete this guide, you'll need to install:
30
27
31
28
{{< include "/ngf/installation/jwt-password-note.md" >}}
32
29
33
-
### 1. Download the JWT from MyF5
30
+
### Download the JWT from MyF5
34
31
35
32
{{< include "/ngf/installation/nginx-plus/download-jwt.md" >}}
36
33
37
-
### 2. Create the Docker Registry Secret
34
+
### Create the Docker Registry Secret
38
35
39
36
{{< include "/ngf/installation/nginx-plus/docker-registry-secret.md" >}}
40
37
41
-
### 3. Create the NGINX Plus Secret
38
+
### Create the NGINX Plus Secret
42
39
43
40
{{< include "/ngf/installation/nginx-plus/nginx-plus-secret.md" >}}
44
41
@@ -187,29 +184,18 @@ You can find several examples of configuration options of the `values.yaml` file
187
184
188
185
## Upgrade NGINX Gateway Fabric
189
186
190
-
{{<tip>}}For guidance on zero downtime upgrades, see the [Delay Pod Termination](#configure-delayed-pod-termination-for-zero-downtime-upgrades) section below.{{</tip>}}
187
+
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.x need to install an NGINX Plus JWT
188
+
Secret before upgrading. Follow the steps in the [Before you begin](#before-you-begin) section to create the Secret. If you use a different name than the default `nplus-license` name, specify the Secret name by setting `--set nginx.usage.secretName=<secret-name>` when running `helm upgrade`. {{< /important >}}
189
+
190
+
{{< tip >}} For guidance on zero downtime upgrades, see the [Delay Pod Termination](#configure-delayed-pod-termination-for-zero-downtime-upgrades) section below. {{< /tip >}}
191
191
192
192
To upgrade NGINX Gateway Fabric and get the latest features and improvements, take the following steps:
193
193
194
194
---
195
195
196
196
### Upgrade Gateway resources
197
197
198
-
To upgrade your Gateway API resources, take the following steps:
199
-
200
-
- Verify the Gateway API resources are compatible with your NGINX Gateway Fabric version. Refer to the [Technical Specifications]({{< ref "/ngf/reference/technical-specifications.md" >}}) for details.
201
-
- Review the [release notes](https://github.com/kubernetes-sigs/gateway-api/releases) for any important upgrade-specific information.
Copy file name to clipboardExpand all lines: content/ngf/installation/installing-ngf/manifests.md
+18-33Lines changed: 18 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Installation with Kubernetes manifests
2
+
title: Installation with Manifests
3
3
weight: 200
4
4
toc: true
5
5
type: how-to
@@ -11,9 +11,6 @@ docs: DOCS-1429
11
11
12
12
Learn how to install, upgrade, and uninstall NGINX Gateway Fabric using Kubernetes manifests.
13
13
14
-
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.x need to install an NGINX Plus JWT
15
-
Secret before upgrading. Follow the steps in the [Before you begin](#before-you-begin) section to create the Secret, which is referenced in the updated deployment manifest for the newest version. {{< /important >}}
16
-
17
14
---
18
15
19
16
## Before you begin
@@ -29,15 +26,15 @@ To complete this guide, you'll need to install:
29
26
30
27
{{< include "/ngf/installation/jwt-password-note.md" >}}
31
28
32
-
### 1. Download the JWT from MyF5
29
+
### Download the JWT from MyF5
33
30
34
31
{{< include "/ngf/installation/nginx-plus/download-jwt.md" >}}
35
32
36
-
### 2. Create the Docker Registry Secret
33
+
### Create the Docker Registry Secret
37
34
38
35
{{< include "/ngf/installation/nginx-plus/docker-registry-secret.md" >}}
39
36
40
-
### 3. Create the NGINX Plus Secret
37
+
### Create the NGINX Plus Secret
41
38
42
39
{{< include "/ngf/installation/nginx-plus/nginx-plus-secret.md" >}}
43
40
@@ -53,13 +50,13 @@ Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps.
53
50
54
51
---
55
52
56
-
### 1. Install the Gateway API resources
53
+
### Install the Gateway API resources
57
54
58
55
{{< include "/ngf/installation/install-gateway-api-resources.md" >}}
{{< note >}} By default, NGINX Gateway Fabric is installed in the **nginx-gateway** namespace. You can deploy in another namespace by modifying the manifest files. {{< /note >}}
{{< include "/ngf/installation/expose-nginx-gateway-fabric.md" >}}
196
193
@@ -205,33 +202,21 @@ Secret before upgrading. Follow the steps in the [Before you begin](#before-you-
205
202
206
203
To upgrade NGINX Gateway Fabric and get the latest features and improvements, take the following steps:
207
204
208
-
1.**Upgrade Gateway API resources:**
209
-
210
-
- Verify that your NGINX Gateway Fabric version is compatible with the Gateway API resources. Refer to the [Technical Specifications]({{< ref "/ngf/reference/technical-specifications.md" >}}) for details.
211
-
- Review the [release notes](https://github.com/kubernetes-sigs/gateway-api/releases) for any important upgrade-specific information.
Select the deployment manifest that matches your current deployment from the table above in the [Deploy NGINX Gateway Fabric](#3-deploy-nginx-gateway-fabric) section and apply it.
219
+
Select the deployment manifest that matches your current deployment from the table above in the [Deploy NGINX Gateway Fabric](#deploy-nginx-gateway-fabric) section and apply it.
0 commit comments