README.md revision 51e00de1
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
20You can run the demo either through the GUI (recommended) or through the CLI
21
22# REQUIREMENTS
23- vagrant (1.8)
24- virtualbox / vmware fusion
25
26# GETTING STARTED
27- clone the repo
28- modify env.sh if needed and ```source ./env.sh```
29- by default the VM uses 2 x CPUs and 4G RAM
30- ```vagrant up```
31- ... run the demo
32
33# RUNNING DEMOS VIA THE GUI
34
35- simply open up your favorite browser and point it at ` http://localhost:5000 `
36- click on a tutorial from the list appearing on the side navigation bar. 
37- Once the selected tutorial is loaded, click the "Next" button, or hit the SPACE bar to go through the steps.
38- Each step is executing the shown command against the VM, showing the response on the console that appears at the bottom of the GUI.
39
40# RUNNING DEMOs VIA THE CLI
41- From the Host, where you ran ```vagrant up``` run ```./run tutorials/<demoname>```
42
43# DEMOs
44
45## Routing - directly connected routing
46- Creates two network namespaces c1, c2
47- A gateway interface for each on VPP
48- Routes due to directly connected routes inserted into default FIB
49
50## Bridging - directly connected interfaces into a bridge-domain
51- Creates two network namespaces c1, c2
52- Adds interfaces to VPP and add them to bridge-domain 1
53- MAC addresses are automatically learned
54
55## Tracing - how to show a "day in the life of a packet" in VPP
56- Same environment as "routing" demo
57- How to add a trace
58- View a trace
59- Interpret a trace
60
61