Upgrading EAMs avoiding RSYNC on the private network

If your EAM, DM24SxEAM or *TDE instrument has a slow or intermittent network connection, there is a possibility of problems occurring during a firmware upgrade. In rare cases, the system can potentially become unusable when an upgrade takes a significantly long time or is interrupted. To guard against this, it is possible to download a mirror copy of the firmware onto the file-system of the EAM itself. It can then upgrade itself using this copy as the upgrade source. The process is essentially identical to using a local mirror site with the exception that it uses the device itself as its own mirror server.

The easiest way to do this is using rsync (see the Upgrading Platinum Systems With Unreliable Internet Connections page) but these instructions are specifically aimed at applications where rsync is to be avoided on the private network. Instead, tar and ssh are used to transfer a firmware image to the target system using a technique known as a tar-pipe. The source of the image to be transferred can be built using rsync or acquired directly from Güralp Systems on a USB stick.

The target system must have access to the network while the tarpipe is running but it does not need network access while it is actually upgrading. If the download process is interrupted, it can be easily restarted. The operation of the target system is not affected during the download (other than by creating a bandwidth requirement) so this process can safely be repeated until it has completed successfully.

Platinum systems use the rsync protocol to update their firmware to the latest revision. rsync is an extraordinarily flexible tool but it can be rather complex. The upgrade script on an EAM or other Platinum system is a front-end to rsync which is used to hide this complexity and ensure the safe use of the protocol. The source for the rsync transfer is normally the Güralp rsync server; in this instance, it will be a local image in the target device's file-system: i.e. the device will function as its own mirror server. In this way, while the rsync protocol is still used, it is not used over the network.

Upgrading a Platinum system using itself as its own upgrade mirror involves five steps:

The procedure is slightly different for systems with different architectures so the instructions have been split into three. This page only covers EAMs, DM24SxEAM and *TDE instruments. If you are attempting to upgrade a MkⅡ NAM or Affinity, please select one of the links below:

Acquiring the mirror content

The mirror content must first be transferred to a Linux PC or server. (Windows file-systems do not support the necessary file attributes.) If the Linux server can be connected to the Internet, commands similar to those below can be used to acquire a copy of the firmware.

sudo adduser -a ptmirror sudo mkdir ~ptmirror/platinum-stable cd ~ptmirror/platinum-stable GSLSRC=rsync.guralp.com/platinum-stable/CMG-DCM-mk4-eabi sudo rsync -EgHloprtv --exclude resolv.conf rsync://$GSLSRC .

If, instead, the image has been delivered on a USB stick, mount the stick on, say, /mnt and enter commands like these:

sudo adduser -a ptmirror MODULE=platinum-stable/CMG-DCM-mk4-eabi sudo mkdir -p ~ptmirror/$MODULE cd ~ptmirror/$MODULE sudo rsync -EgHloprtv --exclude resolv.conf /mnt/$MODULE/ .

The server created in this step will be referred to as mirrorhost in the commands below. You should substitute the appropriate DNS name or IP address in each command where you encounter this.

Problems?

The most common problems experienced at this stage are:

rsync reports “Temporary failure in name resolution

If you see error messages like

rsync: getaddrinfo: rsync.guralp.com 873: Temporary failure in name resolution rsync error: error in socket IO (code 10) at clientserver.c(122) [receiver=3.0.2]

it means that the Domain Name Service (DNS) client is misconfigured. If you are running DHCP, this may be a problem with your DHCP server not providing the address of a nameserver (or providing an incorrect one). If you are using static addressing, check and correct the nameserver using the net-setup tool.

rsync reports “Network is unreachable

If you see error messages like

rsync: failed to connect to rsync.guralp.com: Network is unreachable (101) rsync error: error in socket IO (code 10) at clientserver.c(122) [receiver=3.0.2]

it means that the network routing is misconfigured. If you are running DHCP, this may be a problem with your DHCP server not providing a default route (or providing an incorrect one). If you are using static addressing, check and correct the default route using the net-setup tool.

rsync reports “rsync error

If you see error messages like

