From 0f75a127788c1eb2998ec8b694796b8d593ae3f2 Mon Sep 17 00:00:00 2001 From: Quentin Monnet Date: Tue, 16 Apr 2024 14:45:42 +0100 Subject: [PATCH] docs: Fix WireGuard filter (again) This is 2b90e7f6b1f0 ("docs: Fix WireGuard filter") all over again. "WireGuard" should be spelt "WireGuard", not "wireguard" or "Wireguard". We have a custom extension in the docs to ensure we never have the latter, for example. But it's been broken for a while, because we also added the lowercase "wireguard" entry to the list of spelling exceptions, making it case-insensitive in the eyes of the spell-checker. We need to remove this entry. Except this time this is "Wireguard" and not "wireguard" that we need to remove. Fixes: 80284eae4596 ("Cilium Charts to set the persistent keepalive for cilium_wg0") Signed-off-by: Quentin Monnet --- Documentation/helm-values.rst | 2 +- .../mutual-authentication/mutual-authentication.rst | 2 +- Documentation/spelling_wordlist.txt | 1 - install/kubernetes/cilium/README.md | 2 +- install/kubernetes/cilium/values.yaml | 4 ++-- install/kubernetes/cilium/values.yaml.tmpl | 4 ++-- 6 files changed, 7 insertions(+), 8 deletions(-) diff --git a/Documentation/helm-values.rst b/Documentation/helm-values.rst index bdd73d79bed0f..e501d15e78e7e 100644 --- a/Documentation/helm-values.rst +++ b/Documentation/helm-values.rst @@ -1037,7 +1037,7 @@ - string - ``"ipsec"`` * - :spelling:ignore:`encryption.wireguard.persistentKeepalive` - - Controls Wireguard PersistentKeepalive option. Set 0s to disable. + - Controls WireGuard PersistentKeepalive option. Set 0s to disable. - string - ``"0s"`` * - :spelling:ignore:`encryption.wireguard.userspaceFallback` diff --git a/Documentation/network/servicemesh/mutual-authentication/mutual-authentication.rst b/Documentation/network/servicemesh/mutual-authentication/mutual-authentication.rst index 493b36893177e..f3e8219a97b3b 100644 --- a/Documentation/network/servicemesh/mutual-authentication/mutual-authentication.rst +++ b/Documentation/network/servicemesh/mutual-authentication/mutual-authentication.rst @@ -137,7 +137,7 @@ For details, see the [roadmap issue](https://github.com/cilium/cilium/issues/289 +--------------------------------------------------+----------------------------------------------------------+ | CiliumNetworkPolicy support | Beta | +--------------------------------------------------+----------------------------------------------------------+ -| Integrate with Wireguard | TODO | +| Integrate with WireGuard | TODO | +--------------------------------------------------+----------------------------------------------------------+ | Per-connection handshake | TODO | +--------------------------------------------------+----------------------------------------------------------+ diff --git a/Documentation/spelling_wordlist.txt b/Documentation/spelling_wordlist.txt index dda19f37e8ee9..5e689c1c7e6d4 100644 --- a/Documentation/spelling_wordlist.txt +++ b/Documentation/spelling_wordlist.txt @@ -130,7 +130,6 @@ Vagrantfile Vagrantfiles Viljoen Wendlandt -Wireguard Wireshark Xenial Yan diff --git a/install/kubernetes/cilium/README.md b/install/kubernetes/cilium/README.md index cd3dd7f1b1170..911b731dbf64d 100644 --- a/install/kubernetes/cilium/README.md +++ b/install/kubernetes/cilium/README.md @@ -309,7 +309,7 @@ contributors across the globe, there is almost always someone available to help. | encryption.strictMode.cidr | string | `""` | CIDR for the WireGuard Pod2Pod strict mode. | | encryption.strictMode.enabled | bool | `false` | Enable WireGuard Pod2Pod strict mode. | | encryption.type | string | `"ipsec"` | Encryption method. Can be either ipsec or wireguard. | -| encryption.wireguard.persistentKeepalive | string | `"0s"` | Controls Wireguard PersistentKeepalive option. Set 0s to disable. | +| encryption.wireguard.persistentKeepalive | string | `"0s"` | Controls WireGuard PersistentKeepalive option. Set 0s to disable. | | encryption.wireguard.userspaceFallback | bool | `false` | Enables the fallback to the user-space implementation (deprecated). | | endpointHealthChecking.enabled | bool | `true` | Enable connectivity health checking between virtual endpoints. | | endpointRoutes.enabled | bool | `false` | Enable use of per endpoint routes instead of routing via the cilium_host interface. | diff --git a/install/kubernetes/cilium/values.yaml b/install/kubernetes/cilium/values.yaml index 03201752e5b6c..6dde45ae1d940 100644 --- a/install/kubernetes/cilium/values.yaml +++ b/install/kubernetes/cilium/values.yaml @@ -868,7 +868,7 @@ encryption: wireguard: # -- Enables the fallback to the user-space implementation (deprecated). userspaceFallback: false - # -- Controls Wireguard PersistentKeepalive option. Set 0s to disable. + # -- Controls WireGuard PersistentKeepalive option. Set 0s to disable. persistentKeepalive: 0s endpointHealthChecking: # -- Enable connectivity health checking between virtual endpoints. @@ -3284,7 +3284,7 @@ authentication: gcInterval: "5m0s" # Configuration for Cilium's service-to-service mutual authentication using TLS handshakes. # Note that this is not full mTLS support without also enabling encryption of some form. - # Current encryption options are Wireguard or IPSec, configured in encryption block above. + # Current encryption options are WireGuard or IPSec, configured in encryption block above. mutual: # -- Port on the agent where mutual authentication handshakes between agents will be performed port: 4250 diff --git a/install/kubernetes/cilium/values.yaml.tmpl b/install/kubernetes/cilium/values.yaml.tmpl index 5bec24bb9e93d..874824f5a10e8 100644 --- a/install/kubernetes/cilium/values.yaml.tmpl +++ b/install/kubernetes/cilium/values.yaml.tmpl @@ -867,7 +867,7 @@ encryption: wireguard: # -- Enables the fallback to the user-space implementation (deprecated). userspaceFallback: false - # -- Controls Wireguard PersistentKeepalive option. Set 0s to disable. + # -- Controls WireGuard PersistentKeepalive option. Set 0s to disable. persistentKeepalive: 0s endpointHealthChecking: # -- Enable connectivity health checking between virtual endpoints. @@ -3293,7 +3293,7 @@ authentication: gcInterval: "5m0s" # Configuration for Cilium's service-to-service mutual authentication using TLS handshakes. # Note that this is not full mTLS support without also enabling encryption of some form. - # Current encryption options are Wireguard or IPSec, configured in encryption block above. + # Current encryption options are WireGuard or IPSec, configured in encryption block above. mutual: # -- Port on the agent where mutual authentication handshakes between agents will be performed port: 4250