User Tools

Site Tools


wiki:wiki3:magic_link

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
wiki:wiki3:magic_link [2020/02/26 19:40]
tda
wiki:wiki3:magic_link [2020/11/26 11:30]
mbi [Over WMC dashboard]
Line 1: Line 1:
 ====== Magic Link ====== ====== Magic Link ======
  
- +**To ease the upgrade, migration or first installation of gateways, a Magic Link feature can be used. 
-To ease the upgrade, migration or first installation of gateways, a Magic Link feature can be used. +** 
- +It is a simple command ​or a simple script ​based on ''​wget''​ that automatically downloads the required embedded software, configures the VPN connection, configures the packet forwarder with the best default configuration,​ all in one step.
-It is a simple command based on ''​wget''​ that automatically downloads the required embedded software, configures the VPN connection, configures the packet forwarder with the best default configuration,​ all in one step.+
  
 ===== Request ===== ===== Request =====
  
 Request has to be made to customer support through [[support@kerlink.fr]] or by opening an OTRS Ticket. Request has to be made to customer support through [[support@kerlink.fr]] or by opening an OTRS Ticket.
 +
 +Following information should be provided to the Kerlink Support team:
 +
 +  * Gateway(s) EUI(s) or Board ID(s)
 +  * WMC instance name or URL
 +  * Customer name
 +  * Fleet name 
 +
  
 A single Magic Link can be reused for as many gateways as necessary (__please include them all__ when requesting the Magic Link from Kerlink support). It is linked to a single WMC instance. A single Magic Link can be reused for as many gateways as necessary (__please include them all__ when requesting the Magic Link from Kerlink support). It is linked to a single WMC instance.
  
-There is a unique and secret token inside the Magic Link command or USB package. This is a secret that shouldn'​t be shared and transmitted in a non-secure way.+There is a unique and secret token inside the Magic Link command, Magic Link script ​or USB package. ​ \\ 
 +**This is a secret that shouldn'​t be shared and transmitted in a non-secure way.**
  
 ===== Reception ===== ===== Reception =====
Line 34: Line 42:
 </​note>​ </​note>​
  
-==== By SSH ====+==== Over SSH ====
  
 An SSH access to the gateway is required, this means that it shouldn'​t be already connected to WMC (unless for on-premises servers, in which case SSH is possible from the WMC server itself). An SSH access to the gateway is required, this means that it shouldn'​t be already connected to WMC (unless for on-premises servers, in which case SSH is possible from the WMC server itself).
Line 40: Line 48:
 Just copy/paste the provided command and wait for about 5 minutes (20 minutes if Wirnet iBTS with FPGA upgrade). Just copy/paste the provided command and wait for about 5 minutes (20 minutes if Wirnet iBTS with FPGA upgrade).
  
-==== By USB ====+==== Over USB ====
  
 Unzip the provided package on an USB stick and plug it into the Wirnet gateway. Unzip the provided package on an USB stick and plug it into the Wirnet gateway.
Line 46: Line 54:
 For Wirnet iBTS and Wirnet iFemtoCell, please remove the USB stick after 15 seconds (as soon as the LED blinks). For Wirnet Station, please leave the USB stick plugged in for 20 minutes, or until the gateway is shown as connected on the WMC instance. For Wirnet iBTS and Wirnet iFemtoCell, please remove the USB stick after 15 seconds (as soon as the LED blinks). For Wirnet Station, please leave the USB stick plugged in for 20 minutes, or until the gateway is shown as connected on the WMC instance.
  
-==== By WMC ====+==== Over WMC dashboard ​==== 
 + 
 +Over WMC dashboard, you can use the Magic Link to update a single gateway or a group of gateways. 
 + 
 +=== Updating a single gateway with the Magic Link ==
  
 For WMC, it is less useful to use the Magic Link as the Software Upgrade feature can be used to send any package: new VPN package (migration),​ megapackage (upgrade), etc. For WMC, it is less useful to use the Magic Link as the Software Upgrade feature can be used to send any package: new VPN package (migration),​ megapackage (upgrade), etc.
Line 52: Line 64:
 The advantage though, is that it's no longer required to download the megapackage from this wiki and upload it in the //Software update// section of the WMC. The gateway will directly download the megapackage and VPN package through the use of the Magic Link. The advantage though, is that it's no longer required to download the megapackage from this wiki and upload it in the //Software update// section of the WMC. The gateway will directly download the megapackage and VPN package through the use of the Magic Link.
  
-Though if the Magic Link should really be used, it can be done by creating a script file like this one: 
  
-<code bash magic_link.sh>​ +Use the File Explorer feature of the WMC to upload the Magic Link script to ''​/tmp''​ or ''​/user''​ directory.
-#!/bin/sh +
-/etc/init.d/firewall stop +
-killall openvpn +
-sleep 1 +
-wget -O- https://​upgrade.wanesy.com/​00112233445566778899aabbccddeeff | sh +
-</​code>​+
  
-Be sure to replace the token with the one received from Kerlink. Run ''​dos2unix''​ on that script if Windows is used, or ensure that line endings are LF only (and not the default CRLF for Windows).+{{:​wiki3:​upload_magic_link_script.png|}} ​
  
-Use the File Explorer feature of the WMC to send the file to ''/​tmp''​. Then use the Remote Shell feature and type: ''​sh ​/tmp/magic_link.sh''​+. 
 + 
 +Then use the Remote Shell feature and execute the Magic Link script ​''​sh magic_link.sh'' ​from the directory where it is located, ''/​user''​ or ''/​tmp''​. 
 + 
 +
 + 
 +{{:​wiki3:​executing_magic_link_script.png|}}
  
 ===== Use cases ===== ===== Use cases =====
  
-First installation:+==== First installation ​====
  
    * over SSH: not applicable for cellular backhaul unless the gateway has a known public IP address. A DHCP server would be necessary on the LAN if Ethernet/​WiFi,​ though static IP should work if directly connected to a computer (static IP and RJ45 cable or WiFi access from the computer to the gateway).    * over SSH: not applicable for cellular backhaul unless the gateway has a known public IP address. A DHCP server would be necessary on the LAN if Ethernet/​WiFi,​ though static IP should work if directly connected to a computer (static IP and RJ45 cable or WiFi access from the computer to the gateway).
    * over USB: works all the time, but requires physical access.    * over USB: works all the time, but requires physical access.
  
-Migration (e.g. from instance A to instance B):+==== Migration (e.g. from instance A to instance B) ====
  
    * over SSH: only applicable for on-premises instances (where SSH is available through the VPN tunnel from the WMC server itself).    * over SSH: only applicable for on-premises instances (where SSH is available through the VPN tunnel from the WMC server itself).
Line 79: Line 90:
    * over USB: works all the time, but requires physical access.    * over USB: works all the time, but requires physical access.
  
-Upgrade (e.g. same instance, but different embedded software version):+==== Upgrade (e.g. same instance, but different embedded software version) ​====
  
    * over SSH: only applicable for on-premises instances.    * over SSH: only applicable for on-premises instances.
    * using WMC: upload a script and execute it.    * using WMC: upload a script and execute it.
    * over USB: works all the time, but requires physical access.    * over USB: works all the time, but requires physical access.
 +
 +===== Specific Use cases =====
 +
 +When may want to upgrade several gateways using the Magic Link.
 +In this case, you can use the workflow feature to achieve this.
 +
  
wiki/wiki3/magic_link.txt · Last modified: 2020/12/14 14:44 by tda