The best examples will be in the Jupyterhub environment. We have pre-installed a suite of example notebooks from the following github repo. The notebooks are currently in development and will improve over time. You may need to do a git pull on the repo to get the newest example notebooks.
https://github.com/fabric-testbed/jupyter-examples
Specifically, the examples in this folder will be useful:
https://github.com/fabric-testbed/jupyter-examples/tree/master/fabric_examples/basic_examples
These notebooks are very new and maybe incomplete. I will try to update the notebooks today with the most current information.
More generally, there are 3 types of layer2 “Network Services” on FABRIC (layer3 services are still in development):
- L2Bridge: These bridges are like a local network switch/bridge that connects any number of local nodes within a single site. These local bridges are directly connected to the nodes so your bandwidth will be limited by the maximum bandwidth of the NICs that you are using (i.e. ConnectX_6 NICs will provide 100Gbps). This bridge is not programable and only performs simple MAC learning. The key use of these bridges are that they can only connect to nodes within a single FABRIC site.
- L2P2P (Peer-to-peer): These are peer-to-peer layer2 circuits that connect exactly 2 nodes. These nodes must be on different FABRIC sites. These circuits will have user specified QoS. QoS is currently in development and is not yet available. Once QoS is is available, user will be able to request dedicated bandwidths on these circuits.
- L2S2S (Site-to-site): Site-2-site is a hybrid of L2Bridge and L2P2P with some limitations. With S2S a user gets a pair of L2Bridges on different FABRIC sites that have a circuit connecting them. Any number of nodes on either of the sites can be connected to the single S2S Network Service. All nodes connected to the S2S service are on the same L2 network and can use the same layer3 subnet. One big limitation of S2S is that the wide are circuit will be best effort and will not have any guaranteed QoS. If you want guaranteed QoS, you will need to use L2P2P and setup your own routing or switching on each end.
Although the notebooks include examples of how to configure and use the data plane networks, the context below might be helpful.
When you add an interface to a network service you have a couple options. The interfaces can be tagged or untagged with VLANs. By default adding an interface to a network service will result in an untagged interface.
- untagged interfaces: These behave like an access port. In other words, any VLAN FABRIC assigned tags will be stripped from the layer2 traffic before it is passed to the user’s node. The user’s node will not need to process VLAN tags.
- tagged interfaces: The interfaces behave lit a trunk port. VLAN tags are left on the l2 traffic that enters the node. In this case, the user must process the VLAN tags with in the node. FABRIC allows the user to specify the VLAN tag that should be on the traffic as it enters the node. There are separate name spaces for these tags per interface so users are free to use any VLAN tag they wish and there will be no conflict with other users.
Tagged example that applies VLAN tag 200:
n1.add_component(model_type=ComponentModelType.SmartNIC_ConnectX_6, name='n1-nic1')
n2.add_component(model_type=ComponentModelType.SmartNIC_ConnectX_5, name='n2-nic1')
n1_iface=n1.interface_list[0]
n2_iface=n2.interface_list[0]
t.add_network_service(name='ptp1', nstype=ServiceType.L2PTP,
interfaces=[n1_iface, n2_iface])
if_labels = n1_iface.get_property(pname="labels")
if_labels.vlan = "200"
i.set_properties(labels=if_labels)
if_labels = n2_iface.get_property(pname="labels")
if_labels.vlan = "200"
i.set_properties(labels=if_labels)Let me know if this helps