Revision c3137a54 README.txt

b/README.txt
1
[![Documentation Status](https://readthedocs.org/projects/flowspy/badge/?version=latest)](https://readthedocs.org/projects/flowspy/?badge=latest)
1 2

  
2
Firewall on Demand
3
******************
3
#Firewall on Demand#
4 4

  
5
##Description##
5 6

  
6
Description
7
===========
8

  
9
Firewall on Demand applies, via Netconf, flow rules to a network
7
Firewall on Demand applies via NETCONF, flow rules to a network
10 8
device. These rules are then propagated via e-bgp to peering routers.
11 9
Each user is authenticated against shibboleth. Authorization is
12 10
performed via a combination of a Shibboleth attribute and the peer
13 11
network address range that the user originates from. FoD is meant to
14 12
operate over this architecture:
15 13

  
16
   +-----------+          +------------+        +------------+
17
   |   FoD     | NETCONF  | flowspec   | ebgp   |   router   |
18
   | web app   +----------> device     +-------->            |
19
   +-----------+          +------+-----+        +------------+
20
                                 | ebgp
21
                                 |
22
                          +------v-----+
23
                          |   router   |
24
                          |            |
25
                          +------------+
14
       +-----------+          +------------+        +------------+
15
       |   FoD     | NETCONF  | flowspec   | ebgp   |   router   |
16
       | web app   +----------> device     +-------->            |
17
       +-----------+          +------+-----+        +------------+
18
                                     | ebgp
19
                                     |
20
                              +------v-----+
21
                              |   router   |
22
                              |            |
23
                              +------------+
24

  
26 25

  
27 26
NETCONF is chosen as the mgmt protocol to apply rules to a single
28 27
flowspec capable device. Rules are then propagated via igbp to all
......
30 29
(via NETCONF always) to a router and then ibgp would do the rest. In
31 30
GRNET's case the flowspec capable device is an EX4200.
32 31

  
33
Attention: Make sure your FoD server has ssh access to your flowspec device.
32
**Attention**: Make sure your FoD server has ssh access to your flowspec device.
34 33

  
34
##Installation Considerations##
35 35

  
36
Installation Considerations
37
===========================
38 36

  
39 37
You can find the installation instructions for Debian Wheezy (64)
40
with Django 1.4.x at http://flowspy.readthedocs.org. 
41
If upgrading from a previous version bear in mind 
42
the changes introduced in Django 1.4. 
38
with Django 1.4.x at [Flowspy documentation](http://flowspy.readthedocs.org). 
39
If upgrading from a previous version bear in mind the changes introduced in Django 1.4. 
43 40

  
44
Contact
45
=======
41
##Contact##
46 42

  
47 43
You can find more about FoD or raise your issues at GRNET FoD
48
repository: https://code.grnet.gr/fod.
44
repository: [GRNET repo](https://code.grnet.gr/fod) or [Github repo](https://github.com/leopoul/flowspy).
49 45

  
50 46
You can contact us directly at leopoul{at}noc[dot]grnet(.)gr

Also available in: Unified diff