[PLAT-14204] Azure Provider - Allow the Resource Group for the Networ…

…k to be overridden per Region. Summary: Added new optional fields for region for Azure - network resource group override and subscription id override. These fields override that of on provider level. Added validation for these overrides on both UI and BE level. Test Plan: 1) Create a region with overriden resource group. 2) Edit a region and add these overrides -> verify everything is saved. 3) Pass incorrect override -> verify validation fails. 4) Create a universe with this region -> verify success Reviewers: jmak, svarshney, #yba-api-review, sneelakantan Reviewed By: jmak, svarshney, #yba-api-review, sneelakantan Subscribers: sneelakantan, yugaware Differential Revision: https://phorge.dev.yugabyte.com/D36466
yugabyte · Jul 30, 2024 · 3104eb7 · 3104eb7
1 parent 34e6e7a
commit 3104eb7
Show file tree

Hide file tree

Showing 12 changed files with 164 additions and 35 deletions.
diff --git a/managed/src/main/java/com/yugabyte/yw/commissioner/tasks/CloudBootstrap.java b/managed/src/main/java/com/yugabyte/yw/commissioner/tasks/CloudBootstrap.java
@@ -30,6 +30,7 @@
 import com.yugabyte.yw.models.helpers.CloudInfoInterface;
 import com.yugabyte.yw.models.helpers.provider.AWSCloudInfo;
 import com.yugabyte.yw.models.helpers.provider.GCPCloudInfo;
+import com.yugabyte.yw.models.helpers.provider.region.AzureRegionCloudInfo;
 import com.yugabyte.yw.models.helpers.provider.region.GCPRegionCloudInfo;
 import io.swagger.annotations.ApiModel;
 import java.util.ArrayList;
