docs: adding tutorial 1

This commit is contained in:
Blake J. Harnden 2023-06-05 11:11:00 -07:00
parent 01585b6ec5
commit a5727e3355
12 changed files with 764 additions and 0 deletions

View file

@ -0,0 +1,36 @@
from core.api.grpc import client
from core.api.grpc.wrappers import Position
def main():
# interface helper
iface_helper = client.InterfaceHelper(ip4_prefix="10.0.0.0/24", ip6_prefix="2001::/64")
# create grpc client and connect
core = client.CoreGrpcClient()
core.connect()
# create session
session = core.create_session()
# create nodes
position = Position(x=250, y=250)
node1 = session.add_node(_id=1, name="n1", position=position)
position = Position(x=500, y=250)
node2 = session.add_node(_id=2, name="n2", position=position)
# create link
node1_iface = iface_helper.create_iface(node_id=node1.id, iface_id=0)
node1_iface.ip4 = "10.0.0.20"
node1_iface.ip6 = "2001::14"
node2_iface = iface_helper.create_iface(node_id=node2.id, iface_id=0)
node2_iface.ip4 = "10.0.0.21"
node2_iface.ip6 = "2001::15"
session.add_link(node1=node1, node2=node2, iface1=node1_iface, iface2=node2_iface)
# start session
core.start_session(session=session)
if __name__ == "__main__":
main()

View file

@ -0,0 +1,77 @@
<?xml version='1.0' encoding='UTF-8'?>
<scenario name="/tmp/tmpa_gpqzdf">
<networks/>
<devices>
<device id="1" name="n1" icon="" canvas="1" type="PC" class="" image="">
<position x="250.0" y="250.0" lat="47.57679395743362" lon="-122.12891511224676" alt="2.0"/>
<configservices>
<service name="DefaultRoute"/>
</configservices>
</device>
<device id="2" name="n2" icon="" canvas="1" type="PC" class="" image="">
<position x="500.0" y="250.0" lat="47.576775777287395" lon="-122.12534430899237" alt="2.0"/>
<configservices>
<service name="DefaultRoute"/>
</configservices>
</device>
</devices>
<links>
<link node1="1" node2="2">
<iface1 id="0" name="eth0" mac="00:00:00:aa:00:00" ip4="10.0.0.20" ip4_mask="24" ip6="2001::14" ip6_mask="64"/>
<iface2 id="0" name="eth0" mac="00:00:00:aa:00:01" ip4="10.0.0.21" ip4_mask="24" ip6="2001::15" ip6_mask="64"/>
<options delay="0" bandwidth="0" loss="0.0" dup="0" jitter="0" unidirectional="0" buffer="0"/>
</link>
</links>
<emane_global_configuration>
<emulator/>
<core>
<configuration name="platform_id_start" value="1"/>
<configuration name="nem_id_start" value="1"/>
<configuration name="link_enabled" value="1"/>
<configuration name="loss_threshold" value="30"/>
<configuration name="link_interval" value="1"/>
<configuration name="link_timeout" value="4"/>
</core>
</emane_global_configuration>
<session_origin lat="47.579166412353516" lon="-122.13232421875" alt="2.0" scale="150.0"/>
<session_options>
<configuration name="controlnet" value=""/>
<configuration name="controlnet0" value=""/>
<configuration name="controlnet1" value=""/>
<configuration name="controlnet2" value=""/>
<configuration name="controlnet3" value=""/>
<configuration name="controlnet_updown_script" value=""/>
<configuration name="enablerj45" value="1"/>
<configuration name="preservedir" value="0"/>
<configuration name="enablesdt" value="0"/>
<configuration name="sdturl" value="tcp://127.0.0.1:50000/"/>
<configuration name="ovs" value="0"/>
</session_options>
<session_metadata>
<configuration name="shapes" value="[]"/>
<configuration name="hidden" value="[]"/>
<configuration name="canvas" value="{&quot;gridlines&quot;: true, &quot;dimensions&quot;: [1000, 750], &quot;canvases&quot;: [{&quot;id&quot;: 1, &quot;wallpaper&quot;: null, &quot;wallpaper_style&quot;: 1, &quot;fit_image&quot;: false}]}"/>
<configuration name="edges" value="[]"/>
</session_metadata>
<default_services>
<node type="mdr">
<service name="zebra"/>
<service name="OSPFv3MDR"/>
<service name="IPForward"/>
</node>
<node type="PC">
<service name="DefaultRoute"/>
</node>
<node type="prouter"/>
<node type="router">
<service name="zebra"/>
<service name="OSPFv2"/>
<service name="OSPFv3"/>
<service name="IPForward"/>
</node>
<node type="host">
<service name="DefaultRoute"/>
<service name="SSH"/>
</node>
</default_services>
</scenario>

