Fix os-odl-bgpvpn-[no]ha scenario reference
[sdnvpn.git] / docs / release / userguide / feature.userguide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Tim Irnich, Nikolas Hermanns, Christopher Price and others
4
5 Introduction
6 ============
7 .. Describe the specific features and how it is realised in the scenario in a brief manner
8 .. to ensure the user understand the context for the user guide instructions to follow.
9
10 This document provides an overview of how to work with the SDN VPN features in
11 OPNFV.
12
13 Feature and API usage guidelines and example
14 ============================================
15 .. Describe with examples how to use specific features, provide API examples and details required to
16 .. operate the feature on the platform.
17
18 For the details of using OpenStack BGPVPN API, please refer to the documentation
19 at http://docs.openstack.org/developer/networking-bgpvpn/.
20
21 Example
22 -------
23 In the example we will show a BGPVPN associated to 2 neutron networks.
24 The BGPVPN will have the import and export routes in the way that it
25 imports its own Route. The outcome will be that vms sitting on these two
26 networks will be able to have a full L3 connectivity.
27
28
29 Some defines:
30 ::
31
32  net_1="Network1"
33  net_2="Network2"
34  subnet_net1="10.10.10.0/24"
35  subnet_net2="10.10.11.0/24"
36
37 Create neutron networks and save network IDs:
38 ::
39
40  neutron net-create --provider:network_type=local $net_1
41  export net_1_id=`echo "$rv" | grep " id " |awk '{print $4}'`
42  neutron net-create --provider:network_type=local $net_2
43  export net_2_id=`echo "$rv" | grep " id " |awk '{print $4}'`
44
45 Create neutron subnets:
46 ::
47
48  neutron subnet-create $net_1 --disable-dhcp $subnet_net1
49  neutron subnet-create $net_2 --disable-dhcp $subnet_net2
50
51 Create BGPVPN:
52 ::
53
54  neutron bgpvpn-create --route-distinguishers 100:100 --route-targets 100:2530 --name L3_VPN
55
56 Start VMs on both networks:
57 ::
58
59  nova boot --flavor 1 --image <some-image> --nic net-id=$net_1_id vm1
60  nova boot --flavor 1 --image <some-image> --nic net-id=$net_2_id vm2
61
62 The VMs should not be able to see each other.
63
64 Associate to Neutron networks:
65 ::
66
67  neutron bgpvpn-net-assoc-create L3_VPN --network $net_1_id
68  neutron bgpvpn-net-assoc-create L3_VPN --network $net_2_id
69
70 Now the VMs should be able to ping each other
71
72 Troubleshooting
73 ===============
74 Check neutron logs on the controller:
75 ::
76
77  tail -f /var/log/neutron/server.log |grep -E "ERROR|TRACE"
78
79 Check Opendaylight logs:
80 ::
81
82  tail -f /opt/opendaylight/data/logs/karaf.log
83
84 Restart Opendaylight:
85 ::
86
87  service opendaylight restart