CORD-247 Add host management network interface to integration bridge
- Node can have management network connectivity by adding "hostManagementIface"
field to the network config "nodes" block, it's optional field
- Added Builder of CordVtnNode
- Improved cordvtn-node-check result
- Some renamings, intBrId -> integrationBridgeId, dpIp -> dataIp,
dpIntf -> dataIface, and dpPort -> dataPort
Change-Id: Iad16237e7f118886d5f3fa5a46f9e9f9649fe997
diff --git a/src/main/java/org/opencord/cordvtn/api/Constants.java b/src/main/java/org/opencord/cordvtn/api/Constants.java
index b4c7329..bee5734 100644
--- a/src/main/java/org/opencord/cordvtn/api/Constants.java
+++ b/src/main/java/org/opencord/cordvtn/api/Constants.java
@@ -15,6 +15,8 @@
*/
package org.opencord.cordvtn.api;
+import org.onlab.packet.TpPort;
+
/**
* Provides constants used in CORD VTN services.
*/
@@ -30,8 +32,10 @@
public static final String MSG_OK = "OK";
public static final String MSG_NO = "NO";
- public static final String PORT_NAME = "portName";
public static final String DEFAULT_TUNNEL = "vxlan";
- public static final String DEFAULT_BRIDGE = "br-int";
+ public static final String INTEGRATION_BRIDGE = "br-int";
public static final String VPORT_PREFIX = "tap";
+
+ public static final int OF_PORT = 6653;
+ public static final TpPort OVSDB_PORT = TpPort.tpPort(6640);
}
diff --git a/src/main/java/org/opencord/cordvtn/api/CordVtnConfig.java b/src/main/java/org/opencord/cordvtn/api/CordVtnConfig.java
index 10bc6a1..29ffaea 100644
--- a/src/main/java/org/opencord/cordvtn/api/CordVtnConfig.java
+++ b/src/main/java/org/opencord/cordvtn/api/CordVtnConfig.java
@@ -16,14 +16,13 @@
package org.opencord.cordvtn.api;
import com.fasterxml.jackson.databind.JsonNode;
+import com.google.common.base.Strings;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
-import org.onlab.packet.Ip4Address;
import org.onlab.packet.IpAddress;
import org.onlab.packet.MacAddress;
import org.onlab.packet.TpPort;
import org.onosproject.core.ApplicationId;
-import org.onosproject.net.DeviceId;
import org.onosproject.net.config.Config;
import org.onosproject.xosclient.api.OpenStackAccess;
import org.onosproject.xosclient.api.XosAccess;
@@ -51,9 +50,10 @@
private static final String CORDVTN_NODES = "nodes";
private static final String HOSTNAME = "hostname";
private static final String HOST_MANAGEMENT_IP = "hostManagementIp";
- private static final String DATA_PLANE_IP = "dataPlaneIp";
- private static final String DATA_PLANE_INTF = "dataPlaneIntf";
- private static final String BRIDGE_ID = "bridgeId";
+ private static final String HOST_MANAGEMENT_IFACE = "hostManagementIface";
+ private static final String DATA_IP = "dataPlaneIp";
+ private static final String DATA_IFACE = "dataPlaneIntf";
+ private static final String INTEGRATION_BRIDGE_ID = "bridgeId";
private static final String SSH = "ssh";
private static final String SSH_PORT = "sshPort";
@@ -68,6 +68,8 @@
private static final String USER = "user";
private static final String PASSWORD = "password";
+ // TODO implement isValid
+
/**
* Returns the set of nodes read from network config.
*
@@ -77,6 +79,7 @@
Set<CordVtnNode> nodes = Sets.newHashSet();
+ // TODO implement isValid and move these blocks to it
JsonNode cordvtnNodes = object.get(CORDVTN_NODES);
if (cordvtnNodes == null) {
log.debug("No CORD VTN nodes found");
@@ -90,37 +93,42 @@
}
for (JsonNode cordvtnNode : cordvtnNodes) {
- try {
- NetworkAddress hostMgmt = NetworkAddress.valueOf(getConfig(cordvtnNode, HOST_MANAGEMENT_IP));
- NetworkAddress localMgmt = NetworkAddress.valueOf(getConfig(object, LOCAL_MANAGEMENT_IP));
- if (hostMgmt.prefix().contains(localMgmt.prefix()) ||
- localMgmt.prefix().contains(hostMgmt.prefix())) {
- log.error("hostMamt and localMgmt cannot be overlapped, skip this node");
- continue;
- }
-
- Ip4Address hostMgmtIp = hostMgmt.ip().getIp4Address();
- SshAccessInfo sshInfo = new SshAccessInfo(
- hostMgmtIp,
- TpPort.tpPort(Integer.parseInt(getConfig(sshNode, SSH_PORT))),
- getConfig(sshNode, SSH_USER), getConfig(sshNode, SSH_KEY_FILE));
-
- String hostname = getConfig(cordvtnNode, HOSTNAME);
- CordVtnNode newNode = new CordVtnNode(
- hostname, hostMgmt, localMgmt,
- NetworkAddress.valueOf(getConfig(cordvtnNode, DATA_PLANE_IP)),
- TpPort.tpPort(Integer.parseInt(getConfig(object, OVSDB_PORT))),
- sshInfo,
- DeviceId.deviceId(getConfig(cordvtnNode, BRIDGE_ID)),
- getConfig(cordvtnNode, DATA_PLANE_INTF),
- CordVtnNodeState.noState());
-
- nodes.add(newNode);
- } catch (IllegalArgumentException | NullPointerException e) {
- log.error("{}", e);
+ // TODO implement isValid and move this block to it
+ NetworkAddress hostMgmt = NetworkAddress.valueOf(getConfig(cordvtnNode, HOST_MANAGEMENT_IP));
+ NetworkAddress localMgmt = NetworkAddress.valueOf(getConfig(object, LOCAL_MANAGEMENT_IP));
+ if (hostMgmt.prefix().contains(localMgmt.prefix()) ||
+ localMgmt.prefix().contains(hostMgmt.prefix())) {
+ log.error("hostMamt and localMgmt cannot be overlapped, skip this node");
+ continue;
}
- }
+ String hostname = getConfig(cordvtnNode, HOSTNAME);
+ SshAccessInfo sshInfo = new SshAccessInfo(
+ hostMgmt.ip().getIp4Address(),
+ TpPort.tpPort(Integer.parseInt(getConfig(sshNode, SSH_PORT))),
+ getConfig(sshNode, SSH_USER), getConfig(sshNode, SSH_KEY_FILE));
+
+ CordVtnNode.Builder nodeBuilder = CordVtnNode.builder()
+ .hostname(hostname)
+ .hostMgmtIp(hostMgmt)
+ .localMgmtIp(localMgmt)
+ .dataIp(getConfig(cordvtnNode, DATA_IP))
+ .sshInfo(sshInfo)
+ .integrationBridgeId(getConfig(cordvtnNode, INTEGRATION_BRIDGE_ID))
+ .dataIface(getConfig(cordvtnNode, DATA_IFACE));
+
+ String ovsdbPort = getConfig(object, OVSDB_PORT);
+ if (!Strings.isNullOrEmpty(ovsdbPort)) {
+ nodeBuilder.ovsdbPort(Integer.parseInt(ovsdbPort));
+ }
+
+ String hostMgmtIface = getConfig(cordvtnNode, HOST_MANAGEMENT_IFACE);
+ if (!Strings.isNullOrEmpty(hostMgmtIface)) {
+ nodeBuilder.hostMgmtIface(hostMgmtIface);
+ }
+
+ nodes.add(nodeBuilder.build());
+ }
return nodes;
}
@@ -135,7 +143,7 @@
jsonNode = jsonNode.path(path);
if (jsonNode.isMissingNode()) {
- log.error("{} is not configured", path);
+ log.debug("{} is not configured", path);
return null;
} else {
return jsonNode.asText();
diff --git a/src/main/java/org/opencord/cordvtn/api/CordVtnNode.java b/src/main/java/org/opencord/cordvtn/api/CordVtnNode.java
index b251b49..206220f 100644
--- a/src/main/java/org/opencord/cordvtn/api/CordVtnNode.java
+++ b/src/main/java/org/opencord/cordvtn/api/CordVtnNode.java
@@ -16,13 +16,20 @@
package org.opencord.cordvtn.api;
import com.google.common.base.MoreObjects;
+import com.google.common.base.Strings;
+import com.google.common.collect.Sets;
import org.onlab.packet.TpPort;
import org.onosproject.net.DeviceId;
import java.util.Comparator;
import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
+import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
+import static org.opencord.cordvtn.api.Constants.DEFAULT_TUNNEL;
+import static org.opencord.cordvtn.api.Constants.OVSDB_PORT;
/**
* Representation of a compute infrastructure node for CORD VTN service.
@@ -32,11 +39,12 @@
private final String hostname;
private final NetworkAddress hostMgmtIp;
private final NetworkAddress localMgmtIp;
- private final NetworkAddress dpIp;
- private final TpPort ovsdbPort;
+ private final NetworkAddress dataIp;
+ private final Optional<TpPort> ovsdbPort;
private final SshAccessInfo sshInfo;
- private final DeviceId bridgeId;
- private final String dpIntf;
+ private final DeviceId integrationBridgeId;
+ private final String dataIface;
+ private final Optional<String> hostMgmtIface;
private final CordVtnNodeState state;
public static final Comparator<CordVtnNode> CORDVTN_NODE_COMPARATOR =
@@ -48,24 +56,33 @@
* @param hostname hostname
* @param hostMgmtIp host management network address
* @param localMgmtIp local management network address
- * @param dpIp data plane network address
- * @param ovsdbPort port number for OVSDB connection
- * @param sshInfo SSH access information
- * @param bridgeId integration bridge identifier
- * @param dpIntf data plane interface name
+ * @param dataIp data network address
+ * @param ovsdbPort port number for ovsdb connection
+ * @param sshInfo ssh access information
+ * @param integrationBridgeId integration bridge identifier
+ * @param dataIface data plane interface name
+ * @param hostMgmtIface host management network interface
* @param state cordvtn node state
*/
- public CordVtnNode(String hostname, NetworkAddress hostMgmtIp, NetworkAddress localMgmtIp,
- NetworkAddress dpIp, TpPort ovsdbPort, SshAccessInfo sshInfo,
- DeviceId bridgeId, String dpIntf, CordVtnNodeState state) {
- this.hostname = checkNotNull(hostname, "hostname cannot be null");
- this.hostMgmtIp = checkNotNull(hostMgmtIp, "hostMgmtIp cannot be null");
- this.localMgmtIp = checkNotNull(localMgmtIp, "localMgmtIp cannot be null");
- this.dpIp = checkNotNull(dpIp, "dpIp cannot be null");
- this.ovsdbPort = checkNotNull(ovsdbPort, "ovsdbPort cannot be null");
- this.sshInfo = checkNotNull(sshInfo, "sshInfo cannot be null");
- this.bridgeId = checkNotNull(bridgeId, "bridgeId cannot be null");
- this.dpIntf = checkNotNull(dpIntf, "dpIntf cannot be null");
+ private CordVtnNode(String hostname,
+ NetworkAddress hostMgmtIp,
+ NetworkAddress localMgmtIp,
+ NetworkAddress dataIp,
+ Optional<TpPort> ovsdbPort,
+ SshAccessInfo sshInfo,
+ DeviceId integrationBridgeId,
+ String dataIface,
+ Optional<String> hostMgmtIface,
+ CordVtnNodeState state) {
+ this.hostname = hostname;
+ this.hostMgmtIp = hostMgmtIp;
+ this.localMgmtIp = localMgmtIp;
+ this.dataIp = dataIp;
+ this.ovsdbPort = ovsdbPort;
+ this.sshInfo = sshInfo;
+ this.integrationBridgeId = integrationBridgeId;
+ this.dataIface = dataIface;
+ this.hostMgmtIface = hostMgmtIface;
this.state = state;
}
@@ -78,11 +95,12 @@
*/
public static CordVtnNode getUpdatedNode(CordVtnNode node, CordVtnNodeState state) {
return new CordVtnNode(node.hostname,
- node.hostMgmtIp, node.localMgmtIp, node.dpIp,
+ node.hostMgmtIp, node.localMgmtIp, node.dataIp,
node.ovsdbPort,
node.sshInfo,
- node.bridgeId,
- node.dpIntf, state);
+ node.integrationBridgeId,
+ node.dataIface, node.hostMgmtIface,
+ state);
}
/**
@@ -113,21 +131,26 @@
}
/**
- * Returns the data plane network address.
+ * Returns the data network address.
*
* @return network address
*/
- public NetworkAddress dpIp() {
- return this.dpIp;
+ public NetworkAddress dataIp() {
+ return this.dataIp;
}
/**
* Returns the port number used for OVSDB connection.
+ * It returns default OVSDB port 6640, if it's not specified.
*
* @return port number
*/
public TpPort ovsdbPort() {
- return this.ovsdbPort;
+ if (this.ovsdbPort.isPresent()) {
+ return this.ovsdbPort.get();
+ } else {
+ return OVSDB_PORT;
+ }
}
/**
@@ -144,8 +167,8 @@
*
* @return device id
*/
- public DeviceId intBrId() {
- return this.bridgeId;
+ public DeviceId integrationBridgeId() {
+ return this.integrationBridgeId;
}
/**
@@ -158,12 +181,34 @@
}
/**
- * Returns data plane interface name.
+ * Returns data network interface name.
*
- * @return data plane interface name
+ * @return data network interface name
*/
- public String dpIntf() {
- return this.dpIntf;
+ public String dataIface() {
+ return this.dataIface;
+ }
+
+ /**
+ * Returns host management network interface name.
+ *
+ * @return host management network interface name
+ */
+ public Optional<String> hostMgmtIface() {
+ return this.hostMgmtIface;
+ }
+
+ /**
+ * Returns a set of network interfaces for the VTN service to work properly.
+ *
+ * @return set of interface names
+ */
+ public Set<String> systemIfaces() {
+ Set<String> ifaces = Sets.newHashSet(DEFAULT_TUNNEL, dataIface);
+ if (hostMgmtIface.isPresent()) {
+ ifaces.add(hostMgmtIface.get());
+ }
+ return ifaces;
}
/**
@@ -186,11 +231,12 @@
if (Objects.equals(hostname, that.hostname) &&
Objects.equals(hostMgmtIp, that.hostMgmtIp) &&
Objects.equals(localMgmtIp, that.localMgmtIp) &&
- Objects.equals(dpIp, that.dpIp) &&
+ Objects.equals(dataIp, that.dataIp) &&
Objects.equals(ovsdbPort, that.ovsdbPort) &&
Objects.equals(sshInfo, that.sshInfo) &&
- Objects.equals(bridgeId, that.bridgeId) &&
- Objects.equals(dpIntf, that.dpIntf)) {
+ Objects.equals(integrationBridgeId, that.integrationBridgeId) &&
+ Objects.equals(dataIface, that.dataIface) &&
+ Objects.equals(hostMgmtIface, that.hostMgmtIface)) {
return true;
}
}
@@ -199,8 +245,15 @@
@Override
public int hashCode() {
- return Objects.hash(hostname, hostMgmtIp, localMgmtIp, dpIp,
- ovsdbPort, sshInfo, bridgeId, dpIntf);
+ return Objects.hash(hostname,
+ hostMgmtIp,
+ localMgmtIp,
+ dataIp,
+ ovsdbPort,
+ sshInfo,
+ integrationBridgeId,
+ dataIface,
+ hostMgmtIface);
}
@Override
@@ -209,12 +262,240 @@
.add("hostname", hostname)
.add("hostMgmtIp", hostMgmtIp)
.add("localMgmtIp", localMgmtIp)
- .add("dpIp", dpIp)
+ .add("dataIp", dataIp)
.add("port", ovsdbPort)
.add("sshInfo", sshInfo)
- .add("bridgeId", bridgeId)
- .add("dpIntf", dpIntf)
+ .add("integrationBridgeId", integrationBridgeId)
+ .add("dataIface", dataIface)
+ .add("hostMgmtIface", hostMgmtIface)
.add("state", state)
.toString();
}
+
+ /**
+ * Returns new node builder instance.
+ *
+ * @return cordvtn node builder
+ */
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ /**
+ * Builder of node entities.
+ */
+ public static final class Builder {
+ private String hostname;
+ private NetworkAddress hostMgmtIp;
+ private NetworkAddress localMgmtIp;
+ private NetworkAddress dataIp;
+ private Optional<TpPort> ovsdbPort = Optional.of(OVSDB_PORT);
+ private SshAccessInfo sshInfo;
+ private DeviceId integrationBridgeId;
+ private String dataIface;
+ private Optional<String> hostMgmtIface = Optional.empty();
+ private CordVtnNodeState state = CordVtnNodeState.noState();
+
+ private Builder() {
+ }
+
+ /**
+ * Builds an immutable cordvtn node.
+ *
+ * @return cordvtn node
+ */
+ public CordVtnNode build() {
+ // validate attributes
+ checkArgument(!Strings.isNullOrEmpty(hostname));
+ checkNotNull(hostMgmtIp);
+ checkNotNull(localMgmtIp);
+ checkNotNull(dataIp);
+ checkNotNull(ovsdbPort);
+ checkNotNull(sshInfo);
+ checkNotNull(integrationBridgeId);
+ checkNotNull(dataIface);
+ checkNotNull(hostMgmtIface);
+ return new CordVtnNode(hostname,
+ hostMgmtIp, localMgmtIp, dataIp,
+ ovsdbPort,
+ sshInfo,
+ integrationBridgeId,
+ dataIface,
+ hostMgmtIface,
+ state);
+ }
+
+ /**
+ * Returns cordvtn node builder with hostname.
+ *
+ * @param hostname hostname
+ * @return cordvtn node builder
+ */
+ public Builder hostname(String hostname) {
+ checkArgument(!Strings.isNullOrEmpty(hostname));
+ this.hostname = hostname;
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with host management network IP address.
+ *
+ * @param hostMgmtIp host management netework ip address
+ * @return cordvtn node builder
+ */
+ public Builder hostMgmtIp(NetworkAddress hostMgmtIp) {
+ checkNotNull(hostMgmtIp);
+ this.hostMgmtIp = hostMgmtIp;
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with host management network IP address.
+ *
+ * @param cidr string value of the host management network ip address
+ * @return cordvtn node builder
+ */
+ public Builder hostMgmtIp(String cidr) {
+ this.hostMgmtIp = NetworkAddress.valueOf(cidr);
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with local management network IP address.
+ *
+ * @param localMgmtIp local management network ip address
+ * @return cordvtn node builder
+ */
+ public Builder localMgmtIp(NetworkAddress localMgmtIp) {
+ checkNotNull(localMgmtIp);
+ this.localMgmtIp = localMgmtIp;
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with local management netework IP address.
+ *
+ * @param cidr string value of the local management network ip address
+ * @return cordvtn node builder
+ */
+ public Builder localMgmtIp(String cidr) {
+ this.localMgmtIp = NetworkAddress.valueOf(cidr);
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with data network IP address.
+ *
+ * @param dataIp data network ip address
+ * @return cordvtn node builder
+ */
+ public Builder dataIp(NetworkAddress dataIp) {
+ checkNotNull(dataIp);
+ this.dataIp = dataIp;
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with data network IP address.
+ *
+ * @param cidr string value of the data network ip address
+ * @return cordvtn node builder
+ */
+ public Builder dataIp(String cidr) {
+ this.dataIp = NetworkAddress.valueOf(cidr);
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with OVSDB server listen port number.
+ *
+ * @param port ovsdb server listen port number
+ * @return cordvtn node builder
+ */
+ public Builder ovsdbPort(TpPort port) {
+ checkNotNull(port);
+ this.ovsdbPort = Optional.of(port);
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with OVSDB server listen port number.
+ *
+ * @param port int value of the ovsdb server listen port number
+ * @return cordvtn node builder
+ */
+ public Builder ovsdbPort(int port) {
+ this.ovsdbPort = Optional.of(TpPort.tpPort(port));
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with SSH access information.
+ * @param sshInfo ssh access information
+ * @return cordvtn node builder
+ */
+ public Builder sshInfo(SshAccessInfo sshInfo) {
+ checkNotNull(sshInfo);
+ this.sshInfo = sshInfo;
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with integration bridge ID.
+ *
+ * @param deviceId device id of the integration bridge
+ * @return cordvtn node builder
+ */
+ public Builder integrationBridgeId(DeviceId deviceId) {
+ checkNotNull(deviceId);
+ this.integrationBridgeId = deviceId;
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with integration bridge ID.
+ *
+ * @param deviceId string value of the integration bridge device id
+ * @return cordvtn node builder
+ */
+ public Builder integrationBridgeId(String deviceId) {
+ this.integrationBridgeId = DeviceId.deviceId(deviceId);
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with data network interface name.
+ *
+ * @param dataIface data network interface name
+ * @return cordvtn node builder
+ */
+ public Builder dataIface(String dataIface) {
+ checkArgument(!Strings.isNullOrEmpty(dataIface));
+ this.dataIface = dataIface;
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with host management network interface.
+ *
+ * @param hostMgmtIface host management network interface name
+ * @return cordvtn node builder
+ */
+ public Builder hostMgmtIface(String hostMgmtIface) {
+ this.hostMgmtIface = Optional.ofNullable(hostMgmtIface);
+ return this;
+ }
+
+ /**
+ * Returns cordvtn node builder with init state.
+ *
+ * @param state init state
+ * @return cordvtn node builder
+ */
+ public Builder state(CordVtnNodeState state) {
+ checkNotNull(state);
+ this.state = state;
+ return this;
+ }
+ }
}