View file

@ -0,0 +1,37 @@
from core.api.grpc import client
from core.api.grpc.wrappers import Position
def main():
# interface helper
iface_helper = client.InterfaceHelper(ip4_prefix="10.0.0.0/24", ip6_prefix="2001::/64")
# create grpc client and connect
core = client.CoreGrpcClient()
core.connect()
# create session
session = core.create_session()
# create nodes
position = Position(x=250, y=250)
node1 = session.add_node(_id=1, name="n1", position=position)
node1.config_services.add("ChatApp Server")
position = Position(x=500, y=250)
node2 = session.add_node(_id=2, name="n2", position=position)
# create link
node1_iface = iface_helper.create_iface(node_id=node1.id, iface_id=0)
node1_iface.ip4 = "10.0.0.20"
node1_iface.ip6 = "2001::14"
node2_iface = iface_helper.create_iface(node_id=node2.id, iface_id=0)
node2_iface.ip4 = "10.0.0.21"
node2_iface.ip6 = "2001::15"
session.add_link(node1=node1, node2=node2, iface1=node1_iface, iface2=node2_iface)
# start session
core.start_session(session=session)
if __name__ == "__main__":
main()

View file

@ -0,0 +1,81 @@
<?xml version='1.0' encoding='UTF-8'?>
<scenario name="/tmp/tmp2exmy1y9">
<networks/>
<devices>
<device id="1" name="n1" icon="" canvas="0" type="PC" class="" image="">
<position x="250.0" y="250.0" lat="47.576893948125004" lon="-122.12895553643455" alt="2.0"/>
<configservices>
<service name="ChatApp Server"/>
<service name="DefaultRoute"/>
</configservices>
</device>
<device id="2" name="n2" icon="" canvas="0" type="PC" class="" image="">
<position x="500.0" y="250.0" lat="47.576893948125004" lon="-122.12558685411909" alt="2.0"/>
<configservices>
<service name="DefaultRoute"/>
</configservices>
</device>
</devices>
<links>
<link node1="1" node2="2">
<iface1 id="0" name="eth0" mac="00:00:00:aa:00:00" ip4="10.0.0.20" ip4_mask="24" ip6="2001::14" ip6_mask="64"/>
<iface2 id="0" name="eth0" mac="00:00:00:aa:00:01" ip4="10.0.0.21" ip4_mask="24" ip6="2001::15" ip6_mask="64"/>
<options delay="0" bandwidth="0" loss="0.0" dup="0" jitter="0" unidirectional="0" buffer="0"/>
</link>
</links>
<emane_global_configuration>
<emulator/>
<core>
<configuration name="platform_id_start" value="1"/>
<configuration name="nem_id_start" value="1"/>
<configuration name="link_enabled" value="1"/>
<configuration name="loss_threshold" value="30"/>
<configuration name="link_interval" value="1"/>
<configuration name="link_timeout" value="4"/>
</core>
</emane_global_configuration>
<configservice_configurations>
<service name="ChatApp Server" node="1"/>
</configservice_configurations>
<session_origin lat="47.579166412353516" lon="-122.13232421875" alt="2.0" scale="150.0"/>
<session_options>
<configuration name="controlnet" value=""/>
<configuration name="controlnet0" value=""/>
<configuration name="controlnet1" value=""/>
<configuration name="controlnet2" value=""/>
<configuration name="controlnet3" value=""/>
<configuration name="controlnet_updown_script" value=""/>
<configuration name="enablerj45" value="1"/>
<configuration name="preservedir" value="0"/>
<configuration name="enablesdt" value="0"/>
<configuration name="sdturl" value="tcp://127.0.0.1:50000/"/>
<configuration name="ovs" value="0"/>
</session_options>
<session_metadata>
<configuration name="shapes" value="[]"/>
<configuration name="hidden" value="[]"/>
<configuration name="canvas" value="{&quot;gridlines&quot;: true, &quot;dimensions&quot;: [1000, 750], &quot;canvases&quot;: [{&quot;id&quot;: 1, &quot;wallpaper&quot;: null, &quot;wallpaper_style&quot;: 1, &quot;fit_image&quot;: false}]}"/>
<configuration name="edges" value="[]"/>
</session_metadata>
<default_services>
<node type="mdr">
<service name="zebra"/>
<service name="OSPFv3MDR"/>
<service name="IPForward"/>
</node>
<node type="PC">
<service name="DefaultRoute"/>
</node>
<node type="prouter"/>
<node type="router">
<service name="zebra"/>
<service name="OSPFv2"/>
<service name="OSPFv3"/>
<service name="IPForward"/>
</node>
<node type="host">
<service name="DefaultRoute"/>
<service name="SSH"/>
</node>
</default_services>
</scenario>