[CHANGELOG] upcoming breaking change for k8s nat (hyperledger#7534)

* upcoming breaking change for k8s nat * log warning if deprecated NAT method used Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]>
Consensys · Sep 16, 2024 · 89dfa95 · 89dfa95
1 parent 12caf7d
commit 89dfa95
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## [Unreleased]
 
 ### Upcoming Breaking Changes
+- k8s (KUBERNETES) Nat method is now deprecated and will be removed in a future release
 
 ### Breaking Changes
 

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java b/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java
@@ -1568,6 +1568,13 @@ private void validateGraphQlOptions() {
 
   @SuppressWarnings("ConstantConditions")
   private void validateNatParams() {
+    if (natMethod.equals(NatMethod.KUBERNETES)) {
+      logger.warn("Kubernetes NAT method is deprecated. Please use Docker or UPNP");
+    }
+    if (!unstableNatOptions.getNatManagerServiceName().equals(DEFAULT_BESU_SERVICE_NAME_FILTER)) {
+      logger.warn(
+          "`--Xnat-kube-service-name` and Kubernetes NAT method are deprecated. Please use Docker or UPNP");
+    }
     if (!(natMethod.equals(NatMethod.AUTO) || natMethod.equals(NatMethod.KUBERNETES))
         && !unstableNatOptions
             .getNatManagerServiceName()

diff --git a/nat/src/main/java/org/hyperledger/besu/nat/NatMethod.java b/nat/src/main/java/org/hyperledger/besu/nat/NatMethod.java
@@ -18,7 +18,7 @@
 public enum NatMethod {
   /** Upnp nat method. */
   UPNP,
-  /** Upnpp 2 ponly nat method. */
+  /** Upnp p2p only nat method. */
   UPNPP2PONLY,
   /** Docker nat method. */
   DOCKER,