summaryrefslogtreecommitdiffhomepage
path: root/tools/route-server/README.md
diff options
context:
space:
mode:
authorIWASE Yusuke <iwase.yusuke0@gmail.com>2018-03-30 13:51:51 +0900
committerIWASE Yusuke <iwase.yusuke0@gmail.com>2018-04-02 16:16:01 +0900
commit008f34053c87650c83946874980fa97179267149 (patch)
tree436e7a1a0eb4208a845b9bc710253af16e344f15 /tools/route-server/README.md
parent79d264bfb008370a6af7ff42dc3962d0bf1ddf63 (diff)
*.md: Improvements for markdownlint
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Diffstat (limited to 'tools/route-server/README.md')
-rw-r--r--tools/route-server/README.md49
1 files changed, 26 insertions, 23 deletions
diff --git a/tools/route-server/README.md b/tools/route-server/README.md
index 6f58b776..1940551e 100644
--- a/tools/route-server/README.md
+++ b/tools/route-server/README.md
@@ -1,25 +1,25 @@
-Route Server testing env
-========================
+# Route Server testing env
+
+## Preparation
-Preparation
------------
Set up Ubuntu 14.04 Server Edition Virtual Machine environment. We
tested this with Fusion on Mac OS X and VirtualBox on Windows 8.
-Setup
------
+## Setup
+
Open a terminal and execute the following commands:
-```
+```bash
% sudo apt-get install -y --force-yes wget
% wget https://raw.githubusercontent.com/osrg/gobgp/master/tools/route-server/route-server-docker.sh
% chmod +x route-server-docker.sh
% ./route-server-docker.sh install
```
-All necessary software will be installed. You can find all configuration files (for Quagga and gobgp) at /usr/local/gobgp. Let's make sure:
+All necessary software will be installed. You can find all configuration files
+(for Quagga and gobgp) at /usr/local/gobgp. Let's make sure:
-```
+```bash
fujita@ubuntu:~$ find /usr/local/gobgp|sort
/usr/local/gobgp
/usr/local/gobgp/gobgpd.conf
@@ -41,28 +41,30 @@ fujita@ubuntu:~$ find /usr/local/gobgp|sort
/usr/local/gobgp/q8/bgpd.conf
```
-Before going to playing with this environment, you need to log out and log in again.
+Before going to playing with this environment, you need to log out and log in
+again.
-Start
------
-```
+## Start
+
+```bash
% ./route-server-docker.sh start
```
+
Eight containers for Quagga and one container for gobgp started.
Now ready to start gobgp so let's go into the container for gobgp:
-```
+```bash
% docker exec -it gobgp bash
```
You are supposed to get a console like the following:
-```
+```bash
root@ec36881de971:~#
```
-```
+```bash
root@e7cb66415e2f:~# go run gobgp/bgpd.go -f /mnt/gobgpd.conf
INFO[0000] Peer 10.0.0.1 is added
INFO[0000] Peer 10.0.0.2 is added
@@ -71,7 +73,7 @@ INFO[0000] Peer 10.0.0.4 is added
INFO[0000] Peer 10.0.0.5 is added
INFO[0000] Peer 10.0.0.6 is added
INFO[0000] Peer 10.0.0.7 is added
-INFO[0000] Peer 10.0.0.8 is added
+INFO[0000] Peer 10.0.0.8 is added
```
After some time, you'll see more messages on the console (it means
@@ -79,13 +81,13 @@ Quagga bgpd connected to gobgp).
On a different console, let's check the status of Quagga.
-```
+```bash
% docker exec -it q1 bash
```
You can do something like:
-```
+```bash
root@a40ac8058ca7:/# telnet localhost bgpd
```
@@ -95,12 +97,13 @@ The names of Quagga containers are q1, q2, q3, q4, q5, q6, q7, and q8
respectively. You can execute bash on any container with 'docker exec'
command.
-Stop
-----
+## Stop
+
The following command stops and cleans up everything.
-```
+```bash
% ./route-server-docker.sh stop
```
-You can safely excute this command whenever something goes wrong and start again.
+You can safely execute this command whenever something goes wrong and start
+again.