wiki:sw_updates
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
wiki:sw_updates [2018/12/27 15:34] hch [Software update over Network] |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Software updates ====== | ||
| - | |||
| - | The KerOS Distribution supports OPKG packages (embedded version compatible with dpkg packages). | ||
| - | |||
| - | OPKG packages are used to install customer applications and firmware upgrades (the firmware is installed with an OPKG package). OPKG packages use the ''.ipk'' extension. It is strongly recommended to use OPKG packages to deploy binaries/applications since the backup mechanism relies on it. | ||
| - | |||
| - | A package can either be installed using the network or using a USB key. \\ | ||
| - | |||
| - | After each update, the file ''/user/.update'' is appended with the status of the update. Update status can be: | ||
| - | * OK | ||
| - | * PARTIAL | ||
| - | * FAILURE | ||
| - | |||
| - | Error code can be the following: | ||
| - | |||
| - | * ERROR (10) - Downgrade not allowed | ||
| - | * ERROR (11) - unknown error | ||
| - | * ERROR (12) - dependency issue | ||
| - | * ERROR (13) - incompatible architecture | ||
| - | |||
| - | Partial code corresponds to a successfull installation that has conflict in configuration files. \\ | ||
| - | This can cause a problem during an upgrade if the configuration files contain new field or value required by the updated software. The partial code warns the user that a manual modification of the configuration could be required, the list of the modified (and the location of the new ) configuration file being listed above the update status (shadow and hostapd in this example). | ||
| - | |||
| - | __Example:__ | ||
| - | |||
| - | <code> | ||
| - | cat /user/.update | ||
| - | 2017.12.01-14:55:18 -- Update from bscc_v1.13_klk_wifc.ipk: OK | ||
| - | 2017.12.01-14:55:19 -- Update from lorasnmp_v1.13_klk_wifc.ipk: OK | ||
| - | 2017.12.01-14:55:19 -- Update Status : updated 2, failed 0 , partial 0 result : OK | ||
| - | 2017.12.01-15:00:44 -- Update from lorasnmp_v1.12_klk_wifc.ipk: ERROR (10) | ||
| - | 2017.12.01-15:00:44 -- Update from toto_1.0.0_klk_lpbs.ipk: OK | ||
| - | 2017.12.01-15:00:44 -- Update Status : updated 1, failed 1 , partial 0 result : FAILURE | ||
| - | 2017.12.01-15:07:44 Existing conffile /user/rootfs_rw/etc/shadow is different from the conffile in the new package. | ||
| - | The new conffile will be placed at /user/rootfs_rw/etc/shadow-opkg. | ||
| - | Existing conffile /user/rootfs_rw/etc/hostapd.conf is different from the conffile in the new package. | ||
| - | The new conffile will be placed at /user/rootfs_rw/etc/hostapd.conf-opkg. | ||
| - | 2017.12.01-15:07:45 -- Update from keros_3.3-beta2-38-g12943bcb_klk-wifc.ipk: OK | ||
| - | 2017.12.01-15:07:45 -- Update Status : updated 0, failed 0 , partial 1 result : PARTIAL | ||
| - | 2017.12.01-15:12:18 -- Update from lorasnmp.ipk: OK | ||
| - | 2017.12.01-15:12:28 -- Update from keros.ipk: OK | ||
| - | 2017.12.01-15:12:28 -- Update from bscc.ipk: OK | ||
| - | 2017.12.01-15:12:28 -- Update Status : updated 3, failed 0 , partial 0 result : OK | ||
| - | 2017.12.01-15:12:28 -- Firmware restored from backup | ||
| - | </code> | ||
| - | |||
| - | <note warning> | ||
| - | Powering off a gateway during a major upgrade will brick it. | ||
| - | </note> | ||
| - | |||
| - | ===== Software update over Network ===== | ||
| - | |||
| - | The following example describes how to trigger an update over network. This example uses a package meant to upgrade the firmware, however, the steps are the same for any other package. | ||
| - | |||
| - | - Transfer the KerOS package corresponding to the new firmware in this directory: <code bash> | ||
| - | # From a computer: | ||
| - | scp keros_2.0.4.ipk root@<ip_address>:/user/.updates/ | ||
| - | </code> | ||
| - | - Ensure file is correctly written: <code bash>sync </code> | ||
| - | - Trigger Update for next reboot: <code bash>kerosd -u </code> | ||
| - | - Restart: <code bash>reboot</code> | ||
| - | - **This step is specific to firmware updates.** Check the firmware version in the file ''/tmp/sys_startup_status.json'' under the field ''sw_version''. | ||
| - | |||
| - | |||
| - | ===== Software update over USB ===== | ||
| - | |||
| - | The following example describes how to trigger an update over USB key. This example uses a package meant to upgrade the firmware, however, the steps are the same for any other package. | ||
| - | |||
| - | ==== Overview ==== | ||
| - | - Prepare a USB key with the following files: | ||
| - | * ''usb.autorun'': Auto executable script | ||
| - | * ''usbkey.txt'': USB password file | ||
| - | * ''keros_x.y.z.ipk'': the update package | ||
| - | - Plug the USB key on the CPU board. | ||
| - | - Wait for yellow debug led fast blinking. | ||
| - | - Unplug the USB key. | ||
| - | - Wait for CPU reboot. | ||
| - | - **This step is specific to firmware updates.** Chek the firmware version in the file ''/tmp/sys_startup_status.json'' under the field ''sw_version''. | ||
| - | ==== Specific files ==== | ||
| - | |||
| - | === usbkey.txt === | ||
| - | |||
| - | ''usbkey.txt'' is a security file. It includes the password of "usbuser" user. \\ | ||
| - | Find information about the usbuser password in the [[wiki:credentials|credential chapter]]. | ||
| - | |||
| - | In the case of consecutive updates on few boards, the ''usbkey.txt'' can include multiples passwords (limited to 100). Each password must be written on a new line. | ||
| - | |||
| - | Here is an example of this file for 4 different boards: | ||
| - | |||
| - | ++++ | ||
| - | File to download - usbkey.txt | | ||
| - | <file text usbkey.txt> | ||
| - | USBklkPassword | ||
| - | # Support for old firmware (< 1.5.0) | ||
| - | 020056_usbkey | ||
| - | 040001_usbkey | ||
| - | 092356_usbkey | ||
| - | </file> | ||
| - | ++++ | ||
| - | |||
| - | === usb.autorun === | ||
| - | |||
| - | ''usb.autorun'' is a script automatically executed by the board if the ''usbkey.txt'' file includes a correct password. \\ | ||
| - | Anything can be done in this script but here is an example used to deploy a new firmware or/and new packages: | ||
| - | |||
| - | ++++ | ||
| - | File to download - usb.autorun | | ||
| - | <file bash usb.autorun> | ||
| - | #!/bin/sh | ||
| - | |||
| - | USBDIR="`dirname $0`" | ||
| - | |||
| - | SYSLEDPATH="/sys/class/leds/yellow:debug/" | ||
| - | |||
| - | # | ||
| - | # Set default led behavior | ||
| - | # $1: trigger | ||
| - | # | ||
| - | # if trigger = timer : $2 = delay_on, $3 = delay_off | ||
| - | # | ||
| - | set_led() { | ||
| - | trigger="${1}" | ||
| - | on="$2" | ||
| - | off="$3" | ||
| - | |||
| - | if [ -d "${SYSLEDPATH}" ]; then | ||
| - | echo $trigger > "${SYSLEDPATH}/trigger" | ||
| - | case "$trigger" in | ||
| - | "timer") | ||
| - | echo ${on:=500} > "${SYSLEDPATH}/delay_on" | ||
| - | echo ${off:=500} > "${SYSLEDPATH}/delay_off" | ||
| - | ;; | ||
| - | "none") | ||
| - | echo ${on:=0} > "${SYSLEDPATH}/brightness" | ||
| - | ;; | ||
| - | *) | ||
| - | # Nothing to do | ||
| - | ;; | ||
| - | esac | ||
| - | fi | ||
| - | } | ||
| - | |||
| - | |||
| - | deploy_packages() | ||
| - | { | ||
| - | mkdir -p /user/.updates | ||
| - | for pkg in ${USBDIR}/*.ipk | ||
| - | do | ||
| - | cp ${pkg} /user/.updates/ | ||
| - | done | ||
| - | sync | ||
| - | } | ||
| - | |||
| - | # | ||
| - | # Force the system to put the packages immediatly in backup | ||
| - | # | ||
| - | force_backup() | ||
| - | { | ||
| - | touch /user/.updates/force_backup | ||
| - | sync | ||
| - | } | ||
| - | |||
| - | |||
| - | # | ||
| - | # Trigger update and reboot in $1 minutes (or 'now') | ||
| - | # | ||
| - | trigger_update() | ||
| - | { | ||
| - | REBOOT_TIMEOUT=$1 | ||
| - | |||
| - | kerosd -u | ||
| - | [ ${REBOOT_TIMEOUT:=0} -ne 0 ] && shutdown -r ${REBOOT_TIMEOUT} | ||
| - | } | ||
| - | |||
| - | |||
| - | ##################### | ||
| - | # MAIN | ||
| - | ##################### | ||
| - | |||
| - | # Set led On | ||
| - | set_led none 1 | ||
| - | |||
| - | # Deploy packages | ||
| - | deploy_packages | ||
| - | |||
| - | # Trigger Update | ||
| - | trigger_update | ||
| - | |||
| - | # Optional: Force the system to put the packages immediately in backup | ||
| - | #force_backup | ||
| - | |||
| - | # Prepare reboot after USB unplug | ||
| - | cat > /tmp/usbkey_remove << EOF | ||
| - | |||
| - | # Switch off Led | ||
| - | echo "none" > ${SYSLEDPATH}/trigger | ||
| - | |||
| - | # Reboot Now to get Update | ||
| - | reboot | ||
| - | EOF | ||
| - | |||
| - | # All is right, make Led blinking fast to notify User | ||
| - | set_led timer 100 100 | ||
| - | </file> | ||
| - | ++++ | ||
| - | |||
| - | ===== Update Process ===== | ||
| - | |||
| - | If a backup file exists : | ||
| - | * During upgrade => the backup file will be restored (eg Restore Configuration). | ||
| - | * Backup restore => the backup file will be restored (eg Restore Configuration). | ||
| - | * Stock restore => the backup file will be erased and factory configuration will be used. | ||
wiki/sw_updates.1545921275.txt.gz · Last modified: 2019/01/17 10:01 (external edit)
