feat: user Vert.x as the default HttpClient implementation

Signed-off-by: Marc Nuri <[email protected]>
fabric8io · Nov 25, 2024 · c85237b · c85237b
1 parent a45d956
commit c85237b
Show file tree

Hide file tree

Showing 7 changed files with 119 additions and 59 deletions.
diff --git a/.github/workflows/e2e-httpclient-tests.yml b/.github/workflows/e2e-httpclient-tests.yml
@@ -39,7 +39,7 @@ jobs:
       fail-fast: false
       matrix:
         kubernetes: [v1.28.1,v1.27.5]
-        httpclient: [jdk,jetty,vertx]
+        httpclient: [jdk,jetty,okhttp]
     steps:
       - name: Checkout
         uses: actions/checkout@v4

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,6 +43,7 @@
 * Fix #6158: Removed deprecated methods from `io.fabric8.kubernetes.client.utils.IOHelpers` class
 * Fix #6159: Removed deprecated `io.fabric8.kubernetes.client.utils.Utils.getPluralFromKind` method
 * Fix #6361: Renamed SettableBeanPropertyDelegate to SettableBeanPropertyDelegating
+* Fix #6470: Switched default HTTP client from OkHttp to Vert.x (`kubernetes-httpclient-vertx`)
 * Fix #6603: Removed deprecated `io.fabric8.openshift.api.model.runtime.RawExtension` class
 * Fix #6605: Removed deprecated `ApiVersionUtil` classes in extension modules
 * Fix #6609: Removed deprecated `io.fabric8.crd.generator.CRDInfo.getVersion` method

diff --git a/chaos-tests/pom.xml b/chaos-tests/pom.xml
@@ -49,13 +49,13 @@
       <exclusions>
         <exclusion>
           <groupId>io.fabric8</groupId>
-          <artifactId>kubernetes-httpclient-okhttp</artifactId>
+          <artifactId>kubernetes-httpclient-vertx</artifactId>
         </exclusion>
       </exclusions>
     </dependency>
     <dependency>
       <groupId>io.fabric8</groupId>
-      <artifactId>kubernetes-httpclient-okhttp</artifactId>
+      <artifactId>kubernetes-httpclient-vertx</artifactId>
       <scope>test</scope>
     </dependency>
 

diff --git a/doc/FAQ.md b/doc/FAQ.md
diff --git a/doc/MIGRATION-v7.md b/doc/MIGRATION-v7.md
@@ -2,6 +2,7 @@
 
 ## Contents
 - [Java baseline set to Java 11](#java-11)
+- [Vert.x as default HttpClient implementation](#vertx-httpclient)
 - [Bouncy Castle is no longer needed](#bouncy-castle)
 - [Config changes](#config-changes)
   - [Support for multiple kubeconfig files](#config-changes-multiple-kubeconfig)
@@ -41,6 +42,14 @@ Starting from version 7.0.0, you will need a Java 11+ runtime (using the latest
 It's been more than 10 years since Java 8 was released, and it's no longer supported by most vendors.
 We made our best effort to keep the client compatible with Java 8 for as long as possible, but it's time to move on.
 
+## Vert.x as default HttpClient implementation <a href="#vertx-httpclient" id="vertx-httpclient"/>
+
+OkHttp has been replaced by Vert.x as the default HttpClient implementation.
+As of version 7.0.0, the Fabric8 Kubernetes Client `io.fabric8:kubernetes-client` and `io.fabric8:openshift-client` include a transitive dependency to the `io.fabric8:kubernetes-httpclient-vertx` module.
+
+If you want to continue using OkHttp as the HttpClient, you can do so by adding the `io.fabric8:kubernetes-httpclient-okhttp` module as a dependency.
+It is also recommended (although not mandatory) to add an exclusion for the `io.fabric8:kubernetes-httpclient-vertx` module to avoid having both implementations in the classpath.
+
 ## Bouncy Castle is no longer needed <a href="#bouncy-castle" id="bouncy-castle"/>
 
 The Bouncy Castle library is no longer needed as a dependency.

diff --git a/kubernetes-client/pom.xml b/kubernetes-client/pom.xml
@@ -67,7 +67,7 @@
     </dependency>
     <dependency>
       <groupId>io.fabric8</groupId>
-      <artifactId>kubernetes-httpclient-okhttp</artifactId>
+      <artifactId>kubernetes-httpclient-vertx</artifactId>
       <scope>runtime</scope>
     </dependency>
 
@@ -205,7 +205,7 @@
             </goals>
             <configuration>
               <excludeDependencies>
-                kubernetes-httpclient-okhttp
+                kubernetes-httpclient-vertx
               </excludeDependencies>
               <instructions>
                 <Bundle-Name>${project.name}</Bundle-Name>

diff --git a/kubernetes-itests/pom.xml b/kubernetes-itests/pom.xml
@@ -102,7 +102,7 @@
           <exclusions>
             <exclusion>
               <groupId>io.fabric8</groupId>
-              <artifactId>kubernetes-httpclient-okhttp</artifactId>
+              <artifactId>kubernetes-httpclient-vertx</artifactId>
             </exclusion>
           </exclusions>
         </dependency>
@@ -122,7 +122,7 @@
           <exclusions>
             <exclusion>
               <groupId>io.fabric8</groupId>
-              <artifactId>kubernetes-httpclient-okhttp</artifactId>
+              <artifactId>kubernetes-httpclient-vertx</artifactId>
             </exclusion>
           </exclusions>
         </dependency>
@@ -133,7 +133,7 @@
       </dependencies>
     </profile>
     <profile>
-      <id>httpclient-vertx</id>
+      <id>httpclient-okhttp</id>
       <dependencies>
         <dependency>
           <groupId>io.fabric8</groupId>
@@ -142,13 +142,13 @@
           <exclusions>
             <exclusion>
               <groupId>io.fabric8</groupId>
-              <artifactId>kubernetes-httpclient-okhttp</artifactId>
+              <artifactId>kubernetes-httpclient-vertx</artifactId>
             </exclusion>
           </exclusions>
         </dependency>
         <dependency>
           <groupId>io.fabric8</groupId>
-          <artifactId>kubernetes-httpclient-vertx</artifactId>
+          <artifactId>kubernetes-httpclient-okhttp</artifactId>
         </dependency>
       </dependencies>
     </profile>