docs: better docs, mv doxygen to sphinx

[vpp.git] / docs / usecases / containers / Routing.rst

diff --git a/docs/usecases/Routing.rst b/docs/usecases/containers/Routing.rst
similarity index 94%
rename from docs/usecases/Routing.rst
rename to docs/usecases/containers/Routing.rst
index 31929d3..b9d3bc9 100644 (file)
--- a/docs/usecases/Routing.rst
+++ b/docs/usecases/containers/Routing.rst
@@ -10,7 +10,7 @@ Now for connecting these two linux containers to VPP and pinging between them.
 Enter container *cone*, and check the current network configuration:
 
 .. code-block:: console
-    
+
     root@cone:/# ip -o a
     1: lo    inet 127.0.0.1/8 scope host lo\       valid_lft forever preferred_lft forever
     1: lo    inet6 ::1/128 scope host \       valid_lft forever preferred_lft forever
@@ -43,7 +43,7 @@ Check if the interfaces are down or up:
 Make sure your loopback interface is up, and assign an IP and gateway to veth_link1.
 
 .. code-block:: console
-    
+
     root@cone:/# ip link set dev lo up
     root@cone:/# ip addr add 172.16.1.2/24 dev veth_link1
     root@cone:/# ip link set dev veth_link1 up
@@ -55,7 +55,7 @@ Here, the IP is 172.16.1.2/24 and the gateway is 172.16.1.1.
 Run some commands to verify the changes:
 
 .. code-block:: console
-    
+
     root@cone:/# ip -o a
     1: lo    inet 127.0.0.1/8 scope host lo\       valid_lft forever preferred_lft forever
     1: lo    inet6 ::1/128 scope host \       valid_lft forever preferred_lft forever
@@ -78,7 +78,7 @@ Now exit this container and repeat this process with container *ctwo*, except wi
 After that's done for *both* containers, exit from the container if you're in one:
 
 .. code-block:: console
-    
+
     root@ctwo:/# exit
     exit
     root@localhost:~#
@@ -86,7 +86,7 @@ After that's done for *both* containers, exit from the container if you're in on
 In the machine running the containers, run **ip link** to see the host *veth* network interfaces, and their link with their respective *container veth's*.
 
 .. code-block:: console
-    
+
     root@localhost:~# ip link
     1: lo: <LOOPBACK> mtu 65536 qdisc noqueue state DOWN mode DEFAULT group default qlen 1
         link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
@@ -113,29 +113,29 @@ Remember our network interface index 32 in *cone* from this :ref:`note <networkN
 With VPP in the host machine, show current VPP interfaces:
 
 .. code-block:: console
-    
+
     root@localhost:~# vppctl show inter
-              Name               Idx    State  MTU (L3/IP4/IP6/MPLS)     Counter          Count     
-    local0                        0     down          0/0/0/0  
+              Name               Idx    State  MTU (L3/IP4/IP6/MPLS)     Counter          Count
+    local0                        0     down          0/0/0/0
 
 Which should only output local0.
 
 Based on the names of the network interfaces discussed previously, which are specific to my systems, we can create VPP host-interfaces:
 
 .. code-block:: console
-    
+
     root@localhost:~# vppctl create host-interface name vethQL7K0C
     root@localhost:~# vppctl create host-interface name veth8NA72P
 
 Verify they have been set up properly:
 
 .. code-block:: console
-    
+
     root@localhost:~# vppctl show inter
-              Name               Idx    State  MTU (L3/IP4/IP6/MPLS)     Counter          Count     
-    host-vethQL7K0C               1     down         9000/0/0/0     
-    host-veth8NA72P               2     down         9000/0/0/0     
-    local0                        0     down          0/0/0/0   
+              Name               Idx    State  MTU (L3/IP4/IP6/MPLS)     Counter          Count
+    host-vethQL7K0C               1     down         9000/0/0/0
+    host-veth8NA72P               2     down         9000/0/0/0
+    local0                        0     down          0/0/0/0
 
 Which should output *three network interfaces*, local0, and the other two host network interfaces linked to the container veth's.
 
@@ -143,7 +143,7 @@ Which should output *three network interfaces*, local0, and the other two host n
 Set their state to up:
 
 .. code-block:: console
-    
+
     root@localhost:~# vppctl set interface state host-vethQL7K0C up
     root@localhost:~# vppctl set interface state host-veth8NA72P up
 
@@ -152,16 +152,16 @@ Verify they are now up:
 .. code-block:: console
 
     root@localhost:~# vppctl show inter
-              Name               Idx    State  MTU (L3/IP4/IP6/MPLS)     Counter          Count     
-    host-vethQL7K0C               1      up          9000/0/0/0     
-    host-veth8NA72P               2      up          9000/0/0/0     
-    local0                        0     down          0/0/0/0   
+              Name               Idx    State  MTU (L3/IP4/IP6/MPLS)     Counter          Count
+    host-vethQL7K0C               1      up          9000/0/0/0
+    host-veth8NA72P               2      up          9000/0/0/0
+    local0                        0     down          0/0/0/0
 
 
 Add IP addresses for the other end of each veth link:
 
 .. code-block:: console
-    
+
     root@localhost:~# vppctl set interface ip address host-vethQL7K0C 172.16.1.1/24
     root@localhost:~# vppctl set interface ip address host-veth8NA72P 172.16.2.1/24
 
@@ -180,7 +180,7 @@ Verify the addresses are set properly by looking at the L3 table:
 Or looking at the FIB by doing:
 
 .. code-block:: console
-    
+
     root@localhost:~# vppctl show ip fib
     ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] locks:[src:plugin-hi:2, src:default-route:1, ]
     0.0.0.0/0
@@ -239,7 +239,7 @@ Or looking at the FIB by doing:
 At long last you probably want to see some pings:
 
 .. code-block:: console
-    
+
     root@localhost:~# lxc-attach -n cone -- ping -c3 172.16.2.2
     PING 172.16.2.2 (172.16.2.2) 56(84) bytes of data.
     64 bytes from 172.16.2.2: icmp_seq=1 ttl=63 time=0.102 ms
@@ -263,4 +263,4 @@ At long last you probably want to see some pings:
 
 Which should send/receive three packets for each command.
 
-This is the end of this guide. Great work! 
+This is the end of this guide. Great work!