Skip to content

Commit ce38906

Browse files
committed
NSX: support segment discovery and security profiles
Allow NSX network offerings to reference existing IP discovery, MAC discovery, and segment security profiles, and bind them when creating a segment. Validate configured profiles and create segment bindings in the same Policy API request. Remove bindings with their segment while preserving shared profile definitions, attached-port checks, and retry behavior. Keep cloned optional details editable, including clearing the last profile. Reject offering updates and migrations that would change profiles on an existing network, and correct NSX routed provider maps. Cover offering creation, clone request handling, migration safeguards, and segment creation and deletion with API, UI, and SDK regression tests.
1 parent a8200cf commit ce38906

23 files changed

Lines changed: 1752 additions & 58 deletions

File tree

‎PendingReleaseNotes‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,11 @@ example.ver.1 > example.ver.2:
5555
continue to snapshot live.
5656

5757
4.23.0.0 > 24.0.0:
58+
* NSX network offerings can reference existing IP discovery, MAC discovery,
59+
and segment security profiles. New NSX segments bind selected profiles in
60+
the same hierarchical request as segment creation. Existing networks are
61+
not silently reconfigured when profile bindings change.
62+
5863
* VMware-to-KVM import using VDDK can import powered-off VMware VMs directly
5964
into Ceph RBD primary storage when forceconverttopool is enabled and the
6065
selected KVM conversion host supports qemu RBD access and in-place virt-v2v

‎api/src/main/java/com/cloud/offering/NetworkOffering.java‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,22 @@ public enum State {
4040
}
4141

4242
public enum Detail {
43-
InternalLbProvider, PublicLbProvider, servicepackageuuid, servicepackagedescription, PromiscuousMode, MacAddressChanges, ForgedTransmits, MacLearning, RelatedNetworkOffering, domainid, zoneid, pvlanType, internetProtocol
43+
InternalLbProvider,
44+
PublicLbProvider,
45+
servicepackageuuid,
46+
servicepackagedescription,
47+
PromiscuousMode,
48+
MacAddressChanges,
49+
ForgedTransmits,
50+
MacLearning,
51+
NsxIpDiscoveryProfileId,
52+
NsxMacDiscoveryProfileId,
53+
NsxSegmentSecurityProfileId,
54+
RelatedNetworkOffering,
55+
domainid,
56+
zoneid,
57+
pvlanType,
58+
internetProtocol
4459
}
4560

4661
public enum NetworkMode {

‎api/src/main/java/org/apache/cloudstack/api/command/admin/network/CloneNetworkOfferingCmd.java‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@
1616
// under the License.
1717
package org.apache.cloudstack.api.command.admin.network;
1818

19+
import java.util.Collections;
1920
import java.util.List;
21+
import java.util.Map;
2022

2123
import org.apache.cloudstack.api.APICommand;
2224
import org.apache.cloudstack.api.ApiConstants;
@@ -62,6 +64,13 @@ public class CloneNetworkOfferingCmd extends NetworkOfferingBaseCmd {
6264
"If specified along with 'supportedservices', this parameter is ignored.")
6365
private List<String> dropServices;
6466

67+
@Parameter(name = ApiConstants.CLEAN_UP_DETAILS,
68+
type = CommandType.BOOLEAN,
69+
description = "Whether to omit network offering details from the clone. If true, source details are not copied " +
70+
"and the details parameter is ignored. If false or omitted, details are inherited unless explicitly supplied.",
71+
since = "24.0")
72+
private Boolean cleanupDetails;
73+
6574
@Parameter(name = ApiConstants.TRAFFIC_TYPE,
6675
type = CommandType.STRING,
6776
description = "The traffic type for the network offering. Supported type in current release is GUEST only")
@@ -87,6 +96,15 @@ public List<String> getDropServices() {
8796
return dropServices;
8897
}
8998

99+
public boolean isCleanupDetails() {
100+
return Boolean.TRUE.equals(cleanupDetails);
101+
}
102+
103+
@Override
104+
public Map<String, String> getDetails() {
105+
return isCleanupDetails() ? Collections.emptyMap() : super.getDetails();
106+
}
107+
90108
public String getGuestIpType() {
91109
return guestIptype;
92110
}

‎api/src/main/java/org/apache/cloudstack/api/command/admin/network/NetworkOfferingBaseCmd.java‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@
4040
import java.util.List;
4141
import java.util.Map;
4242
import java.util.Set;
43-
import java.util.stream.Collectors;
4443

4544
import static com.cloud.network.Network.Service.Dhcp;
4645
import static com.cloud.network.Network.Service.Dns;
@@ -167,7 +166,9 @@ public abstract class NetworkOfferingBaseCmd extends BaseCmd {
167166

168167
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, since = "4.2.0", description = "Network offering details in key/value pairs."
169168
+ " Supported keys are internallbprovider/publiclbprovider with service provider as a value, and"
170-
+ " promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup")
169+
+ " promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup."
170+
+ " NSX offerings also support nsxipdiscoveryprofileid, nsxmacdiscoveryprofileid, and nsxsegmentsecurityprofileid."
171+
+ " Values are IDs of existing operator-managed NSX profiles to bind to segments created from the offering.")
171172
protected Map details;
172173

173174
@Parameter(name = ApiConstants.EGRESS_DEFAULT_POLICY,
@@ -382,18 +383,18 @@ private void getServiceProviderMapForExternalProvider(Map<String, List<String>>
382383
VirtualRouterProvider.Type.VirtualRouter.name();
383384
List<String> unsupportedServices = new ArrayList<>(List.of("Vpn", "Gateway", "SecurityGroup", "Connectivity", "BaremetalPxeService"));
384385
List<String> routerSupported = List.of("Dhcp", "Dns", "UserData");
385-
List<String> allServices = Network.Service.listAllServices().stream().map(Network.Service::getName).collect(Collectors.toList());
386386
if (routerProvider.equals(VirtualRouterProvider.Type.VPCVirtualRouter.name())) {
387387
unsupportedServices.add("Firewall");
388388
} else {
389389
unsupportedServices.add("NetworkACL");
390390
}
391-
for (String service : allServices) {
391+
for (String service : getSupportedServices()) {
392392
if (unsupportedServices.contains(service))
393393
continue;
394394
if (routerSupported.contains(service))
395395
serviceProviderMap.put(service, List.of(routerProvider));
396-
else if (NetworkOffering.NetworkMode.NATTED.name().equalsIgnoreCase(getNetworkMode()) || NetworkACL.getName().equalsIgnoreCase(service)) {
396+
else if (NetworkOffering.NetworkMode.NATTED.name().equalsIgnoreCase(getNetworkMode()) || NetworkACL.getName().equalsIgnoreCase(service)
397+
|| (isForNsx() && Firewall.getName().equalsIgnoreCase(service))) {
397398
serviceProviderMap.put(service, List.of(provider));
398399
}
399400
if (isNsxWithoutLb(getProvider(), getNsxSupportsLbService()) || isNetrisRouted(getProvider(), getNetworkMode())) {

‎api/src/test/java/org/apache/cloudstack/api/command/admin/network/CloneNetworkOfferingCmdTest.java‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,10 @@
3535
import java.util.Map;
3636

3737
import static org.junit.Assert.assertEquals;
38+
import static org.junit.Assert.assertFalse;
3839
import static org.junit.Assert.assertNotNull;
3940
import static org.junit.Assert.assertNull;
41+
import static org.junit.Assert.assertTrue;
4042
import static org.junit.Assert.fail;
4143
import static org.mockito.ArgumentMatchers.any;
4244
import static org.mockito.Mockito.when;
@@ -86,6 +88,43 @@ public void testGetDropServices() {
8688
assertEquals(dropServices, cloneNetworkOfferingCmd.getDropServices());
8789
}
8890

91+
@Test
92+
public void testDetailsAreInheritedWhenCleanupIsOmittedOrFalse() {
93+
Map<String, String> sourceDetails = Map.of("NsxIpDiscoveryProfileId", "source-ip-profile");
94+
ReflectionTestUtils.setField(cloneNetworkOfferingCmd, "sourceDetailsMap", sourceDetails);
95+
96+
assertFalse(cloneNetworkOfferingCmd.isCleanupDetails());
97+
assertEquals(sourceDetails, cloneNetworkOfferingCmd.getDetails());
98+
99+
ReflectionTestUtils.setField(cloneNetworkOfferingCmd, "cleanupDetails", false);
100+
assertEquals(sourceDetails, cloneNetworkOfferingCmd.getDetails());
101+
}
102+
103+
@Test
104+
public void testSuppliedDetailsReplaceSourceDetails() {
105+
Map<String, String> sourceDetails = Map.of("NsxIpDiscoveryProfileId", "source-ip-profile",
106+
"NsxMacDiscoveryProfileId", "source-mac-profile");
107+
Map<String, String> requestedDetails = Map.of("nsxipdiscoveryprofileid", "replacement-ip-profile");
108+
ReflectionTestUtils.setField(cloneNetworkOfferingCmd, "sourceDetailsMap", sourceDetails);
109+
ReflectionTestUtils.setField(cloneNetworkOfferingCmd, "details", Map.of("0", requestedDetails));
110+
111+
assertEquals(requestedDetails, cloneNetworkOfferingCmd.getDetails());
112+
}
113+
114+
@Test
115+
public void testCleanupDetailsOmitsInheritedAndSuppliedDetails() {
116+
Map<String, String> sourceDetails = Map.of("NsxIpDiscoveryProfileId", "source-ip-profile");
117+
ReflectionTestUtils.setField(cloneNetworkOfferingCmd, "sourceDetailsMap", sourceDetails);
118+
ReflectionTestUtils.setField(cloneNetworkOfferingCmd, "cleanupDetails", true);
119+
120+
assertTrue(cloneNetworkOfferingCmd.getDetails().isEmpty());
121+
122+
ReflectionTestUtils.setField(cloneNetworkOfferingCmd, "details",
123+
Map.of("0", Map.of("nsxipdiscoveryprofileid", "replacement-ip-profile")));
124+
assertTrue(cloneNetworkOfferingCmd.getDetails().isEmpty());
125+
assertEquals("source-ip-profile", sourceDetails.get("NsxIpDiscoveryProfileId"));
126+
}
127+
89128
@Test
90129
public void testGetGuestIpType() {
91130
String guestIpType = "Isolated";

‎api/src/test/java/org/apache/cloudstack/api/command/admin/offering/CreateNetworkOfferingCmdTest.java‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717

1818
package org.apache.cloudstack.api.command.admin.offering;
1919

20+
import java.util.List;
21+
import java.util.Map;
22+
2023
import org.apache.cloudstack.api.command.admin.network.CreateNetworkOfferingCmd;
2124
import org.junit.Assert;
2225
import org.junit.Test;
@@ -36,4 +39,57 @@ public void createVpcNtwkOffWithEmptyDisplayText() {
3639
ReflectionTestUtils.setField(createNetworkOfferingCmd, "networkOfferingName", netName);
3740
Assert.assertEquals(createNetworkOfferingCmd.getDisplayText(), netName);
3841
}
42+
43+
@Test
44+
public void nsxNattedNetworkUsesNsxFirewallAndNatServices() {
45+
assertServiceProviders("NSX", "NATTED", false, Map.of(
46+
"Dhcp", List.of("VirtualRouter"), "Dns", List.of("VirtualRouter"), "UserData", List.of("VirtualRouter"),
47+
"Firewall", List.of("Nsx"), "SourceNat", List.of("Nsx"), "StaticNat", List.of("Nsx"), "PortForwarding", List.of("Nsx")));
48+
}
49+
50+
@Test
51+
public void nsxNattedVpcTierUsesNsxAclAndNatServices() {
52+
assertServiceProviders("NSX", "NATTED", true, Map.of(
53+
"Dhcp", List.of("VPCVirtualRouter"), "Dns", List.of("VPCVirtualRouter"), "UserData", List.of("VPCVirtualRouter"),
54+
"NetworkACL", List.of("Nsx"), "SourceNat", List.of("Nsx"), "StaticNat", List.of("Nsx"), "PortForwarding", List.of("Nsx")));
55+
}
56+
57+
@Test
58+
public void nsxRoutedNetworkUsesNsxFirewallWithoutNatServices() {
59+
assertServiceProviders("NSX", "ROUTED", false, Map.of(
60+
"Dhcp", List.of("VirtualRouter"), "Dns", List.of("VirtualRouter"), "UserData", List.of("VirtualRouter"),
61+
"Firewall", List.of("Nsx")));
62+
}
63+
64+
@Test
65+
public void nsxRoutedVpcTierUsesNsxAclWithoutNatServices() {
66+
assertServiceProviders("NSX", "ROUTED", true, Map.of(
67+
"Dhcp", List.of("VPCVirtualRouter"), "Dns", List.of("VPCVirtualRouter"), "UserData", List.of("VPCVirtualRouter"),
68+
"NetworkACL", List.of("Nsx")));
69+
}
70+
71+
@Test
72+
public void netrisNattedNetworkKeepsNetrisNatAndLoadBalancerProviders() {
73+
assertServiceProviders("Netris", "NATTED", false, Map.of(
74+
"Dhcp", List.of("VirtualRouter"), "Dns", List.of("VirtualRouter"), "UserData", List.of("VirtualRouter"),
75+
"Firewall", List.of("Netris"), "SourceNat", List.of("Netris"), "StaticNat", List.of("Netris"),
76+
"PortForwarding", List.of("Netris"), "Lb", List.of("Netris"), "Vpn", List.of("VirtualRouter")));
77+
}
78+
79+
@Test
80+
public void netrisRoutedNetworkKeepsOnlyRouterProviders() {
81+
assertServiceProviders("Netris", "ROUTED", false, Map.of(
82+
"Dhcp", List.of("VirtualRouter"), "Dns", List.of("VirtualRouter"), "UserData", List.of("VirtualRouter")));
83+
}
84+
85+
private void assertServiceProviders(String provider, String networkMode, boolean forVpc, Map<String, List<String>> expected) {
86+
ReflectionTestUtils.setField(createNetworkOfferingCmd, "provider", provider);
87+
ReflectionTestUtils.setField(createNetworkOfferingCmd, "networkMode", networkMode);
88+
ReflectionTestUtils.setField(createNetworkOfferingCmd, "forVpc", forVpc);
89+
90+
Map<String, List<String>> providers = createNetworkOfferingCmd.getServiceProviders();
91+
92+
Assert.assertEquals(expected, providers);
93+
Assert.assertTrue(createNetworkOfferingCmd.getSupportedServices().containsAll(providers.keySet()));
94+
}
3995
}

‎plugins/network-elements/nsx/src/main/java/org/apache/cloudstack/agent/api/CreateNsxSegmentCommand.java‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,31 @@ public class CreateNsxSegmentCommand extends NsxCommand {
2626
private String networkName;
2727
private String networkGateway;
2828
private String networkCidr;
29+
private String ipDiscoveryProfileId;
30+
private String macDiscoveryProfileId;
31+
private String segmentSecurityProfileId;
2932

3033
public CreateNsxSegmentCommand(long domainId, long accountId, long zoneId,
3134
Long vpcId, String vpcName, long networkId, String networkName,
3235
String networkGateway, String networkCidr) {
36+
this(domainId, accountId, zoneId, vpcId, vpcName, networkId, networkName, networkGateway,
37+
networkCidr, null, null, null);
38+
}
39+
40+
public CreateNsxSegmentCommand(long domainId, long accountId, long zoneId,
41+
Long vpcId, String vpcName, long networkId, String networkName,
42+
String networkGateway, String networkCidr, String ipDiscoveryProfileId,
43+
String macDiscoveryProfileId, String segmentSecurityProfileId) {
3344
super(domainId, accountId, zoneId);
3445
this.vpcId = vpcId;
3546
this.vpcName = vpcName;
3647
this.networkId = networkId;
3748
this.networkName = networkName;
3849
this.networkGateway = networkGateway;
3950
this.networkCidr = networkCidr;
51+
this.ipDiscoveryProfileId = ipDiscoveryProfileId;
52+
this.macDiscoveryProfileId = macDiscoveryProfileId;
53+
this.segmentSecurityProfileId = segmentSecurityProfileId;
4054
}
4155

4256
public Long getVpcId() {
@@ -63,6 +77,18 @@ public String getNetworkCidr() {
6377
return networkCidr;
6478
}
6579

80+
public String getIpDiscoveryProfileId() {
81+
return ipDiscoveryProfileId;
82+
}
83+
84+
public String getMacDiscoveryProfileId() {
85+
return macDiscoveryProfileId;
86+
}
87+
88+
public String getSegmentSecurityProfileId() {
89+
return segmentSecurityProfileId;
90+
}
91+
6692
@Override
6793
public boolean equals(Object o) {
6894
if (this == o) return true;

‎plugins/network-elements/nsx/src/main/java/org/apache/cloudstack/resource/NsxResource.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,8 @@ private Answer executeRequest(CreateNsxSegmentCommand cmd) {
351351
boolean isResourceVpc = !Objects.isNull(cmd.getVpcId());
352352
String tier1GatewayName = NsxControllerUtils.getTier1GatewayName(cmd.getDomainId(), cmd.getAccountId(),
353353
cmd.getZoneId(), networkResourceId, isResourceVpc);
354-
nsxApiClient.createSegment(segmentName, tier1GatewayName, gatewayAddress, enforcementPointPath, transportZones);
354+
nsxApiClient.createSegment(segmentName, tier1GatewayName, gatewayAddress, enforcementPointPath, transportZones,
355+
cmd.getIpDiscoveryProfileId(), cmd.getMacDiscoveryProfileId(), cmd.getSegmentSecurityProfileId());
355356
nsxApiClient.createGroupForSegment(segmentName);
356357
} catch (Exception e) {
357358
logger.error(String.format("Failed to create network: %s", cmd.getNetworkName()));

0 commit comments

Comments
 (0)