Skip to content

Commit e52961b

Browse files
authored
Update the ConfigMap Zone Sync documentation (#7681)
This commit updates the ConfigMap Zone Sync documentation by changing the order and formatting of some information. Previously, all of the content was in a note call-out after the table of keys and descriptions. Now, the important information about TLS availability is part of the main text, and the note call-out for a possible error is instead a caution call-out just before the table. Previously, there was a somewhat redundant (And broken) link. The frontmatter data of the page has also been updated.
1 parent aadc5c3 commit e52961b

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

site/content/configuration/global-configuration/configmap-resource.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
docs: DOCS-586
3-
doctypes:
4-
- ''
52
title: ConfigMap resources
6-
toc: true
73
weight: 300
4+
toc: true
5+
type: how-to
6+
product: NIC
7+
docs: DOCS-586
88
---
99

1010
When using F5 NGINX Ingress Controller, you can customize or fine tune NGINX behavior using ConfigMap resources. Examples include setting the number of worker processes or customizing the access log format.
@@ -182,7 +182,18 @@ For more information, view the [VirtualServer and VirtualServerRoute resources](
182182
183183
### Zone Sync
184184
185-
Zone Sync enables the [ngx_stream_zone_sync_module](https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html) in NGINX Ingress Controller when NGINX Plus is used. Multiple replicas are required to effectively utililise this functionality. See the [zone sync documentation for further details](https://docs.nginx.com/nginx/admin-guide/high-availability/zone_sync_details/).
185+
Zone Sync enables the [ngx_stream_zone_sync_module](https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html) in NGINX Ingress Controller when NGINX Plus is used. Multiple replicas are required to effectively utililise this functionality. More information is available in the [How NGINX Plus Performs Zone Synchronization](https://docs.nginx.com/nginx/admin-guide/high-availability/zone_sync_details/) topic.
186+
187+
Zone synchronization with TLS for NGINX Ingress Controller is not yet available with ConfigMap. If you would like to enable Zone Sync with TLS, please remove `zone-sync` from ConfigMap and add Zone Sync parameters via [`stream-snippets`]({{< ref "/configuration/ingress-resources/advanced-configuration-with-snippets.md" >}}) similar to [this example](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-config.yaml) and adding the [zone_sync_ssl directive](https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync_ssl) along with any other TLS parameters to the `stream-snippets`.
188+
189+
You will also need to manually add the headless service, such as in [this example](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-ingress-headless.yaml).
190+
191+
{{< caution >}}
192+
If you previously installed OIDC or used the `zone_sync` directive with `stream-snippets` in [v4.0.1](https://github.com/nginx/kubernetes-ingress/tree/v4.0.1) or earlier, and you plan to enable the `zone-sync` ConfigMap key, the `zone_sync` directive should be removed from `stream-snippets`.
193+
194+
If you encounter the error `error [emerg] 13#13: "zone_sync" directive is duplicate in /etc/nginx/nginx.conf:164` it is likely due to `zone_sync` being enabled in both `stream-snippets` and the ConfigMap. Once upgraded, remove the [old headless service](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-ingress-headless.yaml) deployed for OIDC.
195+
{{< /caution >}}
196+
186197
187198
{{<bootstrap-table "table table-striped table-bordered table-responsive">}}
188199
|ConfigMap Key | Description | Default | Example |
@@ -194,13 +205,6 @@ Zone Sync enables the [ngx_stream_zone_sync_module](https://nginx.org/en/docs/st
194205
|*zone-sync-resolver-valid* | Configures an [NGINX time](https://nginx.org/en/docs/syntax.html) that the optional [resolver](https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver) directive for zone-sync will override the TTL value of responses from nameservers with. NGINX Plus & `zone-sync` Required | `5s` | |
195206
{{</bootstrap-table>}}
196207
197-
{{< note >}}
198-
If you previously installed OIDC or used the `zone_sync` directive with `stream-snippets` in [v4.0.1](https://github.com/nginx/kubernetes-ingress/tree/v4.0.1) or earlier, and you plan to enable the [`zone-sync` ConfigMap key](/nginx-ingress-controller/configuration/global-configuration/configmap-resources/#zone-sync), the `zone_sync` directive should be removed from `stream-snippets`.
199-
If you encounter a duplicate directive error, `error [emerg] 13#13: "zone_sync" directive is duplicate in /etc/nginx/nginx.conf:164` it is likely due to `zone_sync` being enabled in both `stream-snippets` and the ConfigMap. Once upgraded, remove the [old headless service](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-ingress-headless.yaml) deployed for OIDC.
200-
201-
Zone synchronization with TLS for NGINX Ingress Controller is not yet available with ConfigMap. If you would like to enable Zone Sync with TLS, please remove `zone-sync` from ConfigMap and add Zone Sync parameters via [`stream-snippets`]({{< ref "/configuration/ingress-resources/advanced-configuration-with-snippets.md" >}}) similar to this [example](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-config.yaml) and adding the [zone_sync_ssl directive](https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync_ssl) along with any other TLS parameters to the `stream-snippets`. You will also need to manually add the headless service, similar to [this](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-ingress-headless.yaml).
202-
{{< /note >}}
203-
204208
---
205209
206210
### Snippets and custom templates

0 commit comments

Comments
 (0)