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: Fix call-outs in NGINX Gateway Fabric (#976)
As part of the 2.1 release, an invalid call-out style was reintroduced
to the NGINX Gateway Fabric documentation. This commit removes it, and
also restructures an instance of a double call-out pattern, which we
avoid due to visual clutter.
---------
Co-authored-by: Jon Torre <[email protected]>
Copy file name to clipboardExpand all lines: content/ngf/how-to/data-plane-configuration.md
+11-15Lines changed: 11 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -397,6 +397,16 @@ Each patch has two fields:
397
397
398
398
Patches are applied in the order they appear in the array. Later patches can override fields set by earlier patches.
399
399
400
+
**Which patch type should I use?**
401
+
402
+
- **StrategicMerge** is the default and most user-friendly for Kubernetes-native resources like Deployments and Services. It understands lists and merges fields intelligently (for example, merging containers by name). Use this for most use cases.
403
+
- **Merge** (JSON Merge Patch) is simpler and works well for basic object merges, but does not handle lists or complex merging. Use this if you want to replace entire fields or for non-Kubernetes-native resources.
404
+
- **JSONPatch** is the most powerful and flexible, allowing you to add, remove, or replace specific fields using RFC 6902 operations. Use this for advanced or fine-grained changes, but it is more verbose and error-prone.
405
+
406
+
If unsure, start with StrategicMerge. Use JSONPatch only if you need to surgically modify fields that cannot be addressed by the other patch types.
407
+
408
+
Patches are applied after all other NginxProxy configuration is rendered. Invalid patches will result in a validation error and will not be applied.
409
+
400
410
#### Example: Configure Service with session affinity
401
411
402
412
```yaml
@@ -485,18 +495,4 @@ spec:
485
495
publishNotReadyAddresses: true
486
496
```
487
497
488
-
In this example, the final Service will have `sessionAffinity: None` and `publishNotReadyAddresses: true` because the second patch overrides the values from the first patch.
489
-
490
-
{{< note >}}
491
-
**Which patch type should I use?**
492
-
493
-
- **StrategicMerge** is the default and most user-friendly for Kubernetes-native resources like Deployments and Services. It understands lists and merges fields intelligently (e.g., merging containers by name). Use this for most use cases.
494
-
- **Merge** (JSON Merge Patch) is simpler and works well for basic object merges, but does not handle lists or complex merging. Use this if you want to replace entire fields or for non-Kubernetes-native resources.
495
-
- **JSONPatch** is the most powerful and flexible, allowing you to add, remove, or replace specific fields using RFC 6902 operations. Use this for advanced or fine-grained changes, but it is more verbose and error-prone.
496
-
497
-
If unsure, start with StrategicMerge. Use JSONPatch only if you need to surgically modify fields that cannot be addressed by the other patch types.
498
-
499
-
Patches are applied after all other NginxProxy configuration is rendered. Invalid patches will result in a validation error and will not be applied.
500
-
{{< /note >}}
501
-
502
-
---
498
+
In this example, the final Service will have `sessionAffinity: None` and `publishNotReadyAddresses: true` because the second patch overrides the values from the first patch.
Copy file name to clipboardExpand all lines: content/ngf/install/upgrade-version.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,20 +13,18 @@ It covers the necessary steps for minor versions as well as major versions (such
13
13
14
14
Many of the nuances in upgrade paths relate to how custom resource definitions (CRDs) are managed.
15
15
16
-
17
16
## Minor NGINX Gateway Fabric upgrades
18
17
19
-
{{< call-out "important" >}}
20
-
Upgrading from v2.0.x to v2.1 requires the NGINX Gateway Fabric control plane to be uninstalled and then reinstalled to avoid any downtime to user traffic. CRDs do not need to be removed. The NGINX data plane deployment is not affected by this process, and traffic should still flow uninterrupted. The steps are described below.
21
-
{{< /call-out >}}
18
+
Upgrading from v2.0.x to v2.1 requires the NGINX Gateway Fabric control plane to be uninstalled and then reinstalled to avoid any downtime to user traffic.
19
+
20
+
CRDs **do not** need to be removed. The NGINX data plane deployment **is not** affected by this process, and traffic should still flow uninterrupted.
22
21
23
22
{{< call-out "important" >}} NGINX Plus users need a JWT secret before upgrading from version 1.4.0 to 1.5.x.
24
23
25
24
Follow the steps in [Set up the JWT]({{< ref "/ngf/install/nginx-plus.md#set-up-the-jwt" >}}) to create the Secret.
26
25
27
26
{{< /call-out >}}
28
27
29
-
30
28
### Upgrade Gateway resources
31
29
32
30
To upgrade your Gateway API resources, take the following steps:
0 commit comments