Updated: 20170928
The BGP and PCEP (Pathman) apps assume that you can connect to an OpenDaylight (ODL) Controller.
You will need the following information:
- IP address and Port of controller
- Authorization in the form of username and password
You topology would also need to be configured to interact with the ODL controller; BGP peering with BGP-LS speaker (i.e. one of the routers configured with BGP-LS) and PCEP peering enabled in all routers.
To simplify this step, we have implement a demonstration ODL controller and network topology available at dCloud. Below you will find the information required to have these apps interact with dCloud.
-
First, you need to connect to dcloud.cisco.com and signup. If you are a new user, you may need to first signup at cco.cisco.com, and then at dcloud.
-
When connecting to dcloud, you will first be prompted to select a datacenter near you (shown in 1). After that you will be prompted to set up a profile.
- If you have any trouble in getting your profile setup, please consult the Help tab.
Figure 1 dCloud data center selection screen
- Once connected to dCloud, you will see the content overview. From there, select Service Provider, and locate the OpenDayLight Boron SR4 with Apps with 8 nodes v1. demo.
Note that any newer ODL demo should work fine as well.
- Then select Start/Schedule and pick a time for when you want to have access to the topology, or now.
- Select the Session End time.
- Click Next and answer the "use" questions.
Now you are done and you should have a session being started for you.
Note: The Pathman_SR app has been tested with:
- Lithium
- Beryllium
- Boron
- Carbon
- Nitrogen
No changes are needed to run this app towards the above-mentioned topology in dCloud.
For other setups, you may need to change ip/port/auth details.
In your distribution, you will find two top-directories; pathman and next.
In pathman_ini.py you will find:
odl_ip = '198.18.1.80'
odl_port = '8181'
odl_user = 'admin'
odl_password = 'admin'
These values are fine once you have any-connected in to the dCloud session. (To use your own topology, edit these values to point to your local controller.)
Depending on where you have installed the apps, you may want to consider different options to access your active dCloud session.
-
Cisco AnyConnect Client - http://www.cisco.com/c/en/us/products/security/anyconnect-secure-mobility-client/index.html
-
Openconnect – see https://wiki.archlinux.org/index.php/OpenConnect
Regardless of client, you will need to check the access details for your session.
At dcloud.cisco.com, and the datacenter you have selected – click My Dashboard and you will find your active session(s) listed there.
Select you session's 'View' button and then 'Review Session Info', which takes you to Session Details. In Session Details, you will find your AnyConnect credentials.
And if you 'click here for available options', you will see a view like this:
Figure 2 Anyconnect session credentials screen
Once connected, your laptop will be in the same network as the routers in your topology and the ODL controller.
| IP | Port | Username | Password | Notes | |
|---|---|---|---|---|---|
| Karaf | 198.18.1.80 | 8101 | karaf | karaf | SSH exit command: ‘shell:logout’ |
| ODL host | 198.18.1.80 | 8022 | cisco | cisco | SSH |
| User VM | 198.18.1.80 | 8222 | cisco | cisco | SSH |
| Restconf | 198.18.1.80 | 8080 and 8181 | admin | admin | |
| XRV Routers | 198.18.1.30-.37 | 23 | cisco | cisco | Telnet |
-
Software prerequisites (above and beyond what is required for dCloud access):
- Chrome Version 45.0.2454.101 (64-bit) or higher
- Python 2.7 or 2.6
- Tornado 4.2.1 or higher
- requests 2.6.0 or higher
-
Schedule and have a dCloud Beryllium ODL demo (per the above).
-
Access your demo and start a UserVM. For details, see dCloud Demo instructions for Pathman_SR:
- http://198.18.133.1:8087/#scenario-7-pathman-segment-routing - If AnyConnect to your demo
- http://{public_ip}:15000/docs/#scenario-7-pathman-segment-routing - If using public ip access
- Download BGP-LS Manager and Pathman apps from github located at CiscoDevnet's Github
mkdir pathman_sr
cd pathman_sr
git init
git pull https://github.com/CiscoDevNet/pathman-sr
- You should the following in your current directory (pathman_sr).
drwxr-xr-x 13 staff 442 Jun 8 11:10 .git
-rw-r--r-- 1 staff 64 Jun 8 11:10 .gitignore
-rw-r--r-- 1 staff 2660 Jun 8 11:10 README.md
drwxr-xr-x 8 staff 272 Jun 8 11:10 client
drwxr-xr-x 4 staff 136 Jun 8 11:53 dCloud
drwxr-xr-x 6 staff 204 Jun 8 11:10 demo
-rwxr-xr-x 1 staff 92 Jun 8 11:10 launch_rest.sh
-rw-r--r-- 1 staff 842 Jun 8 11:17 pathman_ini.py
-rw-r--r-- 1 staff 744 Jun 8 11:10 pathman_logging.conf
-rw-r--r-- 1 staff 56602 Jun 8 11:25 pathman_sr.py
-rwxr-xr-x 1 staff 3069 Jun 8 11:10 rest_server_v6.py
-rwxr-xr-x 1 staff 2951 Jun 8 11:10 server_pathman.py
-rwxr-xr-x 1 staff 3218 Jun 8 11:10 server_sr.py
-rw-r--r-- 1 staff 24140 Jun 8 11:10 topo_data.py
-
Next modify the pathman_ini.py file to point to the remote ODL instance. No change is required if you are using a dcloud ODL session via AnyConnect.
-
As you are installing this on the UserVM inside the demo, we will need to change the clients UI link:
[cisco@user_vm pathman_sr]$ sed -i 's/localhost/198.18.1.80/g' client/pathman_sr/js/app.js
[cisco@user_vm pathman_sr]$
The UI needs to know where to find the backend app - rest_sever_v6.
- Type in the following command to start the rest_server:
python rest_server_v6.py.
This launches the "backend" of the Pathman_sr app.
-
Open your Chrome Browser
-
URL to launch Pathman_SR: http://198.18.1.80:8020/cisco-ctao/apps/pathman_sr/index.html.
NOTE: IF you installed the app on lyour local host, then the IP address above would need to be localhost.
There are two options; either you use an alternate client, or you use dCloud's public ip solution.
-If your client can't run Cisco Anyconnect, you want to try another client like OpenConnect.
For some of our demos, we have enabled public IP access. In the picture below, you see how to find your public_ip address, and your anyconnect credentials.
You can use them directly from your Pathman_SR app, by changing the pathman_ini.py file as described below.
odl_ip = '64.100.10.119' # from Public Address
odl_port = '6644' # must be 6644 to reach dCloud ODL servers restconf
odl_user = 'v196user1' # your sessions anyconnect userid for user1
odl_password = 'c561cc' # your sessions anyconnect password
- Can more than one app run towards the same topology from your machine - Yes
- Can someone else access your topology? - No, unless you share access credentials with them.
- Should you share your access credentials with everyone through my blog/Facebook or other? No, that is probably not a good idea.
- Can I choose to collaborate with few others? Yes, you can either share your demo with them through the Share button on the dCloud UI, or share your sessions access credentials. Just remember that once shared, they have learned your credentials and can access your setup at any time.
- How long can I have my topology running? Your session can be scheduled to run for, from 1h to 5 Days.
- Is there a charge for using dCloud? - No, currently there is no charge for using dcloud for this purpose.
For any issues, first take a look at the /tmp/pathman.log file
##Things to look for in the log
- Did I connect to my odl controller? This should be the first lines in your log.
71679 2016-06-08 21:14:40.033 UTC root:<module> INFO: This is initializing the log
71679 2016-06-08 21:14:40.263 UTC root:get_url INFO: Url get Status: 200
71679 2016-06-08 21:14:40.464 UTC root:get_url INFO: Url get Status: 200
This is what Failure could look like, once the url's timeout.
71987 2016-06-08 21:16:20.277 UTC root:<module> INFO: This is initializing the log
71987 2016-06-08 21:17:35.985 UTC root:get_url ERROR: Connection Error: ('Connection aborted.', error(60, 'Operation timed out'))
71987 2016-06-08 21:18:51.357 UTC root:get_url ERROR: Connection Error: ('Connection aborted.', error(60, 'Operation timed out'))
71987 2016-06-08 21:18:51.357 UTC root:get_pcep_type INFO: We have no nodes in our PCEP Topology
71987 2016-06-08 21:18:51.357 UTC root:node_structure INFO: We have no nodes in our BGP-LS topology
71987 2016-06-08 21:18:51.357 UTC root:pseudo_net_build INFO: []
71987 2016-06-08 21:20:06.631 UTC root:get_url ERROR: Connection Error: ('Connection aborted.', error(60, 'Operation timed out'))
71987 2016-06-08 21:20:06.632 UTC root:netconf_list ERROR: format error in netconf node-list: {}
71987 2016-06-08 21:20:06.632 UTC root:node_links INFO: We have no links in our BGP-LS topology
71987 2016-06-08 21:20:06.632 UTC root:node_links INFO: We have no links in our BGP-LS topology
- Did I learn any nodes from the controller? Early in the log you want to see something like this - one node statement per node:
65632 2016-06-08 20:34:31.496 UTC root:node_structure INFO: New node: Node(name='sjc', id=u'3323134238', loopback=u'198.19.1.30', portlist=[u'57.0.0.30', u'49.0.0.30', u'55.0.0.30', u'46.0.0.30', u'56.0.0.30'], pcc='', pcep_type='', prefix=[u'57.0.0.0/24', u'46.0.0.0/24', u'56.0.0.0/24', u'55.0.0.0/24', u'49.0.0.0/24', u'198.19.1.30/32'], sid='')
65632 2016-06-08 20:34:39.039 UTC root:getTopo INFO: Topo build with 8 nodes
- Did I enable Segment Routing? You should see a line per router saying that the SID has been set.
65632 2016-06-08 20:34:39.035 UTC root:update INFO: SR sid updated for: sjc
- Could I see any LSPs? Below is an example for what you should see in the log as you start your server, after the above output.
65632 2016-06-08 20:34:39.041 UTC root:rest_interface_parser INFO: Commands Recieved: {u'option': u'list_all'}
65632 2016-06-08 20:34:39.238 UTC root:get_url INFO: Url get Status: 200
65632 2016-06-08 20:34:39.238 UTC root:listAllLsp INFO: list: [], formatted: []
- Did my REST server start? If it did startok, you should see this in the log.
65632 2016-06-08 20:24:56.003 UTC root:__init__ INFO: patterned to '/pathman'
65632 2016-06-08 20:24:56.006 UTC root:__init__ INFO: Pathman REST API Launched on port 8020