Revision efe5365f README.txt

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

  
3
#Firewall on Demand#
4 4

  
5
##Description##
5
Description
6
===========
6 7

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

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

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

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

  
32
**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.
33 33

  
34
##Installation Considerations##
35 34

  
35
Installation Considerations
36
===========================
36 37

  
37 38
You can find the installation instructions for Debian Wheezy (64)
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. 
39
with Django 1.4.x at http://flowspy.readthedocs.org. 
40
If upgrading from a previous version bear in mind 
41
the changes introduced in Django 1.4. 
40 42

  
41
##Contact##
43
Contact
44
=======
42 45

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

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

  

Also available in: Unified diff