README.md revision 417c664e
1/*
2 *
3 * Copyright (c) 2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16# INTRO
17
18This is a Vagrant based user demo environment for beginners with VPP
19
20to access the GUI for the demo, simply open up your favorite browser and point it at 
21` http://localhost:5000 `
22
23# RUNNING DEMOS VIA GUI
24
25- click on a tutorial from the list appearing on the side navigation bar. 
26- Once the selected tutorial is loaded, click the "NEXT" button, or hit the SPACE bar to go through the steps.
27- Each step is executing the shown command against the VM, showing the response on the console that appears at the bottom of the GUI.
28
29
30# REQUIREMENTS
31- vagrant (1.8)
32- virtualbox / vmware fusion
33
34# GETTING STARTED
35- clone the repo
36- modify env.sh if needed and ```source ./env.sh```
37- by default the VM uses 2 x CPUs and 4G RAM
38- ```vagrant up```
39- ... run the demo
40
41# RUNNING DEMOs
42- From the Host, where you ran ```vagrant up``` run ```./run <demoname>```
43
44```./run <demoname>```
45
46# DEMOs
47
48## routing - directly connected routing
49- Creates two network namespaces c1, c2
50- A gateway interface for each on VPP
51- Routes due to directly connected routes inserted into default FIB
52
53## bridging - directly connected interfaces into a bridge-domain
54- Creates two network namespaces c1, c2
55- Adds interfaces to VPP and add them to bridge-domain 1
56- MAC addresses are automatically learned
57
58## tracing - how to show a "day in the life of a packet" in VPP
59- Same environment as "routing" demo
60- How to add a trace
61- View a trace
62- Interpret a trace
63
64