1 .. _lispflowmapping-user-guide:
3 LISP Flow Mapping User Guide
4 ============================
9 Locator/ID Separation Protocol
10 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 `Locator/ID Separation Protocol
13 (LISP) <http://tools.ietf.org/html/rfc6830>`__ is a technology that
14 provides a flexible map-and-encap framework that can be used for overlay
15 network applications such as data center network virtualization and
16 Network Function Virtualization (NFV).
18 LISP provides the following name spaces:
20 - `Endpoint Identifiers
21 (EIDs) <http://tools.ietf.org/html/rfc6830#page-6>`__
24 (RLOCs) <http://tools.ietf.org/html/rfc6830#section-3>`__
26 In a virtualization environment EIDs can be viewed as virtual address
27 space and RLOCs can be viewed as physical network address space.
29 The LISP framework decouples network control plane from the forwarding
32 - A data plane that specifies how the virtualized network addresses are
33 encapsulated in addresses from the underlying physical network.
35 - A control plane that stores the mapping of the virtual-to-physical
36 address spaces, the associated forwarding policies and serves this
37 information to the data plane on demand.
39 Network programmability is achieved by programming forwarding policies
40 such as transparent mobility, service chaining, and traffic engineering
41 in the mapping system; where the data plane elements can fetch these
42 policies on demand as new flows arrive. This chapter describes the LISP
43 Flow Mapping project in OpenDaylight and how it can be used to enable
44 advanced SDN and NFV use cases.
46 LISP data plane Tunnel Routers are available at
47 `OpenOverlayRouter.org <http://www.openoverlayrouter.org/>`__ in the open source community on
48 the following platforms:
56 For more details and support for LISP data plane software please visit
57 `the OOR web site <http://www.openoverlayrouter.org/>`__.
59 LISP Flow Mapping Service
60 ~~~~~~~~~~~~~~~~~~~~~~~~~
62 The LISP Flow Mapping service provides LISP Mapping System services.
63 This includes LISP Map-Server and LISP Map-Resolver services to store
64 and serve mapping data to data plane nodes as well as to OpenDaylight
65 applications. Mapping data can include mapping of virtual addresses to
66 physical network address where the virtual nodes are reachable or hosted
67 at. Mapping data can also include a variety of routing policies
68 including traffic engineering and load balancing. To leverage this
69 service, OpenDaylight applications and services can use the northbound
70 REST API to define the mappings and policies in the LISP Mapping
71 Service. Data plane devices capable of LISP control protocol can
72 leverage this service through a southbound LISP plugin. LISP-enabled
73 devices must be configured to use this OpenDaylight service as their Map
74 Server and/or Map Resolver.
76 The southbound LISP plugin supports the LISP control protocol
77 (Map-Register, Map-Request, Map-Reply messages), and can also be used to
78 register mappings in the OpenDaylight mapping service.
80 LISP Flow Mapping Architecture
81 ------------------------------
83 The following figure shows the various LISP Flow Mapping modules.
85 .. figure:: ./images/ODL_lfm_Be_component.jpg
86 :alt: LISP Mapping Service Internal Architecture
88 LISP Mapping Service Internal Architecture
90 A brief description of each module is as follows:
92 - **DAO (Data Access Object):** This layer separates the LISP logic
93 from the database, so that we can separate the map server and map
94 resolver from the specific implementation of the mapping database.
95 Currently we have an implementation of this layer with an in-memory
96 HashMap, but it can be switched to any other key/value store and you
97 only need to implement the ILispDAO interface.
99 - **Map Server:** This module processes the adding or registration of
100 authentication tokens (keys) and mappings. For a detailed
101 specification of LISP Map Server, see
102 `LISP <http://tools.ietf.org/search/rfc6830>`__.
104 - **Map Resolver:** This module receives and processes the mapping
105 lookup queries and provides the mappings to requester. For a detailed
106 specification of LISP Map Server, see
107 `LISP <http://tools.ietf.org/search/rfc6830>`__.
109 - **RPC/RESTCONF:** This is the auto-generated RESTCONF-based
110 northbound API. This module enables defining key-EID associations as
111 well as adding mapping information through the Map Server. Key-EID
112 associations and mappings can also be queried via this API.
114 - **GUI:** This module enables adding and querying the mapping service
115 through a GUI based on ODL DLUX.
117 - **Neutron:** This module implements the OpenDaylight Neutron Service
118 APIs. It provides integration between the LISP service and the
119 OpenDaylight Neutron service, and thus OpenStack.
121 - **Java API:** The API module exposes the Map Server and Map Resolver
122 capabilities via a Java API.
124 - **LISP Proto:** This module includes LISP protocol dependent data
125 types and associated processing.
127 - **In Memory DB:** This module includes the in memory database
128 implementation of the mapping service.
130 - **LISP Southbound Plugin:** This plugin enables data plane devices
131 that support LISP control plane protocol (see
132 `LISP <http://tools.ietf.org/search/rfc6830>`__) to register and
133 query mappings to the LISP Flow Mapping via the LISP control plane
138 Configuring LISP Flow Mapping
139 -----------------------------
141 In order to use the LISP mapping service for registering EID to RLOC
142 mappings from northbound or southbound, keys have to be defined for the
143 EID prefixes first. Once a key is defined for an EID prefix, it can be
144 used to add mappings for that EID prefix multiple times. If the service
145 is going to be used to process Map-Register messages from the southbound
146 LISP plugin, the same key must be used by the data plane device to
147 create the authentication data in the Map-Register messages for the
148 associated EID prefix.
150 The ``etc/custom.properties`` file in the Karaf distribution allows
151 configuration of several OpenDaylight parameters. The LISP service has
152 the following properties that can be adjusted:
154 **lisp.smr** (default: *true*)
155 Enables/disables the `Solicit-Map-Request
156 (SMR) <http://tools.ietf.org/html/rfc6830#section-6.6.2>`__
157 functionality. SMR is a method to notify changes in an EID-to-RLOC
158 mapping to "subscribers". The LISP service considers all
159 Map-Request’s source RLOC as a subscriber to the requested EID
160 prefix, and will send an SMR control message to that RLOC if the
163 **lisp.elpPolicy** (default: *default*)
164 Configures how to build a Map-Reply southbound message from a
165 mapping containing an Explicit Locator Path (ELP) RLOC. It is used
166 for compatibility with dataplane devices that don’t understand the
167 ELP LCAF format. The *default* setting doesn’t alter the mapping,
168 returning all RLOCs unmodified. The *both* setting adds a new RLOC
169 to the mapping, with a lower priority than the ELP, that is the next
170 hop in the service chain. To determine the next hop, it searches the
171 source RLOC of the Map-Request in the ELP, and chooses the next hop,
172 if it exists, otherwise it chooses the first hop. The *replace*
173 setting adds a new RLOC using the same algorithm as the *both*
174 setting, but using the origin priority of the ELP RLOC, which is
175 removed from the mapping.
177 **lisp.lookupPolicy** (default: *northboundFirst*)
178 Configures the mapping lookup algorithm. When set to
179 *northboundFirst* mappings programmed through the northbound API
180 will take precedence. If no northbound programmed mappings exist,
181 then the mapping service will return mappings registered through the
182 southbound plugin, if any exists. When set to
183 *northboundAndSouthbound* the mapping programmed by the northbound
184 is returned, updated by the up/down status of these mappings as
185 reported by the southbound (if existing).
187 **lisp.mappingMerge** (default: *false*)
188 Configures the merge policy on the southbound registrations through
189 the LISP SB Plugin. When set to *false*, only the latest mapping
190 registered through the SB plugin is valid in the southbound mapping
191 database, independent of which device it came from. When set to
192 *true*, mappings for the same EID registered by different devices
193 are merged together and a union of the locators is maintained as the
194 valid mapping for that EID.
196 Textual Conventions for LISP Address Formats
197 --------------------------------------------
199 In addition to the more common IPv4, IPv6 and MAC address data types,
200 the LISP control plane supports arbitrary `Address Family
201 Identifiers <http://www.iana.org/assignments/address-family-numbers>`__
202 assigned by IANA, and in addition to those the `LISP Canoncal Address
203 Format (LCAF) <https://tools.ietf.org/html/draft-ietf-lisp-lcaf>`__.
205 The LISP Flow Mapping project in OpenDaylight implements support for
206 many of these different address formats, the full list being summarized
207 in the following table. While some of the address formats have well
208 defined and widely used textual representation, many don’t. It became
209 necessary to define a convention to use for text rendering of all
210 implemented address types in logs, URLs, input fields, etc. The below
211 table lists the supported formats, along with their AFI number and LCAF
212 type, including the prefix used for disambiguation of potential overlap,
215 +------------------+----------+----------+----------+----------------------------------+
216 | Name | AFI | LCAF | Prefix | Text Rendering |
217 +==================+==========+==========+==========+==================================+
218 | **No Address** | 0 | - | no: | No Address Present |
219 +------------------+----------+----------+----------+----------------------------------+
220 | **IPv4 Prefix** | 1 | - | ipv4: | 192.0.2.0/24 |
221 +------------------+----------+----------+----------+----------------------------------+
222 | **IPv6 Prefix** | 2 | - | ipv6: | 2001:db8::/32 |
223 +------------------+----------+----------+----------+----------------------------------+
224 | **MAC Address** | 16389 | - | mac: | 00:00:5E:00:53:00 |
225 +------------------+----------+----------+----------+----------------------------------+
226 | **Distinguished | 17 | - | dn: | stringAsIs |
228 +------------------+----------+----------+----------+----------------------------------+
229 | **AS Number** | 18 | - | as: | AS64500 |
230 +------------------+----------+----------+----------+----------------------------------+
231 | **AFI List** | 16387 | 1 | list: | {192.0.2.1,192.0.2.2,2001:db8::1 |
233 +------------------+----------+----------+----------+----------------------------------+
234 | **Instance ID** | 16387 | 2 | - | [223] 192.0.2.0/24 |
235 +------------------+----------+----------+----------+----------------------------------+
236 | **Application | 16387 | 4 | appdata: | 192.0.2.1!128!17!80-81!6667-7000 |
238 +------------------+----------+----------+----------+----------------------------------+
239 | **Explicit | 16387 | 10 | elp: | {192.0.2.1→192.0.2.2\|lps→192.0. |
240 | Locator Path** | | | | 2.3} |
241 +------------------+----------+----------+----------+----------------------------------+
242 | **Source/Destina | 16387 | 12 | srcdst: | 192.0.2.1/32\|192.0.2.2/32 |
245 +------------------+----------+----------+----------+----------------------------------+
246 | **Key/Value | 16387 | 15 | kv: | 192.0.2.1⇒192.0.2.2 |
247 | Address Pair** | | | | |
248 +------------------+----------+----------+----------+----------------------------------+
249 | **Service Path** | 16387 | N/A | sp: | 42(3) |
250 +------------------+----------+----------+----------+----------------------------------+
252 Table: LISP Address Formats
254 Please note that the forward slash character ``/`` typically separating
255 IPv4 and IPv6 addresses from the mask length is transformed into ``%2f``
261 In this section we will discuss two types of Karaf commands: built-in,
262 and LISP specific. Some built-in commands are quite useful, and are
263 needed for the tutorial, so they will be discussed here. A reference of
264 all LISP specific commands, added by the LISP Flow Mapping project is
265 also included. They are useful mostly for debugging.
267 Useful built-in commands
268 ~~~~~~~~~~~~~~~~~~~~~~~~
271 Lists all available command, with a short description of each.
273 ``help <command_name>``
274 Show detailed help about a specific command.
276 ``feature:list [-i]``
277 Show all locally available features in the Karaf container. The
278 ``-i`` option lists only features that are currently installed. It
279 is possible to use ``| grep`` to filter the output (for all
280 commands, not just this one).
282 ``feature:install <feature_name>``
283 Install feature ``feature_name``.
285 ``log:set <level> <class>``
286 Set the log level for ``class`` to ``level``. The default log level
287 for all classes is INFO. For debugging, or learning about LISP
288 internals it is useful to run
289 ``log:set TRACE org.opendaylight.lispflowmapping`` right after Karaf
293 Outputs the log file to the console, and returns control to the
297 Continuously shows log output, requires ``Ctrl+C`` to return to the
300 LISP specific commands
301 ~~~~~~~~~~~~~~~~~~~~~~
303 The available lisp commands can always be obtained by
304 ``help mappingservice``. Currently they are:
306 ``mappingservice:addkey``
307 Add the default password ``password`` for the IPv4 EID prefix
308 0.0.0.0/0 (all addresses). This is useful when experimenting with
309 southbound devices, and using the REST interface would be combersome
312 ``mappingservice:mappings``
313 Show the list of all mappings stored in the internal non-persistent
314 data store (the DAO), listing the full data structure. The output is
315 not human friendly, but can be used for debugging.
317 LISP Flow Mapping Karaf Features
318 --------------------------------
320 LISP Flow Mapping has the following Karaf features that can be installed
321 from the Karaf console:
323 ``odl-lispflowmapping-msmr``
324 This includes the core features required to use the LISP Flow
325 Mapping Service such as mapping service and the LISP southbound
328 ``odl-lispflowmapping-ui``
329 This includes the GUI module for the LISP Mapping Service.
331 ``odl-lispflowmapping-neutron``
332 This is the experimental Neutron provider module for LISP mapping
338 This section provides a tutorial demonstrating various features in this
339 service. We have included tutorials using two forwarding platforms:
341 1. Using `Open Overlay Router (OOR) <https://github.com/OpenOverlayRouter/oor#overview>`__
343 2. Using `FD.io <https://wiki.fd.io/view/ONE>`__
345 Both have different approaches to create the overlay but ultimately do the
346 same job. Details of both approaches have been explained below.
348 Creating a LISP overlay with OOR
349 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
351 This section provides instructions to set up a LISP network of three
352 nodes (one "client" node and two "server" nodes) using OOR as data
353 plane LISP nodes and the LISP Flow Mapping project from OpenDaylight as
354 the LISP programmable mapping system for the LISP network.
359 The steps shown below will demonstrate setting up a LISP network between
360 a client and two servers, then performing a failover between the two
366 - **The OpenDaylight Karaf Distribution** (`download
367 <https://www.opendaylight.org/downloads>`_)
371 - **The Postman Chrome App**: the most convenient way to follow along
372 this tutorial is to use the `Postman
373 App <https://www.getpostman.com/apps>`__
374 to edit and send the requests. The project git repository hosts a
375 collection of the requests that are used in this tutorial in the
376 ``resources/tutorial/OOR/Beryllium_Tutorial.json.postman_collection``
377 file. You can import this file to Postman by clicking *Import* at the
378 top, choosing *Download from link* and then entering the following
380 `<https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob_plain;f=resources/tutorial/OOR/Beryllium_Tutorial.json.postman_collection;hb=refs/heads/stable/nitrogen>`__.
381 Alternatively, you can save the file on your machine, or if you have
382 the repository checked out, you can import from there. You will need
383 to create a new Postman Environment and define some variables within:
384 ``controllerHost`` set to the hostname or IP address of the machine
385 running the OpenDaylight instance, and ``restconfPort`` to 8181, if you didn’t
386 modify the default controller settings.
388 - **OOR version 1.0 or later** The README.md lists the dependencies needed
389 to build it from source.
391 - **A virtualization platform**
396 The three LISP data plane nodes and the LISP mapping system are assumed
397 to be running in Linux virtual machines, which have the ``eth0``
398 interface in NAT mode to allow outside internet access and ``eth1``
399 connected to a host-only network, with the following IP addresses
400 (please adjust configuration files, JSON examples, etc. accordingly if
401 you’re using another addressing scheme):
403 +--------------------------+--------------------------+--------------------------+
404 | Node | Node Type | IP Address |
405 +==========================+==========================+==========================+
406 | **controller** | OpenDaylight | 192.168.16.11 |
407 +--------------------------+--------------------------+--------------------------+
408 | **client** | OOR | 192.168.16.30 |
409 +--------------------------+--------------------------+--------------------------+
410 | **server1** | OOR | 192.168.16.31 |
411 +--------------------------+--------------------------+--------------------------+
412 | **server2** | OOR | 192.168.16.32 |
413 +--------------------------+--------------------------+--------------------------+
414 | **service-node** | OOR | 192.168.16.33 |
415 +--------------------------+--------------------------+--------------------------+
417 Table: Nodes in the tutorial
419 The figure below gives a sketch of network topology that will be used in the tutorial.
421 .. figure:: ./images/tutorial_architecture_diagram.png
422 :alt: Network architecture of the tutorial
424 In LISP terminology **client**, **server1** and **server2** are mobile nodes (MN in OOR),
425 **controller** is a MS/MR and **service-node** is a RTR.
430 The below steps use the command line tool cURL to talk to the LISP Flow
431 Mapping RPC REST API. This is so that you can see the actual request
432 URLs and body content on the page.
434 1. Install and run the OpenDaylight distribution on the controller VM.
435 Please follow the general OpenDaylight Installation Guide
436 for this step. Once the OpenDaylight controller is running install
437 the *odl-lispflowmapping-msmr* feature from the Karaf CLI:
441 feature:install odl-lispflowmapping-msmr
443 It takes quite a while to load and initialize all features and their
444 dependencies. It’s worth running the command ``log:tail`` in the
445 Karaf console to see when the log output is winding down, and
446 continue with the tutorial after that.
448 2. Install OOR on the **client**, **server1**, **server2**, and
449 **service-node** VMs following the installation instructions `from
451 file <https://github.com/OpenOverlayRouter/oor#software-prerequisites>`__.
453 3. Configure the OOR installations from the previous step. Take a look
454 at the ``oor.conf.example`` to get a general idea of the structure
455 of the conf file. First, check if the file ``/etc/oor.conf`` exists.
456 If the file doesn't exist, create the file ``/etc/oor.conf``. Set the
457 EID in ``/etc/oor.conf`` file from the IP address space selected
458 for your virtual/LISP network. In this tutorial the EID of the
459 **client** is set to 1.1.1.1/32, and that of **server1** and
460 **server2** to 2.2.2.2/32.
462 4. Set the RLOC interface to ``eth1`` in each ``oor.conf`` file. LISP
463 will determine the RLOC (IP address of the corresponding VM) based
466 5. Set the Map-Resolver address to the IP address of the
467 **controller**, and on the **client** the Map-Server too. On
468 **server1** and **server2** remove the Map-Server configuration, so
469 that it doesn’t interfere with the mappings on the controller, since
470 we’re going to program them manually.
472 6. Modify the "key" parameter in each ``oor.conf`` file to a
473 key/password of your choice (*password* in this tutorial).
477 The ``resources/tutorial/OOR`` directory in the project git repository
478 has the files used in the tutorial `checked in
479 <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/OOR;hb=refs/heads/stable/nitrogen>`_,
480 so you can just copy the files to ``/etc/oor.conf`` on the respective
481 VMs. You will also find the JSON files referenced below in the same
484 7. Define a key and EID prefix association in OpenDaylight using the
485 RPC REST API for the **client** EID (1.1.1.1/32) to allow
486 registration from the southbound. Since the mappings for the server
487 EID will be configured from the REST API, no such association is
488 necessary. Run the below command on the **controller** (or any
489 machine that can reach **controller**, by replacing *localhost* with
490 the IP address of **controller**).
494 curl -u "admin":"admin" -H "Content-type: application/json" -X PUT \
495 http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/authentication-key/ipv4:1.1.1.1%2f32/ \
498 where the content of the *add-key.json* file is the following:
503 "authentication-key": {
504 "eid-uri": "ipv4:1.1.1.1/32",
506 "address-type": "ietf-lisp-address-types:ipv4-prefix-afi",
507 "ipv4-prefix": "1.1.1.1/32"
510 "key-string": "password",
516 8. Verify that the key is added properly by requesting the following
521 curl -u "admin":"admin" -H "Content-type: application/json" -X GET \
522 http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/authentication-key/ipv4:1.1.1.1%2f32/
524 The output the above invocation should look like this:
529 "authentication-key":[
531 "eid-uri":"ipv4:1.1.1.1/32",
533 "ipv4-prefix":"1.1.1.1/32",
534 "address-type":"ietf-lisp-address-types:ipv4-prefix-afi"
537 "key-string":"password"
544 9. Run the ``oor`` OOR daemon on all VMs:
550 For more information on accessing OOR logs, take a look at
551 `OOR README <https://github.com/OpenOverlayRouter/oor#readme>`__
552 10. The **client** OOR node should now register its EID-to-RLOC
553 mapping in OpenDaylight. To verify you can lookup the corresponding
554 EIDs via the REST API
558 curl -u "admin":"admin" -H "Content-type: application/json" -X GET \
559 http://localhost:8181/restconf/operational/odl-mappingservice:mapping-database/virtual-network-identifier/0/mapping/ipv4:1.1.1.1%2f32/southbound/
561 An alternative way for retrieving mappings from OpenDaylight using the
562 southbound interface is using the
563 `lig <https://github.com/davidmeyer/lig>`__ open source tool.
565 11. Register the EID-to-RLOC mapping of the server EID 2.2.2.2/32 to the
566 controller, pointing to **server1** and **server2** with a higher
567 priority for **server1**
571 curl -u "admin":"admin" -H "Content-type: application/json" -X PUT \
572 http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/mapping/ipv4:2.2.2.2%2f32/northbound/ \
575 where the *mapping.json* file looks like this:
581 "eid-uri": "ipv4:2.2.2.2/32",
582 "origin": "northbound",
585 "action": "NoAction",
586 "authoritative": true,
588 "address-type": "ietf-lisp-address-types:ipv4-prefix-afi",
589 "ipv4-prefix": "2.2.2.2/32"
593 "locator-id": "server1",
596 "multicastPriority": 255,
597 "multicastWeight": 0,
598 "localLocator": true,
602 "address-type": "ietf-lisp-address-types:ipv4-afi",
603 "ipv4": "192.168.16.31"
607 "locator-id": "server2",
610 "multicastPriority": 255,
611 "multicastWeight": 0,
612 "localLocator": true,
616 "address-type": "ietf-lisp-address-types:ipv4-afi",
617 "ipv4": "192.168.16.32"
625 Here the priority of the second RLOC (192.168.16.32 - **server2**)
626 is 2, a higher numeric value than the priority of 192.168.16.31,
627 which is 1. This policy is saying that **server1** is preferred to
628 **server2** for reaching EID 2.2.2.2/32. Note that lower priority
629 value has higher preference in LISP.
631 12. Verify the correct registration of the 2.2.2.2/32 EID:
635 curl -u "admin":"admin" -H "Content-type: application/json" -X GET \
636 http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/mapping/ipv4:2.2.2.2%2f32/northbound/
638 13. Now the LISP network is up. To verify, log into the **client** VM
639 and ping the server EID:
645 14. Let’s test fail-over now. Suppose you had a service on **server1**
646 which became unavailable, but **server1** itself is still reachable.
647 LISP will not automatically fail over, even if the mapping for
648 2.2.2.2/32 has two locators, since both locators are still reachable
649 and uses the one with the higher priority (lowest priority value).
650 To force a failover, we need to set the priority of **server2** to a
651 lower value. Using the file mapping.json above, swap the priority
652 values between the two locators (lines 14 and 28 in *mapping.json*)
653 and repeat the request from step 11. You can also repeat step 12 to
654 see if the mapping is correctly registered. If you leave the ping
655 on, and monitor the traffic using wireshark, you can see that the
656 ping traffic to 2.2.2.2 will be diverted from the **server1** RLOC
657 to the **server2** RLOC.
659 With the default OpenDaylight configuration the failover should be
660 near instantaneous (we observed 3 lost pings in the worst case),
661 because of the LISP `Solicit-Map-Request (SMR)
662 mechanism <http://tools.ietf.org/html/rfc6830#section-6.6.2>`__ that
663 can ask a LISP data plane element to update its mapping for a
664 certain EID (enabled by default). It is controlled by the
665 ``lisp.smr`` variable in ``etc/custom.porperties``. When enabled,
666 any mapping change from the RPC interface will trigger an SMR packet
667 to all data plane elements that have requested the mapping in the
668 last 24 hours (this value was chosen because it’s the default TTL of
669 Cisco IOS xTR mapping registrations). If disabled, ITRs keep their
670 mappings until the TTL specified in the Map-Reply expires.
672 15. To add a service chain into the path from the client to the server,
673 we can use an Explicit Locator Path, specifying the **service-node**
674 as the first hop and **server1** (or **server2**) as the second hop.
675 The following will achieve that:
679 curl -u "admin":"admin" -H "Content-type: application/json" -X PUT \
680 http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/mapping/ipv4:2.2.2.2%2f32/northbound/ \
683 where the *elp.json* file is as follows:
689 "eid-uri": "ipv4:2.2.2.2/32",
690 "origin": "northbound",
693 "action": "NoAction",
694 "authoritative": true,
696 "address-type": "ietf-lisp-address-types:ipv4-prefix-afi",
697 "ipv4-prefix": "2.2.2.2/32"
704 "multicastPriority": 255,
705 "multicastWeight": 0,
706 "localLocator": true,
710 "address-type": "ietf-lisp-address-types:explicit-locator-path-lcaf",
711 "explicit-locator-path": {
714 "hop-id": "service-node",
715 "address": "192.168.16.33",
720 "address": "192.168.16.31",
732 After the mapping for 2.2.2.2/32 is updated with the above, the ICMP
733 traffic from **client** to **server1** will flow through the
734 **service-node**. You can confirm this in the OOR logs, or by
735 sniffing the traffic on either the **service-node** or **server1**.
736 Note that service chains are unidirectional, so unless another ELP
737 mapping is added for the return traffic, packets will go from
738 **server1** to **client** directly.
740 16. Suppose the **service-node** is actually a firewall, and traffic is
741 diverted there to support access control lists (ACLs). In this
742 tutorial that can be emulated by using ``iptables`` firewall rules
743 in the **service-node** VM. To deny traffic on the service chain
744 defined above, the following rule can be added:
748 iptables -A OUTPUT --dst 192.168.16.31 -j DROP
750 The ping from the **client** should now have stopped.
752 In this case the ACL is done on the destination RLOC. There is an
753 effort underway in the OOR community to allow filtering on EIDs,
754 which is the more logical place to apply ACLs.
756 17. To delete the rule and restore connectivity on the service chain,
757 delete the ACL by issuing the following command:
761 iptables -D OUTPUT --dst 192.168.16.31 -j DROP
763 which should restore connectivity.
766 Creating a simple LISP overlay with FD.io
767 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
769 In this section, we use the Overlay Network Engine (ONE) project in FD.io
770 to facilitate fully scripted setup and testing of a LISP/VXLAN-GPE network.
771 Overlay Network Engine (ONE) is a `FD.io <https://fd.io/>`__ project that enables programmable
772 dynamic software defined overlays. Details about this project can be
773 found in `ONE wiki <https://wiki.fd.io/view/ONE>`__.
775 The steps shown below will demonstrate setting up a LISP network between
776 a client and a server using VPP. We demonstrate how to use VPP lite to
777 build a IP4 LISP overlay on an Ubuntu host using namespaces and af_packet
778 interfaces. All configuration files used in the tutorials can be found
779 `here <https://gerrit.fd.io/r/gitweb?p=one.git;a=tree;f=tutorial>`__.
784 - **The OpenDaylight Karaf Distribution** (`download
785 <https://www.opendaylight.org/downloads>`_)
787 - **The Postman Chrome App**: Please follow the instructions_ and import
788 postman collection from the following URL: `<https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=resources/tutorial/FD_io/lfm_vpp.postman_collection.json;hb=refs/heads/stable/nitrogen>`__.
790 - **Vagrant** (optional): Download it from `Vagrant website <https://www.vagrantup.com/downloads.html>`__
791 and follow the setup instructions.
796 Unlike the case with OOR, we use network namespace functionality of Linux
797 to create the overlay in this case. The following table contains ip addresses
798 of nodes in the overlay topology used in the tutorial. Our objective will be to
799 create this topology and be able to ping from client to server through an
800 intermediary hop, **service node**, which is a ``rtr node`` providing the
801 service of re-encapsulation. So, all the packets from client to server
802 will be through this **service node**.
804 +--------------------------+--------------------------+--------------------------+
805 | Node | Node Type | IP Address |
806 +==========================+==========================+==========================+
807 | **controller** | OpenDaylight | 6.0.3.100 |
808 +--------------------------+--------------------------+--------------------------+
809 | **client** | VPP | 6.0.2.2 |
810 +--------------------------+--------------------------+--------------------------+
811 | **server** | VPP | 6.0.4.4 |
812 +--------------------------+--------------------------+--------------------------+
813 | **service node** | VPP | 6.0.3.3 |
814 +--------------------------+--------------------------+--------------------------+
816 Table: Nodes in the tutorial
818 The figure below gives a sketch of network topology that will be used in the tutorial.
820 .. figure:: ./images/one_ODL_architecture.png
821 :alt: Network architecture of the tutorial for FD.io
826 Follow the instructions below sequentially.
828 1. Pull the VPP code anonymously using:
831 git clone https://gerrit.fd.io/r/vpp
833 2. Then, use the vagrant file from repository to build virtual machine
834 with proper environment.
837 cd vpp/build-root/vagrant/
841 3. In case there is any error from ``vagrant up``, try ``vargant ssh``. if
842 it works, no worries. If it still doesn't work, you can try any Ubuntu virtual
843 machine. Or sometimes there is an issue with the Vagrant properly copying
844 the VPP repo code from the host VM after the first installation. In that
845 case ``/vpp`` doesn't exist. In both cases, follow the instructions
848 1. Clone the code in ``/`` directory. So, the codes will be in ``/vpp``.
850 2. Run the following commands:
856 make V=0 PLATFORM=vpp TAG=vpp install-deb
857 sudo dpkg -i /vpp/build-root/*.deb
859 Alternative and more detailed build instructions can be found in
860 `VPP's wiki <https://wiki.fd.io/view/VPP/Build,_install,_and_test_images>`__
861 4. By now, you should have a Ubuntu VM with VPP repository in ``/vpp``
862 with ``sudo`` access. Now, we need VPP Lite build. The following commands
867 export PLATFORM=vpp_lite
870 Successful build create the binary in ``/vpp/build-root/install-vpp_lite_debug-native/vpp/bin``
872 5. Install bridge-utils and ethtool if needed by using following commands:
875 sudo apt-get install bridge-utils ethtool
877 6. Now, install and run OpenDaylight on the VM. Please follow the general
878 OpenDaylight Installation Guide for this step from :ref:`install_odl`.
879 Before running OpenDaylight, we need to change the configuration for RTR
880 to work. Update ``etc/custom.properties`` with the ``lisp.elpPolicy`` to
884 lisp.elpPolicy = replace
886 Then, run OpenDaylight. For details regarding configuring LISP
887 Flow Mapping, please take a look at :ref:`lfm_config`.
888 Once the OpenDaylight controller is running install the *odl-lispflowmapping-msmr*
889 feature from the Karaf CLI:
893 feature:install odl-lispflowmapping-msmr
895 It may take quite a while to load and initialize all features and their
896 dependencies. It’s worth running the command ``log:tail`` in the
897 Karaf console to see when the log output is winding down, and
898 continue with the tutorial after that.
900 7. For setting up VPP, get the files from ``resources/tutorial/FD_io``
901 folder of the lispflowmapping repo. The files can also be found `here
902 <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/FD_io;hb=refs/heads/stable/nitrogen>`__.
903 Copy the ``vpp1.config``, ``vpp2.config`` and ``rtr.config`` files in
906 8. In this example, VPP doesn't make any southbound map registers to OpenDaylight.
907 So, we add the mappings directly from northbound. For that, we need
908 to add the mappings to OpenDaylight via RESTCONF API.
910 Register EID-to-RLOC mapping of the Client EID 6.0.2.0/24.
913 curl -u "admin":"admin" -H "Content-type: application/json" -X PUT \
914 http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/mapping/ipv4:6.0.2.0%2f24/northbound/ \
917 Content of epl1.json:
923 "eid-uri": "ipv4:6.0.2.0/24",
924 "origin": "northbound",
927 "action": "NoAction",
928 "authoritative": true,
930 "address-type": "ietf-lisp-address-types:ipv4-prefix-afi",
931 "ipv4-prefix": "6.0.2.0/24"
938 "multicastPriority": 255,
939 "multicastWeight": 0,
940 "localLocator": true,
944 "address-type": "ietf-lisp-address-types:explicit-locator-path-lcaf",
945 "explicit-locator-path": {
949 "address": "6.0.3.3",
950 "lrs-bits": "lookup rloc-probe strict"
954 "address": "6.0.3.1",
955 "lrs-bits": "lookup strict"
967 Similarly add EID-to-RLOC mapping of the Server EID 6.0.4.0/24.
970 curl -u "admin":"admin" -H "Content-type: application/json" -X PUT \
971 http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/mapping/ipv4:6.0.4.0%2f24/northbound/ \
974 Content of elp2.json:
980 "eid-uri": "ipv4:6.0.4.0/24",
981 "origin": "northbound",
984 "action": "NoAction",
985 "authoritative": true,
987 "address-type": "ietf-lisp-address-types:ipv4-prefix-afi",
988 "ipv4-prefix": "6.0.4.0/24"
995 "multicastPriority": 255,
996 "multicastWeight": 0,
997 "localLocator": true,
1001 "address-type": "ietf-lisp-address-types:explicit-locator-path-lcaf",
1002 "explicit-locator-path": {
1006 "address": "6.0.3.3",
1007 "lrs-bits": "lookup rloc-probe strict"
1011 "address": "6.0.3.2",
1012 "lrs-bits": "lookup strict"
1023 The JSON files regarding these can be found in `here
1024 <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/FD_io;hb=refs/heads/stable/nitrogen>`__.
1025 Even though there is no southbound registration for mapping to OpenDaylight, using
1026 northbound policy we can specify mappings, when Client requests for
1027 the Server eid, Client gets a reply from OpenDaylight.
1029 9. Assuming all files have been created and OpenDaylight has been configured as
1030 explained above, execute the host script you've created or the ``topology_setup.sh``
1031 script from `here <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/FD_io;hb=refs/heads/stable/nitrogen>`__.
1033 10. If all goes well, you can now test connectivity between the namespaces with:
1036 sudo ip netns exec vpp-ns1 ping 6.0.4.4
1038 11. Traffic and control plane message exchanges can be checked with a wireshark
1039 listening on the odl interface.
1040 12. .. important:: Delete the topology by running the ``topology_setup.sh`` with ``clean`` argument.
1043 sudo ./topology_setup.sh clean
1045 Creating a LISP overlay with Cisco IOS-XE
1046 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1048 This section describes how to create a simple LISP overlay using the Cisco
1049 IOS-XE network operating system as the data plane software running on the
1050 `Cisco CSR 1000v Series Cloud Services Router
1051 <http://www.cisco.com/c/en/us/support/routers/cloud-services-router-1000v/model.html>`_.
1056 - **The OpenDaylight Karaf Distribution** (`download
1057 <https://www.opendaylight.org/downloads>`_)
1059 - **CSR1Kv image with Cisco IOS-XE version 03.13.00.S or later** (`download
1060 <http://www.cisco.com/c/en/us/support/routers/cloud-services-router-1000v/model.html#~tab-downloads>`_;
1061 the instructions have been tested on version 03.15.00.S).
1063 - **A virtualization platform** supported by CSR1Kv images (VMware ESXi,
1064 Citrix XenServer, KVM, and Microsoft Hyper-V).
1069 The CSR1Kv images are configured with one management interface
1070 (``GigabitEthernet1``), and another interface (``GigabitEthernet2``) connected
1071 to a host-only network on the virtualization platform, while the LISP mapping
1072 system is assumed to be running in a Linux virtual machine, which has the
1073 ``eth0`` interface in NAT mode to allow outside internet access and ``eth1``
1074 connected to the host-only network, with the following IP addresses (please
1075 adjust configuration files, JSON examples, etc. accordingly if you’re using
1076 another addressing scheme):
1078 +--------------------------+--------------------------+--------------------------+
1079 | Node | Node Type | IP Address |
1080 +==========================+==========================+==========================+
1081 | **controller** | OpenDaylight | 192.168.16.11 |
1082 +--------------------------+--------------------------+--------------------------+
1083 | **client** | CSR1Kv | 192.168.16.30 |
1084 +--------------------------+--------------------------+--------------------------+
1085 | **server** | CSR1Kv | 192.168.16.31 |
1086 +--------------------------+--------------------------+--------------------------+
1088 Table: Nodes in the tutorial
1090 The scenario and EID allocation is the same as the OOR scenario, except that
1091 there is no **server2** and **service-node** (for now).
1093 Before this tutorial can be followed, basic connectivity between the Linux VM
1094 and the CSRs should work on the host-only network.
1099 The below steps use the command line tool cURL to talk to the LISP Flow
1100 Mapping RPC REST API. This is so that you can see the actual request
1101 URLs and body content on the page. The easy way is to just use Postman.
1103 1. Install and run the OpenDaylight distribution on the controller VM.
1104 Please follow the general OpenDaylight Installation Guide from
1105 :ref:`install_odl` for this step. Once the OpenDaylight controller is
1106 running install the *odl-lispflowmapping-msmr* feature from the Karaf CLI:
1110 feature:install odl-lispflowmapping-msmr
1112 It takes quite a while to load and initialize all features and their
1113 dependencies. It’s worth running the command ``log:tail`` in the
1114 Karaf console to see when the log output is winding down, and
1115 continue with the tutorial after that.
1117 2. Create the **client** and **server** VMs following the installation
1118 instructions from the `CSR1Kv Configuration Guide
1119 <http://www.cisco.com/c/en/us/td/docs/routers/csr1000/software/configuration/b_CSR1000v_Configuration_Guide.html>`_.
1121 3. Define a key and EID prefix association in OpenDaylight using the RPC REST
1122 API for the **client** and **server** EIDs (1.1.1.1/32 and 2.2.2.2/32
1123 respectively) to allow registration from the southbound. Run the below
1124 command on the **controller** (or any machine that can reach
1125 **controller**, by replacing *localhost* with the IP address of
1130 curl -u "admin":"admin" -H "Content-type: application/json" -X PUT \
1131 http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/authentication-key/ipv4:1.1.1.1%2f32/ \
1132 --data @add-key.json
1134 where the content of the *add-key.json* file is the following:
1139 "authentication-key": {
1140 "eid-uri": "ipv4:1.1.1.1/32",
1142 "address-type": "ietf-lisp-address-types:ipv4-prefix-afi",
1143 "ipv4-prefix": "1.1.1.1/32"
1145 "mapping-authkey": {
1146 "key-string": "password",
1152 The same should be done for 2.2.2.2/32 too.
1154 4. Verify that the key is added properly by requesting the following
1159 curl -u "admin":"admin" -H "Content-type: application/json" -X GET \
1160 http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/authentication-key/ipv4:1.1.1.1%2f32/
1162 The output the above invocation should look like this:
1167 "authentication-key":[
1169 "eid-uri":"ipv4:1.1.1.1/32",
1171 "ipv4-prefix":"1.1.1.1/32",
1172 "address-type":"ietf-lisp-address-types:ipv4-prefix-afi"
1175 "key-string":"password"
1182 5. Configure the CSR installations from the previous step. The EID needs to
1183 be configured on a loopback interface (except when the CSR is used as a
1184 router not a simple client like in this tutorial and the EID is assigned
1185 to a real interface).
1190 ip address 1.1.1.1 255.255.255.255
1192 6. The LISP specific configuration goes to a ``router lisp`` section in the
1193 configuration. A ``locator-set`` defines the list of locators with their
1194 priorities and weights, either statically, or better yet, as an interface
1199 locator-set rloc-network
1200 IPv4-interface GigabitEthernet2 priority 1 weight 1
1203 7. To make sure a Map-Request is using the above defined ``rloc-network``
1204 locator set, the following configuration is used:
1208 map-request itr-rlocs rloc-network
1210 8. Each Instance ID needs its own configuration. For the default Instance ID
1211 of 0, the following configuration is needed for a besic setup:
1215 eid-table default instance-id 0
1216 database-mapping 1.1.1.1/32 locator-set rloc-network
1217 map-cache 0.0.0.0/0 map-request
1218 no ipv4 map-cache-persistent
1219 ipv4 itr map-resolver 192.168.16.11
1221 ipv4 etr map-server 192.168.16.11 key password
1225 ``database-mapping`` defines the EID prefix the router will register in
1226 the mapping system and which locator set it will use (``rloc-network`` in
1227 this case, which was defined in step 6).
1229 The next line creates a static map-cache entry for the whole IPv4 EID
1230 space, causing a Map-Request to be triggered for every destination (that
1231 is not directly connected on some interface).
1233 LISP routers save their map cache to a fie which is used to restore
1234 previous state on reboot. To avoid confusion due to state restored from a
1235 previous run, ``no ipv4 map-cache-persistent`` can be used to disable this
1236 behavior for non-production testing environments.
1238 A ``map-resolver`` is then defined, where Map-Requests will be directed to
1239 for mapping lookups, and then a ``map-server`` association with a shared
1242 9. Here's the full configuration that needs to be pasted into the
1243 configuration of the **client** to follow this tutorial:
1248 ip address 1.1.1.1 255.255.255.255
1251 locator-set rloc-network
1252 IPv4-interface GigabitEthernet2 priority 1 weight 1
1255 map-request itr-rlocs rloc-network
1256 eid-table default instance-id 0
1257 database-mapping 1.1.1.1/32 locator-set rloc-network
1258 map-cache 0.0.0.0/0 map-request
1259 no ipv4 map-cache-persistent
1260 ipv4 itr map-resolver 192.168.16.11
1262 ipv4 etr map-server 192.168.16.11 key password
1268 Configuring the **server** is done by replacing ``1.1.1.1`` with
1269 ``2.2.2.2`` in the above configuration snippet.
1271 10. The CSR nodes should now register their EID-to-RLOC mappings to
1272 OpenDaylight. To verify, the corresponding EIDs can be looked up via the
1277 curl -u "admin":"admin" -H "Content-type: application/json" -X GET \
1278 http://localhost:8181/restconf/operational/odl-mappingservice:mapping-database/virtual-network-identifier/0/mapping/ipv4:1.1.1.1%2f32/southbound/
1280 An alternative way for retrieving mappings from OpenDaylight using the
1281 southbound interface is using the
1282 `lig <https://github.com/davidmeyer/lig>`_ open source tool.
1284 Yet another different way is to use the OpenDaylight mappingservice CLI,
1285 and type the following at the Karaf prompt:
1289 mappingservice:mappings
1291 This needs the *odl-lispflowmapping-mappingservice-shell* feature to be
1292 loaded. The output is intended for debugging purposes and shows the full
1293 Java objects stored in the map-cache.
1296 11. Now the LISP network is up. It can be verified by pinging the **server**
1297 EID from the **client** CSR EID:
1301 ping 2.2.2.2 source 1.1.1.1
1303 LISP Flow Mapping Support
1304 -------------------------
1306 For support the lispflowmapping project can be reached by emailing the
1307 developer mailing list: lispflowmapping-dev@lists.opendaylight.org or on
1308 the #opendaylight-lispflowmapping IRC channel on irc.freenode.net.
1310 Additional information is also available on the `Lisp Flow Mapping
1311 wiki <https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Main>`__
1313 Clustering in LISP Flow Mapping
1314 -------------------------------
1316 Documentation regarding setting up a 3-node OpenDaylight cluster is
1317 described at following `odl wiki
1318 page <https://wiki.opendaylight.org/view/Running_and_testing_an_OpenDaylight_Cluster#Three-node_cluster>`__.
1320 To turn on clustering in LISP Flow Mapping it is necessary:
1322 - run script **deploy.py** script. This script is in
1323 `integration-test <https://git.opendaylight.org/gerrit/integration/test>`__
1324 project placed at *tools/clustering/cluster-deployer/deploy.py*. A
1325 whole deploy.py command can looks like:
1329 <div class="informalexample">
1331 | {path\_to\_integration\_test\_project}/tools/clustering/cluster-deployer/**deploy.py**
1332 | --**distribution** {path\_to\_distribution\_in\_zip\_format}
1333 | --**rootdir** {dir\_at\_remote\_host\_where\_copy\_odl\_distribution}
1334 | --**hosts** {ip1},{ip2},{ip3}
1336 | --**template** lispflowmapping
1338 | --**user** {user\_name\_of\_remote\_hosts}
1339 | --**password** {password\_to\_remote\_hosts}
1345 | Running this script will cause that specified **distribution** to be
1346 deployed to remote **hosts** specified through their IP adresses with
1347 using credentials (**user** and **password**). The distribution will
1348 be copied to specified **rootdir**. As part of the deployment, a
1349 **template** which contains a set of controller files which are
1350 different from standard ones. In this case it is specified in
1351 | *{path\_to\_integration\_test\_project}/tools/clustering/cluster-deployer/lispflowmapping*
1353 | Lispflowmapping templates are part of integration-test project. There
1354 are 5 template files:
1356 - akka.conf.template
1358 - jolokia.xml.template
1360 - module-shards.conf.template
1362 - modules.conf.template
1364 - org.apache.karaf.features.cfg.template
1366 After copying the distribution, it is unzipped and started on all of
1367 specified **hosts** in cluster aware manner.
1372 It is necessary to have:
1374 - **unzip** program installed on all of the host
1376 - set all remote hosts /etc/sudoers files to not **requiretty** (should
1377 only matter on debian hosts)