diff options
| author | Martin Winter <mwinter@opensourcerouting.org> | 2017-01-25 22:23:43 +0100 |
|---|---|---|
| committer | Martin Winter <mwinter@opensourcerouting.org> | 2017-01-25 22:23:43 +0100 |
| commit | 3ab11ecc7ba6de37393d334bf9f6cbc88a3eeec1 (patch) | |
| tree | 9a7bfb39e158adde7f917b898cb10760ffe7bb96 /snapcraft/README.usage.md | |
| parent | Merge pull request #120 from opensourcerouting/snapcraft-base-v3 (diff) | |
| download | frr-3ab11ecc7ba6de37393d334bf9f6cbc88a3eeec1.tar.xz frr-3ab11ecc7ba6de37393d334bf9f6cbc88a3eeec1.zip | |
snapcraft: Add snapcraft build and definition files
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
Diffstat (limited to 'snapcraft/README.usage.md')
| -rw-r--r-- | snapcraft/README.usage.md | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/snapcraft/README.usage.md b/snapcraft/README.usage.md new file mode 100644 index 000000000..2d2b32b6b --- /dev/null +++ b/snapcraft/README.usage.md @@ -0,0 +1,77 @@ +Using the FreeRangeRouting Snap +=============================== + +After installing the Snap, the priviledged plug need to be connected: + + snap connect frr:network-control ubuntu-core:network-control + +Enabling/Disabling FreeRangeRouting Daemons +------------------------------------------- + +By default (at this time), all FreeRangeRouting daemons will be enabled +on installation. If you want to disable a specific daemon, then use +the systemctl commands + +ie for `ospf6d` (OSPFv3): + + systemctl disable snap.frr.ospf6d.service + systemctl enable snap.frr.ospf6d.service + +The daemons are: `ripd`, `ripngd`, `ospfd`, `ospf6d`, `isisd`, `bgpd`, +`pimd`, `zebra` + +Commands defined by this snap +----------------------------- + +- `frr.vtysh`: + FreeRangeRouting VTY Shell (configuration tool) +- `frr.version`: + Returns output of `zebra --version` to display version and configured + options +- `frr.readme`: + Returns this document `cat README_usage.md` + +and for debugging defined at this time (May get removed later - do not +depend on them). These are mainly intended to debug the Snap + +- `frr.zebra-debug`: + Starts zebra daemon in foreground +- `frr.ripd-debug`: + Starts ripd daemon in foreground +- `frr.ripngd-debug`: + Starts ripng daemon in foreground +- `frr.ospfd-debug`: + Starts ospfd daemon in foreground +- `frr.ospf6d-debug`: + Starts ospf6d daemon in foreground +- `frr.isisd-debug`: + Starts isisd daemon in foreground +- `frr.bgpd-debug`: + Starts bgpd daemon in foreground +- `frr.pimd-debug`: + Starts pimd daemon in foreground +- `frr.ldpd-debug`: + Starts ldpd daemon in foreground + +FAQ +--- +- frr.vtysh displays `--MORE--` on long output. How to suppress this? + - Define `VTYSH_PAGER` to `cat` (default is `more`). (Ie add + `export VTYSH_PAGER=cat` to the end of your `.profile`) + +Sourcecode available +==================== + +The source for this SNAP is available as part of the FreeRangeRouting +Source Code Distribution. + + https://github.com/freerangerouting/frr.git + +Instructions for rebuilding the snap are in `README.snap_build.md` + +Feedback welcome +================ + +Please send Feedback about this snap to Martin Winter at +`mwinter@opensourcerouting.org` + |