This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
wiki:quick_startup_guide [2017/11/15 11:12] hch configuration files modified |
wiki:quick_startup_guide [2018/01/31 11:45] (current) tda |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Quick startup guide ====== | ====== Quick startup guide ====== | ||
- | ===== Required software ===== | + | ===== How to install packages for the RAN ? ===== |
- | Wanesy RAN connectivity needs the latest version of the following packages installed on the gateway: | + | For Wanesy RAN connectivity, we recommend to install the latest version of the packages specified in the compatibility matrix (depending of the RAN release version) that you can find here: [[wiki:releases|Software Releases]]: |
- | * Keros firmware | + | * Firmware package |
* BSCC package | * BSCC package | ||
* SNMP package | * SNMP package | ||
- | * Packet forwarder package | + | * HAL package |
- | * OpenVPN package (contact [[mailto:support@kerlink.fr|support@kerlink.fr]]) | + | * Packet Forwarder package |
+ | * OpenVPN package | ||
- | These packages can be downloaded from the [[wiki:releases|Software Releases]] page. | + | To obtain the specific OpenVPN package for your gateway, please contact [[mailto:support@kerlink.fr|support@kerlink.fr]] |
+ | Install can be performed either over the network, either by USB.\\ | ||
+ | You need also a local debug link or open a SSH session in order to send commands to the gateway and get the feedback. | ||
+ | Package installation procedure is described on the product dedicated wiki page : | ||
+ | * [[http://wikikerlink.fr/wirnet-ibts/doku.php?id=wiki:upgrade|Wirnet iBTS]] | ||
+ | * [[http://wikikerlink.fr/wirnet-ifemtocell/doku.php?id=wirnet-ifemtocell:software_updates|Wirnet iFemtoCell]] | ||
+ | * [[http://wikikerlink.fr/lora-station/doku.php?id=wiki:upgrade_legacy|Wirnet Station]] | ||
- | ===== OpenVPN Package Installation ===== | + | We recommend to follow the procedure below : |
- | ==== iBTS / iFemtoCell ==== | + | - Install the firmware package |
+ | - Install RAN packages : BSCC / SNMP / OpenVPN | ||
+ | - Check the VPN connection to the RAN | ||
+ | - Install HAL & Packet Forwarder packages : LORA HAL / SPF | ||
+ | - Check Packet Forwarding | ||
- | The OpenVPN package can be installed on the sytem in the same manner as any other package. | + | <note important> |
+ | Note that for Step 4, you can install packages from the RAN Dashboard interface using the the Drag&Drop feature.\\ | ||
+ | Refer to the section [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:bsc|Software update]] to know how to proceed. | ||
+ | </note> | ||
- | Package installation procedure is described on the product dedicated wiki page : | + | \\ |
+ | ===== How to update packages for the RAN ? ===== | ||
- | * [[http://wikikerlink.fr/wirnet-ibts/doku.php?id=wiki:upgrade|Wirnet iBTS]] | + | <note important> |
- | * [[http://wikikerlink.fr/wirnet-ifemtocell/doku.php?id=wirnet-ifemtocell:software_updates|Wirnet iFemtoCell]] | + | Preconditions: |
- | * [[http://wikikerlink.fr/lora-station/doku.php?id=wiki:upgrade|Wirnet station]] | + | Before proceeding to the update, check that all your software packages are at the software level (version number) indicated in the compatibility matrix: |
+ | [[wiki:releases|Software Releases]] | ||
+ | </note> | ||
+ | There are 3 ways to update your gateway: | ||
+ | |||
+ | * <fc #4682b4>via the RAN Dashboard interface (recommended)</fc> | ||
+ | * <fc #4682b4>over the network</fc> | ||
+ | * <fc #4682b4>via an USB key</fc> | ||
+ | | ||
+ | |||
+ | |||
+ | === Update via the Dashboard interface === | ||
+ | |||
+ | Since you are already connected to the RAN, you can update your packages through the Dashboard interface via the Drag&Drop area: refer to the | ||
+ | [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:bsc|Software update]] page to know how to proceed. | ||
+ | |||
+ | === Update over the network or via USB === | ||
+ | |||
+ | Install the new version by following the procedure described above for packages installation. | ||
+ | OpenVPN package does not need to be re-installed in the system. | ||
+ | Refer to the specific Wiki to get details about the procedure to remove a package from the system. | ||
+ | |||
+ | <note important> | ||
+ | Upgrading the packet Forwarder will remove all your Packet Forwarder's configuration data (config.json)\\ | ||
+ | Please save it or copy files to a well-known location (ex /user/my_backup) before proceeding to the update | ||
+ | </note> | ||
+ | |||
+ | <note important> | ||
+ | Take care if your Wirnet Station's firmware is **2.x** and if you choose to upgrate your gateway via a remote manner, you must install a specific dota to upgrade your firmware. Refer to the [[http://wikikerlink.fr/lora-station/doku.php?id=wiki:upgrade|Wirnet Station]] section to get some details about the procedure to follow. | ||
+ | </note> | ||
+ | \\ | ||
===== Checking configuration ===== | ===== Checking configuration ===== | ||
- | ==== On the gateway ==== | + | You can either check all points in the [[ http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:checklist|checklist]] |
+ | either check the 2 following points to go faster. | ||
- | In LoRa packet-forwarder configuration file : | + | \\ |
+ | ==== Checking VPN connection to the RAN ==== | ||
+ | \\ | ||
- | * For Wirnet station : ''/mnt/fsuser-1/spf/etc/global_conf.json'' | + | === Via debug link or SSH access === |
- | * For Wirnet iBTS : ''/user/spf2/etc/config.json'' | + | |
+ | Type an ''ifconfig'' command and check that the ''vpn0'' interface has been created. | ||
+ | On failure, refer to the [[ http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:troubleshooting|troubleshooting ]] section. | ||
+ | |||
+ | === Via the Dashboard interface === | ||
+ | |||
+ | Your gateway must be declared in an existing fleet (create it first if necessary) using its EUI in the [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:administration|administration]] menu. | ||
+ | |||
+ | This EUI can be found in the field gateway_ID of the generated JSON file (you need obviously a local or remote access to the gateway): | ||
+ | |||
+ | * For Wirnet station : ''grep gateway_ID /mnt/fsuser-1/spf/etc/local_conf.json'' | ||
+ | * For Wirnet iBTS : ''grep gateway_ID /user/spf2/etc/config.json'' | ||
+ | * For Wirnet iFemtoCell : ''grep gateway_ID /user/spf/etc/local_conf.json'' | ||
+ | |||
+ | Once the station has been added to an existing fleet, select the BSC menu and select your fleet. [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:bsc]]\\ | ||
+ | \\ | ||
+ | The Gateway should appear in the list of stations and its status should be "Connected". Wait few minutes and force F5 page refresh if not the case. | ||
+ | In case of persistent issue, refer to the [[ http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:troubleshooting|troubleshooting]] section. | ||
+ | |||
+ | |||
+ | \\ | ||
+ | ==== Checking Packet Forwarding ==== | ||
+ | \\ | ||
+ | |||
+ | === Via debug link or SSH access === | ||
+ | |||
+ | Connect to the gateway via SSH command. | ||
+ | |||
+ | Then, check LoRa packet-forwarder configuration file : | ||
+ | |||
+ | * For Wirnet station : ''/mnt/fsuser-1/spf/etc/global_conf.json'' | ||
+ | * For Wirnet iBTS : ''/user/spf2/etc/config.json'' | ||
* For Wirnet iFemtoCell : ''/user/spf/etc/global_conf.json'' | * For Wirnet iFemtoCell : ''/user/spf/etc/global_conf.json'' | ||
Line 46: | Line 125: | ||
* ''serv_port_down'': 1700 | * ''serv_port_down'': 1700 | ||
- | ==== On the dashboard ==== | + | Check packet forwarder logs: |
+ | |||
+ | * For Wirnet station : ''/mnt/fsuser-1/spf/var/log'' | ||
+ | * For Wirnet iBTS : ''/user/spf2/var/log/'' | ||
+ | * For Wirnet iFemtoCell : ''/user/spf/var/log'' | ||
- | New gateways must be declared in an existing fleet (create it first if necessary), using their EUI. | ||
- | This EUI can be found in the field gateway_ID of the generated JSON file: | + | === Via the dashboard interface === |
- | * For Wirnet station : ''grep -r gateway_ID /mnt/fsuser-1/spf/etc/local_conf.json'' | + | In the [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:administration|administration]] menu : |
- | * For Wirnet iBTS : ''grep -r gateway_ID /user/spf2/etc/config.json'' | + | |
- | * For Wirnet iFemtoCell : ''grep -r gateway_ID /user/spf/etc/local_conf.json'' | + | |
+ | * Declare a new cluster if the test cluster does not exist | ||
+ | * Declare a test endpoint in this cluster | ||
+ | * Select your gateway EUI in the BSC/Stations menu and copy it to the clipboard | ||
+ | * Select your gateway in the LNS/Stations menu using filtering function and paste EUI | ||
+ | * check traffic messages (Last Rx messages) | ||