Differences

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

--- wiki:wiki3:install_upgrade [2019/06/12 15:38]
tda removed
+++ wiki:wiki3:install_upgrade [2021/02/05 12:14] (current)
hch [Upgrade or Install from scratch]
@@ Line 1: / Line 1: @@
 ====== Install or upgrade a gateway on WMC ======
+\\
-The connection to the Wanesy Management Center requires several software packages to be installed:
+\\
+The connection to the **Wanesy Management Center** requires several software packages to be installed:
+\\
+\\
   * **Packet Forwarder and companion HAL**: required to process LoRa packets.
   * **BSCC and SNMP**: required to handle software upgrades, gateway monitoring, etc.
-  * **OpenVPN package**: required to establish the VPN between the gateway and the WMC
+  * **OpenVPN package(s)**: required to establish the VPN between the gateway and the WMC
   * An up-to-date **firmware**
-To ease the process, a //megapackage// can be used to install/upgrade everything except for the OpenVPN package, which is always delivered separately.
+<note important>**Note that OpenVPN package v3.1 has been splitted in 2 parts: one part containing the secrets, the other part containing the configuration.**\\
+Ex: openvpn_secrets_703atf060337_wmcintegration.wanesy.com_3.1.ipk  and openvpn_config_wmcintegration.wanesy.com_3.1.ipk</note>
+\\
+\\
+To ease the process, a //megapackage// can be used to install or upgrade a gateway.
+**This megapackage includes all of these specific packages in an homogeneous way**: a firmware, BSCC and SNMP components, a Packet Forwarder and its companion HAL.
+This megapackage does not contain the OpenVPN package which is always delivered separately.
 This megapackage preserves any change to your current network configuration (VPN and GSM/ETH configuration).
 This megapackage can be used as well remotely (from WMC dashboard for instance) and locally (USB, debug link, SSH).
+To make the process even easier, a magic link can be used to install or update your gateway.
+Follow this [[wiki:magic_link|Magic Link]]
 ===== Prerequisites ======
@@ Line 18: / Line 31: @@
 ==== Generic ====
+<note>
    - It is **recommended** to have a DHCP server on your local network. The use of static IP can lead to a connection issue to the WMC.
-   - It is **mandatory** to update the OpenVPN package to v1.11 before using the megapackage
+   - It is **mandatory** to update the OpenVPN package to at least v1.11 **before using the megapackage**
+</note>
-If you never installed any OpenVPN package on your gateway, or if you need a newer VPN package version, you should ask for a VPN package to ''support@kerlink.fr'' and install it on your system.
+OpenVPN package(s) must be requested to ''support@kerlink.fr'' and installed on the gateway BEFORE using the megapackage.
 ===== Custom IP configuration =====
@@ Line 27: / Line 42: @@
 By default, when installing the WMC embedded software, the IP configuration is DHCP.
