doc: clean up 18.04 build doc

Some excess underlines, 4-space indents and typos cleaned up.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
This commit is contained in:
Quentin Young 2018-05-17 21:06:32 +00:00
parent 76015847ea
commit f448f9145f

View File

@ -1,8 +1,9 @@
Ubuntu 18.04LTS
===============================================
Ubuntu 18.04 LTS
================
Install dependencies
-------------------------
--------------------
Required packages
^^^^^^^^^^^^^^^^^
@ -70,7 +71,7 @@ Add frr groups and user
sudo usermod -a -G frrvty frr
Download source
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^
::
@ -82,7 +83,7 @@ Options below are provided as an example.
.. seealso:: *Installation* section of user guide
::
.. code-block:: shell
cd frr
./bootstrap.sh
@ -136,15 +137,16 @@ configuration files _before_ starting FRR. This assures that the permissions
are correct. If the files are not already present, FRR will create them.
It's also important to consider _which_ files to create. FRR supports writing
configuration to a monolithic file, ``/etc/frr/frr.conf``, which is not
recommended
configuration to a monolithic file, :file:`/etc/frr/frr.conf`, which is not
recommended.
.. seealso:: *VTYSH* section of user guide
The presence of ``/etc/frr/frr.conf`` on startup implicitly configures FRR to
ignore daemon-specific configuration files.
The presence of :file:`/etc/frr/frr.conf` on startup implicitly configures FRR
to ignore daemon-specific configuration files.
Daemon-specific configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
@ -162,7 +164,7 @@ Daemon-specific configuration
sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf
Monolithic configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~
::
@ -173,8 +175,8 @@ Monolithic configuration
Enable IPv4 & IPv6 forwarding
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Edit ``/etc/sysctl.conf`` and uncomment the following values (ignore the
other settings)
Edit :file:`/etc/sysctl.conf` and uncomment the following values (ignore the
other settings):
::
@ -189,8 +191,8 @@ other settings)
Add MPLS kernel modules
^^^^^^^^^^^^^^^^^^^^^^^
Ubuntu 18.04 ships with kernel 4.15. MPLS modules are present by default.
To enable, add the following lines to ``/etc/modules-load.d/modules.conf``:
Ubuntu 18.04 ships with kernel 4.15. MPLS modules are present by default. To
enable, add the following lines to :file:`/etc/modules-load.d/modules.conf`:
::
@ -198,15 +200,13 @@ To enable, add the following lines to ``/etc/modules-load.d/modules.conf``:
mpls_router
mpls_iptunnel
**Reboot** or use ``sysctl -p`` to apply the same config to the running
system
Reboot or use ``sysctl -p`` to apply the same config to the running system.
Enable MPLS Forwarding
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^
Edit ``/etc/sysctl.conf`` and the following lines. Make sure to add a
line equal to ``net.mpls.conf.eth0.input`` or each interface used with
MPLS
Edit :file:`/etc/sysctl.conf` and the following lines. Make sure to add a line
equal to :file:`net.mpls.conf.eth0.input` for each interface used with MPLS.
::
@ -216,8 +216,8 @@ MPLS
net.mpls.conf.eth2.input=1
net.mpls.platform_labels=100000
Install the systemd service (if rebooted from last step, change directory back to frr directory)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Install the systemd service
^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
@ -231,9 +231,8 @@ Install the systemd service (if rebooted from last step, change directory back t
Enable daemons
^^^^^^^^^^^^^^
| Edit ``/etc/frr/daemons`` and change the value from "no" to "yes" for
those daemons you want to start by systemd.
| For example.
Edit ``/etc/frr/daemons`` and change the value from "no" to "yes" for those
daemons you want to start by systemd. For example:
::
@ -248,10 +247,19 @@ Enable daemons
Enable the systemd service
^^^^^^^^^^^^^^^^^^^^^^^^^^
- systemctl enable frr
Enabling the systemd service causes FRR to be started upon boot. To enable it,
use the following command:
.. code-block:: shell
systemctl enable frr
Start the systemd service
^^^^^^^^^^^^^^^^^^^^^^^^^
- systemctl start frr
- use ``systemctl status frr`` to check its status.
.. code-block:: shell
systemctl start frr
After starting the service, you can use ``systemctl status frr`` to check its
status.