CORD-2718: Fixes to vrouter documentation.
* 'docker run' now doesn't allow -n; use --name instead
* bring down interface before using pipework
* notify there will be a warning
* show how to restart docker container
Change-Id: Icdbab7dce948bf8f3dfa6a7f3415784a959c7597
diff --git a/docs/vrouter.md b/docs/vrouter.md
index 5aeb443..1b10215 100644
--- a/docs/vrouter.md
+++ b/docs/vrouter.md
@@ -212,13 +212,16 @@
is on your system):
```shell
-sudo docker run --privileged -d -v configs:/etc/quagga -n quagga opencord/quagga
+sudo docker run --privileged -d -v configs:/etc/quagga --name quagga opencord/quagga
```
Finally, we can use the pipework tool to add the physical interface into the
-container so that Quagga can talk out over the fabric:
+container so that Quagga can talk out over the fabric (we need to bring the physical
+interface down first). The pipework command will emit a warning about arping, but
+you can ignore that.
```shell
+sudo ip link set mlx1 down
sudo ./pipework mlx1 -i eth1 quagga 10.0.1.3/24
```
@@ -227,13 +230,16 @@
the IP `10.0.1.3`. This IP address should be the peering subnet address that
you want to assign to Quagga.
+### Restart the container
+
If you need to change anything about the container (for example if you change
the Quagga configuration) you can remove the original container and run a new
one:
```shell
docker rm -f quagga
-sudo docker run --privileged -d -v configs:/etc/quagga -n quagga opencord/quagga
+sudo docker run --privileged -d -v configs:/etc/quagga --name quagga opencord/quagga
+sudo ./pipework mlx1 -i eth1 quagga 10.0.1.3/24
```
## Configure Quagga
@@ -311,3 +317,7 @@
important that this rewriting is done correctly so that the fabric switch is
able to distinguish data plane and control plane traffic.
+### Restart
+
+Remember you must [restart the container](#restart-the-container) whenever
+you change the Quagga configuration files.
\ No newline at end of file