summaryrefslogtreecommitdiffstats
path: root/snapcraft
diff options
context:
space:
mode:
authorJafar Al-Gharaibeh <jafar@atcorp.com>2017-05-11 23:52:27 +0200
committerQuentin Young <qlyoung@users.noreply.github.com>2017-05-15 18:28:56 +0200
commit7ce9737dd7215ac6acb32daea9d78153e91de4d8 (patch)
treeb7a9eee9b91393d50dbb3870bfbf983c19d75ac2 /snapcraft
parentMerge pull request #521 from opensourcerouting/bgpd-fixes-stable (diff)
downloadfrr-7ce9737dd7215ac6acb32daea9d78153e91de4d8.tar.xz
frr-7ce9737dd7215ac6acb32daea9d78153e91de4d8.zip
snap: add vtysh as a "proper" command alias for frr.vtysh
This allows direct access to vtysh without the "frr." prefix. The alias can be enabled by sudo snap frr vtysh Signed-off-by: Jafar Al-Gharaibeh <jafar@atcorp.com>
Diffstat (limited to 'snapcraft')
-rw-r--r--snapcraft/README.snap_build.md15
-rw-r--r--snapcraft/README.usage.md18
-rw-r--r--snapcraft/snapcraft.yaml.in1
3 files changed, 24 insertions, 10 deletions
diff --git a/snapcraft/README.snap_build.md b/snapcraft/README.snap_build.md
index eeee6a17a..7c4284845 100644
--- a/snapcraft/README.snap_build.md
+++ b/snapcraft/README.snap_build.md
@@ -94,7 +94,16 @@ All the commands are prefixed with frr.
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:
+path). If access as `vtysh` instead of `frr.vtysh` is needed, you can enable it
+via a snap alias as follows:
- sudo ln -s /snap/bin/frr.vtysh /usr/local/bin/vtysh
+ 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:
+
+App Alias Notes
+frr.vtysh vtysh enabled
diff --git a/snapcraft/README.usage.md b/snapcraft/README.usage.md
index 537147303..1034790e0 100644
--- a/snapcraft/README.usage.md
+++ b/snapcraft/README.usage.md
@@ -109,13 +109,17 @@ FAQ
`export VTYSH_PAGER=cat` to the end of your `.profile`)
- ospfd / ospf6d are not running after installation
- - Installing a new snap starts the daemons, but at this time they
- may not have the required priviledged access. Make sure you
- issue the `snap connect` command as given above (can be verified
- with `snap interfaces`) and **THEN** restart the daemons (or
- reboot the system).
- This is a limitation of any snap package at this time which
- requires priviledged interfaces (ie to manipulate routing tables)
+ - Installing a new snap starts the daemons, but at this time they
+ may not have the required priviledged access. Make sure you
+ issue the `snap connect` command as given above (can be verified
+ with `snap interfaces`) and **THEN** restart the daemons (or
+ reboot the system).
+ This is a limitation of any snap package at this time which
+ requires priviledged interfaces (ie to manipulate routing tables)
+
+- Can I run vtysh directly without the "frr." prefix?
+ - Yes, enable the vtysh alias in the frr snap package by:
+ sudo snap alias frr vtysh
Sourcecode available
====================
diff --git a/snapcraft/snapcraft.yaml.in b/snapcraft/snapcraft.yaml.in
index eb6130195..17fabb16f 100644
--- a/snapcraft/snapcraft.yaml.in
+++ b/snapcraft/snapcraft.yaml.in
@@ -16,6 +16,7 @@ apps:
- network
- network-bind
- network-control
+ aliases: [vtysh]
version:
command: bin/show_version
readme: