snapcraft/README.usage.md

   1 Using the FRRouting Snap
   2 ===============================
   3
   4 After installing the Snap, the priviledged plug need to be connected:
   5
   6     snap connect frr:network-control core:network-control
   7
   8 Enabling/Disabling FRRouting Daemons
   9 -------------------------------------------
  10
  11 By default (at this time), all FRRouting daemons will be enabled
  12 on installation. If you want to disable a specific daemon, then use
  13 the systemctl commands
  14
  15 ie for `ospf6d` (OSPFv3):
  16
  17     systemctl disable snap.frr.ospf6d.service
  18     systemctl enable snap.frr.ospf6d.service
  19
  20 The daemons are: `ripd`, `ripngd`, `ospfd`, `ospf6d`, `isisd`, `bgpd`,
  21 `pimd`, `zebra`
  22
  23 Commands defined by this snap
  24 -----------------------------
  25
  26 - `frr.vtysh`:
  27         FRRouting VTY Shell (configuration tool)
  28 - `frr.version`:
  29         Returns output of `zebra --version` to display version and configured
  30         options
  31 - `frr.readme`:
  32         Returns this document `cat README_usage.md`
  33
  34 and for debugging defined at this time (May get removed later - do not
  35 depend on them). These are mainly intended to debug the Snap
  36
  37 - `frr.zebra-debug`:
  38         Starts zebra daemon in foreground
  39 - `frr.ripd-debug`:
  40         Starts ripd daemon in foreground
  41 - `frr.ripngd-debug`:
  42         Starts ripng daemon in foreground
  43 - `frr.ospfd-debug`:
  44         Starts ospfd daemon in foreground
  45 - `frr.ospf6d-debug`:
  46         Starts ospf6d daemon in foreground
  47 - `frr.isisd-debug`:
  48         Starts isisd daemon in foreground
  49 - `frr.bgpd-debug`:
  50         Starts bgpd daemon in foreground
  51 - `frr.pimd-debug`:
  52         Starts pimd daemon in foreground
  53 - `frr.ldpd-debug`:
  54     Starts ldpd daemon in foreground
  55
  56 MPLS (LDP)
  57 ----------
  58 The MPLS forwarding requires a Linux Kernel version 4.5 or newer and
  59 specific MPLS kernel modules loaded. It will be auto-detected by
  60 FRR. You can check the detected setup with the `show mpls status`
  61 command from within `frr.vtysh`
  62
  63 The following kernel modules `mpls-router` and `mpls-iptunnel`
  64 need to be loaded. On Ubuntu 16.04, this can be done by editing
  65 '/etc/modules-load.d/modules.conf' and add the following lines:
  66
  67         # Load MPLS Kernel Modules
  68         mpls-router
  69         mpls-iptunnel
  70
  71 For other distributions, please check the documentation on loading
  72 modules. You need to either reboot or use `modprobe` to manually load
  73 the modules as well before MPLS will be available.
  74
  75 In addition to this, the MPLS Label-Processing needs to be enabled
  76 with `sysctl` on the required interfaces. Assuming the interfaces
  77 are named `eth0`, `eth1` and `eth2`, then the additional lines in
  78 `/etc/sysctl.conf` will enable it on a Ubuntu 16.04 system:
  79
  80         # Enable MPLS Label processing on all interfaces
  81         net.mpls.conf.eth0.input=1
  82         net.mpls.conf.eth1.input=1
  83         net.mpls.conf.eth2.input=1
  84         net.mpls.platform_labels=100000
  85
  86 These settings require either a reboot or a manual configuration with
  87 `sysctl` as well.
  88
  89 FAQ
  90 ---
  91 - frr.vtysh displays `--MORE--` on long output. How to suppress this?
  92     - Define `VTYSH_PAGER` to `cat` (default is `more`). (Ie add
  93       `export VTYSH_PAGER=cat` to the end of your `.profile`)
  94
  95 - ospfd / ospf6d are not running after installation
  96         - Installing a new snap starts the daemons, but at this time they
  97           may not have the required priviledged access. Make sure you
  98           issue the `snap connect` command as given above (can be verified
  99           with `snap interfaces`) and **THEN** restart the daemons (or
 100           reboot the system).
 101           This is a limitation of any snap package at this time which
 102           requires priviledged interfaces (ie to manipulate routing tables)
 103
 104 Sourcecode available
 105 ====================
 106
 107 The source for this SNAP is available as part of the FRRouting
 108 Source Code Distribution under `GPLv2 or later`
 109
 110 <https://github.com/frrouting/frr.git>
 111
 112 Instructions for rebuilding the snap are in `snapcraft/README.snap_build.md`
 113
 114 *Please checkout the desired branch before following the instructions
 115 as they may have changed between versions of FRR*
 116
 117 Official Webpage for FRR
 118 ========================
 119
 120 Official webpage for FRR is at <https://www.frrouting.org/>
 121
 122 Feedback welcome
 123 ================
 124
 125 Please send Feedback about this snap to Martin Winter at
 126 `mwinter@opensourcerouting.org`