apply checkstyle check during build for neutron-mapper
[groupbasedpolicy.git] / demos / gbp-devstack / README.rst
1 devstack-nodes
2 ==============
3
4 This repo provides a Vagrantfile with provisioning that one can use to easily
5 get a cluster of nodes configured with DevStack.
6
7 It is a fork of the wonderful work of Mr Flavio Fernandes
8
9 Usage
10 -----
11
12 1) Run VMs::
13     
14 A Vagrantfile is provided to easily create a DevStack environment to test with. To save
15 performance, it is sufficient to run all the required services just on one VM. This VM
16 is identified as control node. Other VMs are compute nodes. First, set number of compute
17 nodes desired by setting::
18    'DEVSTACK_NUM_COMPUTE_NODES=1'
19     
20 Note: Only 3 or less nodes are supported today.
21
22
23 Next, execute::
24
25     vagrant up
26     
27 If no VMs have been generated yet, they will be now.
28
29
30     
31 2) Start devstack::
32
33     vagrant ssh [devstack-control|devstack-compute-1]
34
35     cd devstack
36     
37 To make devstack-scripts visible::
38
39     sudo cp /vagrant/devstack-scripts/environment /etc/environment
40
41     source /etc/environment
42
43     sudo ovs-vsctl add-br br-int
44
45     ^ one time only.
46
47    
48 This assumes that ODL is 192.168.50.1. If you need to change this, edit /etc/environment,
49 change the 'export ODL=' to the right IP address, save, exit, and repeat source command above.
50  
51 After stacking for the first time, edit local.conf and:
52         
53 uncomment: 'OFFLINE=True'
54
55 comment out: 'RECLONE=yes'
56
57 To stack safely, from $HOME/devstack directory on all the nodes execute::
58
59     restack.sh
60
61    
62 Note: NOT ./restack.sh ... just restack.sh ... its in the PATH.
63  
64 To verify from control node if all the nodes are stacked successfully::
65
66     source openrc admin admin
67
68     nova hypervisor-list
69
70
71 Testing
72 -----
73
74 1) Check the ovs bridges first::
75
76     sudo ovs-vsctl show
77
78
79 2) Run scripts from ~/devstack/ directory. These scripts are in the path. If you need to modify them,
80    they are in /vagrant/devstack-scripts/tutorial::
81
82     step01.sh: client node on devstack-control, web node on devstack-compute-1
83
84     step02.sh
85
86     step03.sh
87
88
89 (videos and documentation coming soon).
90
91
92 3. Useful commands to verify::
93
94     flowcount.sh br-int : gives per table flow counts
95
96     flowcount.sh br-int <table#> : dumps flows from <table> in priority order
97
98
99 4. You can point your browser at::
100   
101     Horizon: 192.168.50.20 (u: admin, p:admin).
102
103     This assumes you are familiar with Horizon. Ensure you look at the admin project.
104
105     ODL GBP GUI: 192.168.50.1:8181/index.html (u: admin, p: admin).
106
107     See GBP UserGuide for more information on using the GUI in Stable/Lithium.
108
109