snapcraft: Add snapcraft build and definition files

Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>

1 files changed, 93 insertions, 0 deletions

diff --git a/snapcraft/README.snap_build.md b/snapcraft/README.snap_build.md
new file mode 100644
index 000000000..341b210f7
--- /dev/null
+++ b/snapcraft/README.snap_build.md
@@ -0,0 +1,93 @@
+Building your own FreeRangeRouting Snap
+========================================
+(Tested on Ubuntu 16.04 with Snap Version 2, does not work on Ubuntu 15.x
+which uses earlier versions of snaps)
+
+1. Install snapcraft:
+
+        sudo apt-get install snapcraft
+	
+2. Checkout FreeRangeRouting under a **unpriviledged** user account
+
+        git clone https://github.com/freerangerouting/frr.git
+        cd frr
+
+3. Run Bootstrap and make distribution tar.gz
+
+        ./bootstrap.sh
+        ./configure --with-pkg-extra-version=-MySnapVersion
+        make dist
+			
+    Note: configure parameters are not important for the Snap building,
+    except the `with-pkg-extra-version` if you want to give the Snap
+    a specific name to mark your own unoffical build
+
+    This will build `frr-something.tar.gz` - the distribution tar and 
+    the snapcraft/snapcraft.yaml with the matching version number
+
+4. Create snap
+
+        cd snapcraft
+        snapcraft
+
+    You should now end up with `frr_something.snap`
+
+Installing the snap 
+===================
+(This can be done on a different system)
+
+1. Install snapd
+
+        sudo apt-get install snapd
+
+2. Install self-built frr snap. (`--force-dangerous` is required to
+   install a unsigned self-built snap)
+
+        snap install --force-dangerous ./frr*.snap
+
+    Connect the priviledged `network-control` plug to the snap:
+
+        snap connect frr:network-control ubuntu-core:network-control
+
+DONE.
+
+The Snap will be auto-started and running. 
+
+Operations
+==========
+
+### FreeRangeRouting Daemons
+At this time, all FreeRangeRouting daemons are auto-started.
+
+A daemon can be stopped/started with (ie ospf6d)
+
+    systemctl stop snap.frr.ospf6d.service
+    systemctl start snap.frr.ospf6d.service
+
+or disabled/enabled with
+
+    systemctl disable snap.frr.ospf6d.service
+    systemctl enable snap.frr.ospf6d.service
+
+### FreeRangeRouting Commands
+All the commands are prefixed with frr.
+
+    frr.vtysh       -> vtysh
+    frr.version     -> Just gives version output (zebra --version)
+    frr.readme      -> Returns simple README with hints on using FRR
+
+    frr.bgpd-debug  -> Directly start each daemon (without service)
+    frr.isisd-debug
+    frr.ospf6d-debug
+    frr.ospfd-debug
+    frr.pimd-debug
+    frr.ripd-debug
+    frr.ripngd-debug
+    frr.ldp-debug
+    frr.zebra-debug
+
+vtysh can be accessed as frr.vtysh (Make sure you have /snap/bin in your
+path). If access as `vtysh` instead of `frr.vtysh` is needed, a symlink 
+can be created:
+
+    sudo ln -s /snap/bin/frr.vtysh /usr/local/bin/vtysh