Re-wrote installation documentation for Ubuntu 12.04.3
[flowspy] / README.txt
1
2 Firewall on Demand
3 ******************
4
5
6 Description
7 ===========
8
9 Firewall on Demand applies, via Netconf, flow rules to a network
10 device. These rules are then propagated via e-bgp to peering routers.
11 Each user is authenticated against shibboleth. Authorization is
12 performed via a combination of a Shibboleth attribute and the peer
13 network address range that the user originates from. FoD is meant to
14 operate over this architecture:
15
16    +-----------+          +------------+        +------------+
17    |   FoD     | NETCONF  | flowspec   | ebgp   |   router   |
18    | web app   +----------> device     +-------->            |
19    +-----------+          +------+-----+        +------------+
20                                  | ebgp
21                                  |
22                           +------v-----+
23                           |   router   |
24                           |            |
25                           +------------+
26
27 NETCONF is chosen as the mgmt protocol to apply rules to a single
28 flowspec capable device. Rules are then propagated via igbp to all
29 flowspec capable routers. Of course FoD could apply rules directly
30 (via NETCONF always) to a router and then ibgp would do the rest. In
31 GRNET's case the flowspec capable device is an EX4200.
32
33 Attention: Make sure your FoD server has ssh access to your flowspec device.
34
35
36 Installation Considerations
37 ===========================
38
39 You can find the installation instructions for Ubuntu 12.04.3 (64)
40 with Django 1.3.x in install.txt file. FoD depends on a bunch of
41 packages. Installing in Debian Squeeze proved to be really tough as
42 the majority of the required packages are not provided by any repos
43 and need to be installed manually. This guide presents the
44 installation procedures for Ubuntu 12.04.3 (64) with Django 1.3.x.
45 Really soon, we will provide a guide for Debian Wheezy. However, users
46 who wish to go for Wheezy, need to read the Django 1.4 changelist. One
47 of the most significant changes in Django 1.4 is that the application
48 dir layout has to be restructured. Also bear in mind that Django 1.4
49 introduces new aspects when it comes to application library
50 inclussions.
51
52 Soon we will post a branch of FoD tailored for Django 1.4.
53
54
55 Contact
56 =======
57
58 You can find more about FoD or raise your issues at GRNET FoD
59 repository: https://code.grnet.gr/fod.
60
61 You can contactus directly at leopoul{at}noc[dot]grnet(.)gr