Merge pull request #10962 from louis-6wind/lfa-netlink

[mirror_frr.git] / snapcraft / README.snap_build.md

diff --git a/snapcraft/README.snap_build.md b/snapcraft/README.snap_build.md
index c4db51bd6aa02a717fd54b2694b6c1d7a6ecd79b..f4a38e7f7f0bc84b4f07f18a86cde7a6fe84fd35 100644 (file)
--- a/snapcraft/README.snap_build.md
+++ b/snapcraft/README.snap_build.md
@@ -1,7 +1,6 @@
 Building your own FRRouting Snap
 ========================================
-(Tested on Ubuntu 16.04 with Snap Version 2, does not work on Ubuntu 15.x
-which uses earlier versions of snaps)
+(Tested on Ubuntu 18.04)
 
 1. Install snapcraft:
 
@@ -12,7 +11,12 @@ which uses earlier versions of snaps)
         git clone https://github.com/frrouting/frr.git
         cd frr
 
-3. Run Bootstrap and make distribution tar.gz
+3. (Optional) Add extra version information to 
+   `snapcraft/extra_version_info.txt`. Information in this file will
+   be displayed with the frr.version command (simple `cat` after
+   the display of the `zebra --version` output)
+
+4. Run Bootstrap and make distribution tar.gz
 
         ./bootstrap.sh
         ./configure --with-pkg-extra-version=-MySnapVersion
@@ -25,7 +29,7 @@ which uses earlier versions of snaps)
     This will build `frr-something.tar.gz` - the distribution tar and 
     the snapcraft/snapcraft.yaml with the matching version number
 
-4. Create snap
+5. Create snap
 
         cd snapcraft
         snapcraft
@@ -47,8 +51,10 @@ Installing the snap
 
     Connect the priviledged `network-control` plug to the snap:
 
-        snap connect frr:network-control ubuntu-core:network-control
+        snap connect frr:network-control core:network-control
 
+See README.usage.md for more details on setting up and using the snap
+        
 DONE.
 
 The Snap will be auto-started and running. 
@@ -85,9 +91,27 @@ All the commands are prefixed with frr.
     frr.ripngd-debug
     frr.ldp-debug
     frr.zebra-debug
+    frr.pimd-debug
+    frr.nhrpd-debug
+    frr.babeld-debug
+    frr.eigrpd-debug
+    frr.pbrd-debug
+    frr.staticd-debug
+    frr.bfdd-debug
+    frr.fabricd-debug
+    frr.pathd-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:
+path). If access as `vtysh` instead of `frr.vtysh` is needed, you can enable it
+via a snap alias as follows:
+
+   sudo snap alias frr vtysh
+
+This will add the vtysh command to your /snap/bin for direct access. The output of
+
+   sudo snap aliases
+
+should list vtysh command alias as enabled:
 
-    sudo ln -s /snap/bin/frr.vtysh /usr/local/bin/vtysh
+App          Alias    Notes
+frr.vtysh    vtysh    enabled