@@ -179,6 +180,10 @@ public static class PerRegionMetadata {
       // Default: x86_64
       public Architecture architecture;
 
+      public String networkRGOverride;
+
+      public String resourceGroupOverride;
+
       public static PerRegionMetadata fromRegion(Region region) {
         PerRegionMetadata perRegionMetadata = new PerRegionMetadata();
         perRegionMetadata.customImageId = region.getYbImage();
@@ -192,6 +197,11 @@ public static PerRegionMetadata fromRegion(Region region) {
           GCPRegionCloudInfo g = CloudInfoInterface.get(region);
           perRegionMetadata.instanceTemplate = g.instanceTemplate;
         }
+        if (region.getProviderCloudCode() == CloudType.azu) {
+          AzureRegionCloudInfo cloudInfo = CloudInfoInterface.get(region);
+          perRegionMetadata.networkRGOverride = cloudInfo.getAzuNetworkRGOverride();
+          perRegionMetadata.resourceGroupOverride = cloudInfo.getAzuRGOverride();
+        }
         //    perRegionMetadata.vpcCidr = never used
         if (region.getZones() == null || region.getZones().size() == 0) {
           perRegionMetadata.azToSubnetIds = new HashMap<>();

diff --git a/managed/src/main/java/com/yugabyte/yw/common/CloudRegionHelper.java b/managed/src/main/java/com/yugabyte/yw/common/CloudRegionHelper.java
@@ -13,6 +13,7 @@
 import com.yugabyte.yw.models.Region;
 import com.yugabyte.yw.models.helpers.CloudInfoInterface;
 import com.yugabyte.yw.models.helpers.provider.AWSCloudInfo;
+import com.yugabyte.yw.models.helpers.provider.region.AzureRegionCloudInfo;
 import com.yugabyte.yw.models.helpers.provider.region.GCPRegionCloudInfo;
 import java.util.ArrayList;
 import java.util.List;
@@ -206,6 +207,11 @@ public Region createRegion(
           vnet = queryHelper.getVnetOrFail(region);
         }
         region.setVnetName(vnet);
+        if (metadata.networkRGOverride != null || metadata.resourceGroupOverride != null) {
+          AzureRegionCloudInfo regionCloudInfo = CloudInfoInterface.get(region);
+          regionCloudInfo.setAzuNetworkRGOverride(metadata.networkRGOverride);
+          regionCloudInfo.setAzuRGOverride(metadata.resourceGroupOverride);
+        }
         region.update();
         if (zoneNets == null || zoneNets.size() == 0) {
           zoneInfo = queryHelper.getZones(region.getUuid(), vnet);

diff --git a/managed/src/main/java/com/yugabyte/yw/common/DevopsBase.java b/managed/src/main/java/com/yugabyte/yw/common/DevopsBase.java
@@ -11,6 +11,7 @@
 package com.yugabyte.yw.common;
 
 import com.fasterxml.jackson.databind.JsonNode;
+import com.google.common.collect.ImmutableList;
 import com.google.inject.Inject;
 import com.yugabyte.yw.commissioner.Common;
 import com.yugabyte.yw.common.config.GlobalConfKeys;
@@ -25,6 +26,8 @@
 
 @Slf4j
 public abstract class DevopsBase {
+  private static final List<String> REGION_LEVEL_ALLOWED_OVERRIDES =
+      ImmutableList.of("AZURE_NETWORK_RG", "AZURE_RG");
   public static final String YBCLOUD_SCRIPT = "bin/ybcloud.sh";
   public static final String PY_WRAPPER = "bin/py_wrapper";
 
@@ -83,6 +86,10 @@ protected ShellResponse execCommand(DevopsCommand devopsCommand) {
       try {
         Map<String, String> envConfig = CloudInfoInterface.fetchEnvVars(region.getProvider());
         extraVars.putAll(envConfig);
+        // In case region has overrides - put values over provider values.
+        Map<String, String> regionEnvConfig = CloudInfoInterface.fetchEnvVars(region);
+        regionEnvConfig.keySet().retainAll(REGION_LEVEL_ALLOWED_OVERRIDES);
+        extraVars.putAll(regionEnvConfig);
       } catch (Exception e) {
         throw new RuntimeException("Failed to retrieve env variables for the provider!", e);
       }

diff --git a/managed/src/main/java/com/yugabyte/yw/models/configs/validators/AzureProviderValidator.java b/managed/src/main/java/com/yugabyte/yw/models/configs/validators/AzureProviderValidator.java
@@ -294,6 +294,7 @@ private void validateRegionDetails(
       AzureCloudInfo info,
       ArrayNode regionArrayJson,
       SetMultimap<String, String> validationErrorsMap) {
+    String baseResourceGroup = resourceGroup;
     try {
       if (subscriptionID.equals(info.azuNetworkSubscriptionId)) {
         AzureCloudInfo cloudinfo =
@@ -304,11 +305,50 @@ private void validateRegionDetails(
       int regionIndex = 0;
 
       for (Region region : provider.getRegions()) {
+        resourceGroup = baseResourceGroup;
         AzureRegionCloudInfo regionInfo = region.getDetails().cloudInfo.azu;
         JsonNode regionJson = regionArrayJson.get(regionIndex++);
         JsonNode cloudInfoJson = regionJson.get("details").get("cloudInfo").get("azu");
         String securityGroup = regionInfo.getSecurityGroupId();
 
+        if (regionInfo.getAzuRGOverride() != null) {
+          resourceGroup = regionInfo.getAzuRGOverride();
+          AzureCloudInfo.AzureCloudInfoBuilder cloudInfoBuilder =
+              info.toBuilder().azuRG(resourceGroup);
+          AZUResourceGroupApiClient client =
+              new AZUResourceGroupApiClient(cloudInfoBuilder.build());
+          azure = client.getAzureResourceManager();
+
+          if (!azure.resourceGroups().contain(resourceGroup)) {
+            String resourceGroupOverrideJsonPath =
+                regionJson.get("azuRGOverride").get("jsonPath").asText();
+            String err =
+                String.format(
+                    "Resource group %s not found in Subscription %s",
+                    resourceGroupOverrideJsonPath, subscriptionID);
+            validationErrorsMap.put(resourceGroupOverrideJsonPath, err);
+          }
+        }
+
+        if (regionInfo.getAzuNetworkRGOverride() != null) {
+          resourceGroup = regionInfo.getAzuNetworkRGOverride();
+          AzureCloudInfo.AzureCloudInfoBuilder cloudInfoBuilder =
+              info.toBuilder().azuRG(resourceGroup);
+          AZUResourceGroupApiClient client =
+              new AZUResourceGroupApiClient(cloudInfoBuilder.build());
+          azure = client.getAzureResourceManager();
+
+          if (!azure.resourceGroups().contain(resourceGroup)) {
+            String networkGroupOverrideJsonPath =
+                regionJson.get("azuNetworkRGOverride").get("jsonPath").asText();
+            String err =
+                String.format(
+                    "Resource group %s not found in Subscription %s",
+                    resourceGroup, subscriptionID);
+            validationErrorsMap.put(networkGroupOverrideJsonPath, err);
+          }
+        }
+
         // verify security group exists
         if (securityGroup != null) {
           try {

diff --git a/...ed/src/main/java/com/yugabyte/yw/models/helpers/provider/region/AzureRegionCloudInfo.java b/...ed/src/main/java/com/yugabyte/yw/models/helpers/provider/region/AzureRegionCloudInfo.java
@@ -11,6 +11,7 @@
 import java.util.Map;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
+import org.apache.commons.lang3.StringUtils;
 
 @Data
 @EqualsAndHashCode(callSuper = false)
@@ -24,6 +25,14 @@ public class AzureRegionCloudInfo implements CloudInfoInterface {
   @JsonAlias("sg_id")
   public String securityGroupId;
 
+  @ApiModelProperty
+  @JsonAlias("azuNetworkRGOverride")
+  public String azuNetworkRGOverride;
+
+  @JsonAlias("azuRGOverride")
+  @ApiModelProperty
+  public String azuRGOverride;
+
   @ApiModelProperty(
       value =
           "<b style=\"color:#ff0000\">Deprecated since YBA version 2.20.0.</b> Use"
@@ -45,6 +54,19 @@ public Map<String, String> getEnvVars() {
     if (ybImage != null) {
       envVars.put("ybImage", ybImage);
     }
+    if (!StringUtils.isEmpty(azuNetworkRGOverride)) {
+      // This will override that setting on provider level.
+      envVars.put("AZURE_NETWORK_RG", azuNetworkRGOverride);
+    }
+    if (!StringUtils.isEmpty(azuRGOverride)) {
+      // This will override that setting on provider level.
+      envVars.put("AZURE_RG", azuRGOverride);
+      if (StringUtils.isEmpty(azuNetworkRGOverride)) {
+        // Setting this for network rg too, because otherwise it could take network resource group
+        // from provider level which will be confusing.
+        envVars.put("AZURE_NETWORK_RG", azuRGOverride);
+      }
+    }
 
     return envVars;
   }

diff --git a/managed/src/main/resources/openapi/components/schemas/AzureRegionCloudInfo.yaml b/managed/src/main/resources/openapi/components/schemas/AzureRegionCloudInfo.yaml
@@ -8,3 +8,9 @@ properties:
   vnet:
     description: Azure vnet
     type: string
+  azu_network_rg_override:
+    description: Azure network resource group overriden at region level
+    type: string
+  rg_override:
+    description: Azure resource group overriden at region level
+    type: string
diff --git a/managed/src/main/resources/swagger-strict.json b/managed/src/main/resources/swagger-strict.json
@@ -1861,6 +1861,12 @@
     },
     "AzureRegionCloudInfo" : {
       "properties" : {
+        "azuNetworkRGOverride" : {
+          "type" : "string"
+        },
+        "azuRGOverride" : {
+          "type" : "string"
+        },
         "securityGroupId" : {
           "type" : "string"
         },
@@ -19341,14 +19347,6 @@
           "in" : "query",
           "name" : "request",
           "required" : false
-        }, {
-          "description" : "XCluster Replication Edit Form Data",
-          "in" : "body",
-          "name" : "xcluster_replication_edit_form_data",
-          "required" : true,
-          "schema" : {
-            "$ref" : "#/definitions/XClusterConfigEditFormData"
-          }
         } ],
         "responses" : {
           "200" : {
@@ -19503,14 +19501,6 @@
           "in" : "query",
           "name" : "request",
           "required" : false
-        }, {
-          "description" : "XCluster Replication Edit Form Data",
-          "in" : "body",
-          "name" : "xcluster_replication_edit_form_data",
-          "required" : true,
-          "schema" : {
-            "$ref" : "#/definitions/XClusterConfigEditFormData"
-          }
         } ],
         "responses" : {
           "200" : {

diff --git a/managed/src/main/resources/swagger.json b/managed/src/main/resources/swagger.json
@@ -1873,6 +1873,12 @@
     },
     "AzureRegionCloudInfo" : {
       "properties" : {
+        "azuNetworkRGOverride" : {
+          "type" : "string"
+        },
+        "azuRGOverride" : {
+          "type" : "string"
+        },
         "securityGroupId" : {
           "type" : "string"
         },
@@ -19803,14 +19809,6 @@
           "in" : "query",
           "name" : "request",
           "required" : false
-        }, {
-          "description" : "XCluster Replication Edit Form Data",
-          "in" : "body",
-          "name" : "xcluster_replication_edit_form_data",
-          "required" : true,
-          "schema" : {
-            "$ref" : "#/definitions/XClusterConfigEditFormData"
-          }
         } ],
         "responses" : {
           "200" : {
@@ -19965,14 +19963,6 @@
           "in" : "query",
           "name" : "request",
           "required" : false
-        }, {
-          "description" : "XCluster Replication Edit Form Data",
-          "in" : "body",
-          "name" : "xcluster_replication_edit_form_data",
-          "required" : true,
-          "schema" : {
-            "$ref" : "#/definitions/XClusterConfigEditFormData"
-          }
         } ],
         "responses" : {
           "200" : {

diff --git a/...ged/ui/src/components/configRedesign/providerRedesign/forms/azu/AZUProviderCreateForm.tsx b/...ged/ui/src/components/configRedesign/providerRedesign/forms/azu/AZUProviderCreateForm.tsx
@@ -679,6 +679,12 @@ const constructProviderPayload = async (
             }),
             ...(regionFormValues.ybImage && {
               ybImage: regionFormValues.ybImage
+            }),
+            ...(regionFormValues.azuNetworkRGOverride && {
+              azuNetworkRGOverride: regionFormValues.azuNetworkRGOverride
+            }),
+            ...(regionFormValues.azuRGOverride && {
+              azuRGOverride: regionFormValues.azuRGOverride
             })
           }
         }

diff --git a/managed/ui/src/components/configRedesign/providerRedesign/forms/azu/AZUProviderEditForm.tsx b/managed/ui/src/components/configRedesign/providerRedesign/forms/azu/AZUProviderEditForm.tsx
@@ -882,6 +882,8 @@ const constructDefaultFormValues = (
     vnet: region.details.cloudInfo.azu.vnet,
     securityGroupId: region.details.cloudInfo.azu.securityGroupId,
     ybImage: region.details.cloudInfo.azu.ybImage ?? '',
+    azuNetworkRGOverride: region.details.cloudInfo.azu.azuNetworkRGOverride ?? '',
+    azuRGOverride: region.details.cloudInfo.azu.azuRGOverride ?? '',
     zones: region.zones
   })),
   sshKeypairManagement: getLatestAccessKey(providerConfig.allAccessKeys)?.keyInfo.managementState,
@@ -978,6 +980,12 @@ const constructProviderPayload = async (
                 }),
                 ...(regionFormValues.ybImage && {
                   ybImage: regionFormValues.ybImage
+                }),
+                ...(regionFormValues.azuNetworkRGOverride && {
+                  azuNetworkRGOverride: regionFormValues.azuNetworkRGOverride
+                }),
+                ...(regionFormValues.azuRGOverride && {
+                  azuRGOverride: regionFormValues.azuRGOverride
                 })
               }
             }