[PLAT-16938]: Send whether ysql major version upgrade is required in …

…the software upgrade info api Summary: Added wether the target version during software upgrade results in ysql major version upgrade in the software upgrade api. Test Plan: Tested manually Reviewers: sneelakantan, dkumar, sanketh Reviewed By: dkumar Subscribers: yugaware Differential Revision: https://phorge.dev.yugabyte.com/D42284
yugabyte · Mar 4, 2025 · ca4c58b · ca4c58b
1 parent 0aba681
commit ca4c58b
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 2 deletions.
diff --git a/managed/src/main/java/com/yugabyte/yw/controllers/handlers/UpgradeUniverseHandler.java b/managed/src/main/java/com/yugabyte/yw/controllers/handlers/UpgradeUniverseHandler.java
@@ -14,6 +14,7 @@
 import com.yugabyte.yw.common.KubernetesManagerFactory;
 import com.yugabyte.yw.common.KubernetesUtil;
 import com.yugabyte.yw.common.PlatformServiceException;
+import com.yugabyte.yw.common.SoftwareUpgradeHelper;
 import com.yugabyte.yw.common.Util;
 import com.yugabyte.yw.common.XClusterUniverseService;
 import com.yugabyte.yw.common.backuprestore.ybc.YbcManager;
@@ -83,6 +84,7 @@ public class UpgradeUniverseHandler {
   private final AutoFlagUtil autoFlagUtil;
   private final XClusterUniverseService xClusterUniverseService;
   private final TelemetryProviderService telemetryProviderService;
+  private final SoftwareUpgradeHelper softwareUpgradeHelper;
 
   @Inject
   public UpgradeUniverseHandler(
@@ -94,7 +96,8 @@ public UpgradeUniverseHandler(
       CertificateHelper certificateHelper,
       AutoFlagUtil autoFlagUtil,
       XClusterUniverseService xClusterUniverseService,
-      TelemetryProviderService telemetryProviderService) {
+      TelemetryProviderService telemetryProviderService,
+      SoftwareUpgradeHelper softwareUpgradeHelper) {
     this.commissioner = commissioner;
     this.kubernetesManagerFactory = kubernetesManagerFactory;
     this.runtimeConfigFactory = runtimeConfigFactory;
@@ -104,6 +107,7 @@ public UpgradeUniverseHandler(
     this.autoFlagUtil = autoFlagUtil;
     this.xClusterUniverseService = xClusterUniverseService;
     this.telemetryProviderService = telemetryProviderService;
+    this.softwareUpgradeHelper = softwareUpgradeHelper;
   }
 
   public UUID restartUniverse(
@@ -682,6 +686,9 @@ public SoftwareUpgradeInfoResponse softwareUpgradeInfo(
     SoftwareUpgradeInfoResponse response = new SoftwareUpgradeInfoResponse();
     try {
       response.setFinalizeRequired(autoFlagUtil.upgradeRequireFinalize(currentVersion, newVersion));
+      response.setYsqlMajorVersionUpgrade(
+          softwareUpgradeHelper.isYsqlMajorVersionUpgradeRequired(
+              universe, currentVersion, newVersion));
     } catch (IOException e) {
       log.error("Error: ", e);
       throw new PlatformServiceException(

diff --git a/managed/src/main/java/com/yugabyte/yw/models/extended/SoftwareUpgradeInfoResponse.java b/managed/src/main/java/com/yugabyte/yw/models/extended/SoftwareUpgradeInfoResponse.java
@@ -18,4 +18,10 @@ public class SoftwareUpgradeInfoResponse {
       accessMode = AccessMode.READ_ONLY)
   @YbaApi(visibility = YbaApiVisibility.PREVIEW, sinceYBAVersion = "2.20.2.0")
   private boolean finalizeRequired;
+
+  @ApiModelProperty(
+      value = "WARNING: This is a preview API that could change. YSQL Major version upgrade",
+      accessMode = AccessMode.READ_ONLY)
+  @YbaApi(visibility = YbaApiVisibility.PREVIEW, sinceYBAVersion = "2025.1.0.0")
+  private boolean ysqlMajorVersionUpgrade;
 }
diff --git a/managed/src/main/resources/swagger-strict.json b/managed/src/main/resources/swagger-strict.json
@@ -18978,6 +18978,11 @@
           "description" : "WARNING: This is a preview API that could change. Finalize required",
           "readOnly" : true,
           "type" : "boolean"
+        },
+        "ysqlMajorVersionUpgrade" : {
+          "description" : "WARNING: This is a preview API that could change. YSQL Major version upgrade",
+          "readOnly" : true,
+          "type" : "boolean"
         }
       },
       "type" : "object"

diff --git a/managed/src/main/resources/swagger.json b/managed/src/main/resources/swagger.json
@@ -19106,6 +19106,11 @@
           "description" : "WARNING: This is a preview API that could change. Finalize required",
           "readOnly" : true,
           "type" : "boolean"
+        },
+        "ysqlMajorVersionUpgrade" : {
+          "description" : "WARNING: This is a preview API that could change. YSQL Major version upgrade",
+          "readOnly" : true,
+          "type" : "boolean"
         }
       },
       "type" : "object"

diff --git a/managed/src/test/java/com/yugabyte/yw/controllers/handlers/UpgradeUniverseHandlerTest.java b/managed/src/test/java/com/yugabyte/yw/controllers/handlers/UpgradeUniverseHandlerTest.java
@@ -20,6 +20,7 @@
 import com.yugabyte.yw.common.KubernetesManagerFactory;
 import com.yugabyte.yw.common.ModelFactory;
 import com.yugabyte.yw.common.PlatformServiceException;
+import com.yugabyte.yw.common.SoftwareUpgradeHelper;
 import com.yugabyte.yw.common.XClusterUniverseService;
 import com.yugabyte.yw.common.backuprestore.ybc.YbcManager;
 import com.yugabyte.yw.common.certmgmt.CertificateHelper;
@@ -81,7 +82,8 @@ public void setUp() {
             mock(CertificateHelper.class),
             mock(AutoFlagUtil.class),
             mock(XClusterUniverseService.class),
-            mock(TelemetryProviderService.class));
+            mock(TelemetryProviderService.class),
+            mock(SoftwareUpgradeHelper.class));
   }
 
   private static Object[] tlsToggleCustomTypeNameParams() {