rsync error: received SIGINT, SIGTERM or SIGHUP (code 20) at rsync.c(541)

it means that, most probably, a firewall is blocking traffic on the rsync port. Ask your network administrator to permit the Linux PC to open TCP connections to host rsync.guralp.com on port 873.

Transferring the mirror content to the target system

It is essential to ensure that sufficient space is available before starting the transfer.

The mirror content occupies a significant amount of disk space, so it is important to check the available space before proceeding. To check the space available, log on to the command line of your target system and type the command

df -h

The output will normally consist of a table with one line of content, such as:

EAM1234 ~ # df -h Filesystem Size Used Available Use% Mounted on /dev/root 512.0M 190.3M 321.8M 37% / EAM1234 ~

If more than one line is displayed, look for the row where the value in the Mounted on column is "/". The free space is shown in the Available column of the same row. In the example above, it is 321.8 MB

These systems require around 70 MB of free space to store the upgrade image. Only proceed if you have enough space.

The current firmware build version must be greater than 10,000. To discover the build version, enter the command:

cat /etc/build.version

The output will look like

# Overall build version BUILD_LABEL="platinum-stable" BUILD_VERSION="15757"

In this case, the build version is 15757. If the current build version is below 10,000, please contact for advice.

The firmware image is pushed from mirrorhost to the target system in tar format over an ssh pipe. If you do not have ssh keys set up, you will be prompted for a password: use the normal root password that you would use to log on to the command line of your system. If you have ssh keys configured, you should not be prompted.

From the command line of the mirrorhost, enter the following commands:

cd ~ptmirror/platinum-stable MDIR=/home/Pt-firmware-mirror.local/ tar c CMG-DCM-mk4-eabi/ | ssh root@targetEAM "mkdir $MDIR && cd $MDIR && tar xv"

The most common problems experienced at this stage are:

ssh reports “Name or service not known

If you see error messages like

ssh: Could not resolve hostname example.com: Name or service not known lost connection

this means that the Domain Name Service (DNS) client is misconfigured or has not been told about your target system. The easiest solution is to use the target system's IP address in place of its hostname.

ssh reports “Network is unreachable

If you see error messages like

ssh: connect to host example.com port 22: Network is unreachable

this usually means that the networking on the target system is not configured properly: often the system is on the wrong logical network. If the system is intentionally on a different network to the mirrorhost, this error means that the network routing on mirrorhost is misconfigured. If you are running DHCP, this may be a problem with your DHCP server not providing a default route (or providing an incorrect one). If you are using static addressing, check and correct the default route using the net-setup tool on the target system or the ip route command on the mirrorhost.

ssh reports “Connection refused

If you see error messages like

ssh: connect to host example.com port 22: Connection refused

this means that the ssh server is not configured correctly on the target system. Review the server settings or contact for assistance.

Setting up the target system as an rsync server

The target's rsync server is configured by creating the file /etc/rsyncd.conf using the following commands:

cat >/etc/rsyncd.conf <<EOF port = 873 [platinum-local-mirror] path = /home/Pt-firmware-mirror.local comment = Platinum firmware numeric ids = yes log file = /var/log/rsync.log timeout = 600 hosts allow = 127.0.0.0/8 uid = 0 gid = 0 EOF

Once the /etc/rsyncd.conf file is in place, you should start the rsync server with the command

rsync --daemon

Configuring the target system to use its local server

Create the file /etc/conf.d/upgrade.local using the following commands:

cat >/etc/conf.d/upgrade.local <<EOF RSYNC_HOST="127.0.0.1" RSYNC_PORT="873" RSYNC_MODULE="platinum-local-mirror" RSYNC_ADDITIONAL_OPTS="--no-delay-updates --delete-during" EOF

Perform the upgrade

The system can now be upgraded by using the upgrade command. Once the upgrade has completed successfully, the system should be rebooted, either by using the web interface or, from the command-line, with the command reboot

The upgrade will remove the /etc/rsyncd.conf file and the reboot will halt the rsync server so, if the upgrade is to be repeated for any reason, you will need to repeat the steps listed under Setting up the target system as an rsync server".
For more information, first contact your local distributor or email .