-If the gateway needs to have a specific configuration (static IP, mobile APN, etc), the only two supported methods are:
+If the gateway needs to have a specific configuration (static IP, mobile APN, etc), please refer to the specific [[wiki:wiki3:faq_staticip_3.x|FAQ - Static IP configuration]] section to know how to proceed:
-  * using the dashboard: applicable only for already connected gateways;
-  * ''/user/bscc/var.xml'': applicable for first installations or already connected gateways.
-Any other configuration (e.g. through ConnMan configuration files directly) will be wiped after the next reboot.
+===== Software Installation methods =====
-==== Wirnet iBTS and Wirnet iFemtoCell ====
-Use the following command to check the currently installed packages (example shows iBTS):
+Several methods are available to install the software on the gateway. The software and upgrade methods are list in the compatibility matrix below:
-<code bash>
-root@klk-lpbs-123456:~ # opkg list-installed
-bscc - v2.2.1                                   # <------ BSCC package version
-kerlink-openvpn-config-pki2-klk-lpbs-123456 - 1.11-180326
-keros - 3.1.16-0-gfd3610aa
-libloragw2 - 5.1.0-klk1
-lorasnmp - v2.2.1                               # <------ SNMP package version
-spf2 - 4.0.0-klk7_4.0.1-klk3
-</code>
-==== Wirnet Station ====
-<note warning>DO NOT USE THE MEGAPACKAGE IF YOUR FIRMWARE VERSION IS LOWER THAN v3.1</note>
-To check this, you must have a ''FILESYSTEM_VER'' ending with either ''1.5'' (firmware 3.1) or ''1.10'' (firmware 3.3). This can be found in the result of ''get_version -u -v'' (see below).
-If you have a 2.x firmware, please use the ''[[http://wikikerlink.fr/lora-station/doku.php?id=wiki:resources_wirnet_v_3.1|create_dota_2x_wirnet3.sh]]'' script to migrate to v3.1 firmware version
-Please run the following command on your Wirnet Station:
-<code bash>
-[root@Wirnet_0XXXXXXX ~]# get_version -u -v
-KERNEL_VER=3.10.104-3.10.104-klk7
-PIC_VER=8.3
-BOOTSTRAP_VER=""
-UBOOT_VER="U-Boot 2009.03-2009.03-klk1 (Jan 26 2018 - 12:04:27)"
-SCRIPT_VER=v1.0
-INITRAMFS_VER=v1.3
-FILESYSTEM_VER=2016.05v1.10                                # <---- firmware version
-KNETD_VER="wirma2_v4.09 WAN_3.16 (Dec 23 2016-14:33:40)"
-PROD_FW=wirmaV2_wirnet_v3.1-rc3
-LORABOARD_MANUFACTURER=00
-LORABOARD_TYPE="868-27dBm"
-LORABOARD_HWVERSION=05
-LORABOARD_SERIALNO=00XXXX
-************************ Update log ************************
-.03.15-08:30:07 -- Dota dota_ran_gateway_v2.2.2_5a61ea01-2967-4d0e-a12b-9acd72e2fa40.tar
-.03.15-08:31:04 -- Dota custo_openvpn.tar
-.03.15-08:31:08 -- Dota dota_packages_v2.2.tar
-.03.15-08:31:58 -- Dota custo_libloragw-fpga_4.1.3-klk7_wirnet.tar
-.03.15-08:32:05 -- Dota dota_spf_3.1.0-klk15_4.1.3-klk7_wirnet.tar
-.03.15-08:32:07 -- Dota dota_v1.0_rfscan_manager.tar
-.03.15-08:32:12 -- Dota dota_v2.2.1_bscc.tar           # <---- BSCC package version
-.03.15-08:32:19 -- Dota dota_v2.2.1_snmp.tar           # <---- SNMP package version
-************************************************************
-</code>
-===== Software packages =====
-Several methods are available to install the software. Please see the software installation and upgrade compatibility matrix below:
 ^ Method                       ^    Install from scratch     ^               Upgrade                ^
 | WMC drag'n'drop feature      |             no              |                  yes                 |
-| WMC workflow                 |             no              |      yes (except for VPN package)    |
+| WMC workflow                 |             no              |      not recommanded (bug) (not work for OpenVPN package)    |
 | Over SSH                     |            yes              |                  yes                 |
 | USB stick                    |            yes              |                  yes                 |
-The WMC upgrade is only available for a gateway that is already connected to the WMC dashboard. The VPN package should NEVER be sent to several gateways at once, so please don't use it in workflows.
+"Upgrade" stands for a gateway that is already connected to the WMC dashboard. \\
-WMC software can be delivered as one single megapackage, or as individual packages. Please refer to the table below to pick the preferred method:
+<note warning>**The  OpenVPN package v1.11 or v3.0  and OpenVPN v3.1 secret package should NEVER be sent to several gateways at once, so please don't use it in Workflows.**</note>
+<note important>On the other hand, the OpenVPN config v3.1 package can be sent to several gateways, for instance, to migrate all of your gateways to a new WMC server instance.</note>
+Embedded software can be delivered as one single megapackage or as individual packages. Please refer to the table below to pick the preferred method:
 ^                  ^                       Megapackage                   ^^                    Individual packages                               ^^
 ^  Upgrade method  ^     Wirnet Station     ^ KerOS (iBTS and iFemtoCell) ^    Wirnet Station                  ^     KerOS (iBTS and iFemtoCell)  ^
 | WMC drag'n'drop  | from firmware 3.x only |              yes            |  yes, except firmware (3)          |                yes               |
-| WMC workflow     | from firmware 3.x only |              yes            |  yes, except firmware (3) and VPN  |                yes               |
+| WMC workflow     | from firmware 3.x only |              yes            | not recommanded (bug) |                yes               |
 | USB (1)          | from firmware 3.x only |              yes            |            yes                     |                yes               |
 | SSH (2)          | from firmware 3.x only |              yes            |  yes, except firmware (3)          |                yes               |
@@ Line 116: / Line 80: @@
   - For individual packages (e.g. not the megapackage) on Wirnet Station, the firmware remote upgrade is not possible. Only BSCC, SNMP, Packet Forwarder and HAL can be installed over SSH/WMC. For firmware upgrades, please use USB.
-==== WMC drag'n'drop feature ====
+\\
+\\
+==== WMC Drag'n'Drop feature ====
-This can be used to download one software package (individual or megapackage) to the gateway.
+This can be used to download a single software package (individual or megapackage) to the gateway.
-  - Go to //BSC//, //Stations//
+Note that you should be connected to the WMC to use this feature.
-  - Select your station
-  - Choose //Software// > //Upgrade// from the top menu
-{{ images:bsc_stations_sw_upgrade.png }}
+  - Click on //Management// item and select //Gateways// item
+  - Select your gateway,
+  - Choose //Configurations//
+  - Choose //Software//
+  - Move your file in the drag and drop area in the right part of the page.
+{{ :wiki3:software_upgrade_dragndrop.png?800 |}}
+\\
+\\
 ==== WMC workflows ====
-The workflows can be used to install software on many gateways at once.
+The workflows can be used to install software on several gateways at once.
+Note that you should be connected to the WMC to use this feature.
 <note warning>
-Never install an OpenVPN package using workflows.
+**Never install an OpenVPN secret package using Workflows.**
-Indeed, each OpenVPN package is unique and should never be deployed on several gateways.
+Indeed, each OpenVPN secret package is unique and should never be deployed on several gateways.
 </note>
 To upgrade several gateways:
-  - Add all the desired gateways to your cart.
+  - Click on //Workflows// from the main menu on the left side of the page to pull down the hidden menu
-  - Go to your cart.
+  - Select //Templates//
-  - Choose the //Execute workflow// action from the top menu.
+  - Click on the //+// to select the workflow template to use
-  - Pick the //FW upgrade// workflow.
+  - Select the Category: //Gateways//
-  - Choose the software package and execute the workflow.
+  - Drag and Drop the "updateGateways Firmware" template from "Available" window to "Selected" window
+  - Give a name to your workflow: ex updateGateways
+  - Click on //Management// item
+  - Click on //Gateways// item
+  - Click on the Cart icon on the left side of each line to add all the desired gateways to your cart (take care to group the same type of gateway: Wirnet iBTS or Wirnet iFemtoCell or Wirnet Station)
+  - Select the Cart "Selection" at the upper side of your page
+  - Choose the //Execute workflow// tab from the top menu.
+  - Pull down the menu and pick up the //updateGateways// workflow you have just created
+  - Choose the software package to download and execute the workflow by clicking the ''START'' button
-{{ images:bsc_stations_workflow_sw_upgrade.png }}
+{{ :wiki3:workflow_select_template_3x.png?600 |}}
+{{ :wiki3:software_upgrade_workflow_3.x.png?800 |}}
-==== USB/SSH or install from scratch ====
+\\
+\\
+==== Upgrade or Install from scratch ====
 For USB and SSH install and upgrade instructions, please find below an outlook of the procedures below.
@@ Line 153: / Line 138: @@
 For detailed instructions, please refer to product specific documentation:
-  * [[http://wikikerlink.fr/lora-station/doku.php?id=wiki:resources|Wirnet Station]]
+  * [[http://wikikerlink.fr/lora-station/doku.php?id=wiki:updates|Wirnet Station]]
   * [[http://wikikerlink.fr/wirnet-ibts/doku.php?id=wiki:sw_updates|Wirnet iBTS]]
   * [[http://wikikerlink.fr/wirnet-ifemtocell/doku.php?id=wirnet-ifemtocell:software_updates|Wirnet iFemtoCell]]
 </note>
+\\
+\\
 === Wirnet Station ===
+\\
-  * For SSH: place the megapackage in ''/mnt/fuser-1/dota'' and reboot the device. Repeat for the OpenVPN ''.tar.gz'' package.
+* ** SSH (advanced user):**
-  * For USB: place the megapackage on your USB stick, and add the ''produsb.sh'' file. Plug the USB stick and wait for a few minutes.
+      * Installation from scratch
+<code>
+. 	Copy the OpenVPN package in the /mnt/fuser-1/dota directory
+. 	Reboot the gateway
+. 	Wait the OpenVPN package installation
+. 	Copy the megapackage in the /mnt/fuser-1/dota directory
+. 	Reboot the gateway
+</code>
+      * Upgrade
+<code>
+. 	copy the megapackage in the /mnt/fuser-1/dota directory
+. 	reboot the gateway
+</code>
+\\
+* **USB:**
+        * Installation from scratch
+ <code>
+. 	copy the OpenVPN package on your USB stick
+. 	copy the produsb.sh file on your USB stick.
+. 	Plug the USB stick on the gateway
+. 	Wait for a few minutes that upgrade ends.
+. 	remove the USB stick from the gateway and erase the content.
+. 	copy the megapackage on your USB stick
+. 	copy the produsb.sh file on your USB stick
+. 	Plug the USB stick on the gateway
+.  	Wait for a few minutes that upgrade ends.
+</code>
+       * Upgrade
+<code>
+. 	copy the megapackage on your USB stick
+. 	copy the produsb.sh file on your USB stick
+. 	Plug the USB stick on the gateway
+. 	Wait for a few minutes that upgrade ends
+</code>
+\\
 === Keros systems (Wirnet iBTS and Wirnet iFemtoCell) ===
-If the software is in a megapackage, please uncompress it first:
+Only ipk files can be used.
+If the megapackage is a .tar.gz file, please uncompress it to extract ipk files with the following command:
 <code bash>
@@ Line 174: / Line 201: @@
 Then,
-  * For SSH: place the ''.ipk'' files in ''/user/.updates''. If your system is pristine, you might need to create the folder: run ''mkdir -p /user/.updates'' to ensure it exists.
+* **SSH:**
-  * For USB: place the ''.ipk'' files on the USB stick. Place the ''usb.autorun'' and ''usbkey.txt'' files and plug the USB stick. Once the LED starts blinking, remove the USB stick and wait for a few minutes.
+<code>
+. Create the updates folder: mkdir -p /user/.updates
+. Copy the .ipk files in /user/.updates/
+. In the case of a first install,  copy the OpenVPN package(s) in /user/.updates/
+. Run "sync" command
+. Trigger the upgrade: kerosd –u
+. Reboot the gateway
+</code>
+* **USB:**
+<code>
+. Copy .ipk files, openVPN package in the case of a first install
+. Copy the usb.autorun and usbkey.txt files on the root directory of the USB stick
+. Plug the USB stick to the gateway.
+. Once the LED starts blinking, remove the USB stick and wait the end of upgrade (2').
+</code>
+\\
+\\
+===== Checking packages installation =====
+==== Wirnet iBTS and Wirnet iFemtoCell ====
+Use the following command to check the currently installed packages (example shows iBTS):
-Example for SSH:
 <code bash>
-# Run on the gateway
+root@klk-lpbs-123456:~ # opkg list-installed
-mkdir -p /user/.updates
+bscc - v3.0.11                                   # <------ BSCC package version
+kerlink-openvpn-config-pki2-klk-lpbs-060337 - 1.11-181221
+keros - 3.4.5-0-g1d8781c3
+libloragw2-fpga - 5.1.0-klk5
+lorasnmp - v3.0.11                               # <------ SNMP package version
+spf2 - 5.1.0-klk4_5.1.0-klk5
+zconf-delete-gatewayid-lpbs - 1.0
+</code>
-# Run on your computer
+==== Wirnet Station ====
-scp *.ipk root@ip_address_of_gateway /user/.updates/    # upload ipk files to gateway
-# Run on the gateway
+<note warning>**DO NOT USE THE MEGAPACKAGE IF YOUR FIRMWARE VERSION IS LOWER THAN v3.1**</note>
-sync
-kerosd -u
-reboot
+Gateways running firmware « wirmaV2_wirgrid_v2.x » must be migrated to version « wirmaV2_wirnet_v3.1 »  using the script ''[[http://wikikerlink.fr/lora-station/doku.php?id=wiki:resources_wirnet_v_3.1|create_dota_2x_wirnet3.sh]]'' .
+Megapackage installation is only supported on firmware version « wirmaV2_wirnet_v3.1 » and upper.
+Firmware version can be found in the result of the command « get_version -u –v »  via SSH or debug probe (see below).
+<code bash>
+[root@Wirnet_080E0761 ~]# get_version -u -v
+KERNEL_VER=3.10.104-3.10.104-klk7
+PIC_VER=8.3
+BOOTSTRAP_VER=""
+UBOOT_VER="U-Boot 2009.03-2009.03-klk1 (Jan 26 2018 - 12:04:27)"
+SCRIPT_VER=v1.0
+INITRAMFS_VER=v1.3
+FILESYSTEM_VER=2016.05v1.10
+KNETD_VER="wirma2_v4.09 WAN_3.16 (Dec 23 2016-14:33:40)"
+PROD_FW=wirmaV2_wirnet_v3.1
+LORABOARD_MANUFACTURER=00
+LORABOARD_TYPE="868-27dBm"
+LORABOARD_HWVERSION=05
+LORABOARD_SERIALNO=000E3F
+************************ Update log ************************
+.03.05-17:17:55 -- Dota dota_RAN_gateway_v3.0.10_5e546851-f7a3-4881-a905-03a937a8d7e4.tar
+.03.05-17:18:54 -- Dota custo_libloragw-fpga_4.1.3-klk8_wirnet.tar
+.03.05-17:19:05 -- Dota custo_openvpn.tar
+.03.05-17:19:10 -- Dota dota_packages_v3.0.10.tar
+.03.05-17:20:07 -- Dota custo_libloragw-fpga_4.1.3-klk8_wirnet.tar
+.03.05-17:20:18 -- Dota dota_spf_3.1.0-klk16_4.1.3-klk8_wirnet.tar
+.03.05-17:20:26 -- Dota dota_v3.0.10_bscc.tar                        # <---- BSCC package version
+.03.05-17:20:33 -- Dota dota_v3.0.10_snmp.tar                        # <---- SNMP package version
+************************************************************
+[root@Wirnet_080E0761 ~]#
 </code>
-===== Declaration ======
+Firmware version verification can be done by checking the trustable field « FILESYSTEM_VER ».
+  * FILESYSTEM_VER=2016.05v1.5 => firmware wirmaV2_wirnet_v3.1
+  * FILESYSTEM_VER=2016.05v1.10 => firmware wirmaV2_wirnet_v3.3
+  * FILESYSTEM_VER=2016.05v1.13 => firmware wirmaV2_wirnet_v3.6
+\\
+\\
+===== Dashboard Gateway declaration ======
-For a first time install, the gateway must be declared on the dashboard. Please refer to the [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:administration#manage_data|administration documentation]].
+For a first install, the gateway must be declared on the dashboard. Please refer to the [[http://wikikerlink.fr/wanesy-ran/doku.php?id=wiki:administration#manage_data|administration documentation]].

Wanesy™ Management Center (End Of Life)

User Tools

Site Tools

Differences

Page Tools