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
Fix installation docs for mismatched versions (#1287)
Problem: Our installation docs suggested installing Gateway API v1 and NGF v1, which are not compatible.
Solution: Fix the docs to mention both stable and edge versions, with proper versioning. Also updated the release process doc to ensure these are updated at release time as needed.
Copy file name to clipboardExpand all lines: docs/developer/release-process.md
+14-11
Original file line number
Diff line number
Diff line change
@@ -36,26 +36,29 @@ To create a new release, follow these steps:
36
36
URLs to point at `vX.Y.Z`, and bump the `version`.
37
37
2. Adjust the `VERSION` variable in the [Makefile](/Makefile) and the `TAG` in the
38
38
[conformance tests Makefile](/conformance/Makefile) to `X.Y.Z`.
39
-
3. Update the tag of NGF container images used in the Helm [values.yaml](/deploy/helm-chart/values.yaml) file, the
40
-
[provisioner manifest](/conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`.
39
+
3. Update the tag of NGF container images used in the Helm [values.yaml](/deploy/helm-chart/values.yaml) file,
40
+
the [provisioner manifest](/conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`.
41
41
4. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](/deploy/helm-chart/values.yaml)
42
42
file.
43
43
5. Generate the installation manifests by running `make generate-manifests`.
44
44
6. Modify any `git clone` instructions to use `vX.Y.Z` tag.
45
45
7. Modify any docs links that refer to `main` to instead refer to `vX.Y.Z`.
46
-
8. Update the [README](/README.md) to include information about the release.
47
-
9. Update the [changelog](/CHANGELOG.md). The changelog includes only important (from the user perspective)
48
-
changes to NGF. This is in contrast with the autogenerated full changelog, which is created in the next step. As
49
-
a starting point, copy the important features, bug fixes, and dependencies from the autogenerated draft of the
50
-
full changelog. This draft can be found under
51
-
the [GitHub releases](https://github.com/nginxinc/nginx-gateway-fabric/releases) after the release branch is
52
-
created. Use the previous changelog entries for formatting and content guidance.
46
+
8. Update any installation instructions to ensure that the supported Gateway API and NGF versions are correct.
47
+
Specifically, helm README and `site/content/includes/installation/install-gateway-api-resources.md`.
48
+
9. Update the [README](/README.md) to include information about the release.
49
+
10. Update the [changelog](/CHANGELOG.md). The changelog includes only important (from the user perspective)
50
+
changes to NGF. This is in contrast with the autogenerated full changelog, which is created in the next
51
+
step. As a starting point, copy the important features, bug fixes, and dependencies from the autogenerated
52
+
draft of the full changelog. This draft can be found under
53
+
the [GitHub releases](https://github.com/nginxinc/nginx-gateway-fabric/releases) after the release branch is
54
+
created. Use the previous changelog entries for formatting and content guidance.
53
55
7. Create and push the release tag in the format `vX.Y.Z`. As a result, the CI/CD pipeline will:
54
56
- Build NGF container images with the release tag `X.Y.Z` and push it to the registry.
55
57
- Package and publish the Helm chart to the registry.
56
58
- Create a GitHub release with an autogenerated changelog and attached release artifacts.
57
-
8. Prepare and merge a PR into the main branch to update the [README](/README.md) to include the information about the
58
-
latest release and also the [changelog](/CHANGELOG.md).
59
+
8. Prepare and merge a PR into the main branch to update the [README](/README.md) to include the information about
60
+
the latest release and also the [changelog](/CHANGELOG.md). Also update any installation instructions to ensure
61
+
that the supported Gateway API and NGF versions are correct. Specifically, helm README and `site/content/includes/installation/install-gateway-api-resources.md`.
59
62
9. Close the issue created in Step 1.
60
63
10. Ensure that the [associated milestone](https://github.com/nginxinc/nginx-gateway-fabric/milestones) is closed.
61
64
11. Verify that published artifacts in the release can be installed properly.
{{<note>}}The [Gateway API resources](https://github.com/kubernetes-sigs/gateway-api) from the standard channel must be installed before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure they are the correct version as supported by the NGINX Gateway Fabric - [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications).{{</note>}}
6
+
7
+
**Stable release**
8
+
9
+
If installing the latest stable release of NGINX Gateway Fabric, ensure you are deploying its supported version of
{{< important >}}The validating webhook is not needed if you are running Kubernetes 1.25+. Validation is done using CEL on the CRDs. See the [resource validation doc]({{< relref "/overview/resource-validation.md" >}}) for more information.{{< /important >}}
Copy file name to clipboardExpand all lines: site/content/includes/installation/uninstall-gateway-api-resources.md
+15-3
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,28 @@
2
2
docs:
3
3
---
4
4
5
-
To uninstall the Gateway API resources, including the CRDs and the validating webhook, run:
6
-
7
5
{{<warning>}}This will remove all corresponding custom resources in your entire cluster, across all namespaces. Double-check to make sure you don't have any custom resources you need to keep, and confirm that there are no other Gateway API implementations active in your cluster.{{</warning>}}
8
6
7
+
To uninstall the Gateway API resources, including the CRDs and the validating webhook, run the following:
8
+
9
+
**Stable release**
10
+
11
+
If you were running the latest stable release version of NGINX Gateway Fabric:
Copy file name to clipboardExpand all lines: site/content/installation/installing-ngf/manifests.md
+47-41
Original file line number
Diff line number
Diff line change
@@ -19,53 +19,59 @@ To complete this guide, you'll need to install:
19
19
20
20
Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps. With manifests, you can configure your deployment exactly how you want. Manifests also make it easy to replicate deployments across environments or clusters, ensuring consistency.
21
21
22
-
{{<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>}}
{{< important >}}The validating webhook is not needed if you are running Kubernetes 1.25+. Validation is done using CEL on the CRDs. See the [resource validation doc]({{< relref "/overview/resource-validation.md" >}}) for more information. {{< /important >}}
41
+
```shell
42
+
kubectl apply -f deploy/manifests/crds
43
+
```
39
44
40
-
1.**Deploy the NGINX Gateway Fabric CRDs:**
45
+
### 3. Deploy NGINX Gateway Fabric
41
46
42
-
- Next, deploy the NGINX Gateway Fabric CRDs:
47
+
{{<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>}}
- To confirm that NGINX Gateway Fabric is running, check the pods in the `nginx-gateway` namespace:
61
+
### 4. Verify the Deployment
58
62
59
-
```shell
60
-
kubectl get pods -n nginx-gateway
61
-
```
63
+
To confirm that NGINX Gateway Fabric is running, check the pods in the `nginx-gateway` namespace:
62
64
63
-
The output should look similar to this (note that the pod name will include a unique string):
65
+
```shell
66
+
kubectl get pods -n nginx-gateway
67
+
```
64
68
65
-
```text
66
-
NAME READY STATUS RESTARTS AGE
67
-
nginx-gateway-5d4f4c7db7-xk2kq 2/2 Running 0 112s
68
-
```
69
+
The output should look similar to this (note that the pod name will include a unique string):
70
+
71
+
```text
72
+
NAME READY STATUS RESTARTS AGE
73
+
nginx-gateway-5d4f4c7db7-xk2kq 2/2 Running 0 112s
74
+
```
69
75
70
76
71
77
## Upgrade NGINX Gateway Fabric
@@ -77,7 +83,7 @@ To upgrade NGINX Gateway Fabric and get the latest features and improvements, ta
77
83
1.**Upgrade Gateway API resources:**
78
84
79
85
- Verify that your NGINX Gateway Fabric version is compatible with the Gateway API resources. Refer to the [Technical Specifications]({{< relref "reference/technical-specifications.md" >}}) for details.
80
-
- Review the [release notes](https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.0.0) for any important upgrade-specific information.
86
+
- Review the [release notes](https://github.com/kubernetes-sigs/gateway-api/releases) for any important upgrade-specific information.
81
87
- To upgrade the Gateway API resources, run:
82
88
83
89
```shell
@@ -86,30 +92,30 @@ To upgrade NGINX Gateway Fabric and get the latest features and improvements, ta
86
92
87
93
- If you are running on Kubernetes 1.23 or 1.24, you also need to update the validating webhook:
0 commit comments