Wavestore as an Application: install instructions
Introduction
Traditionally Wavestore is provided as an embedded system with both hardware and software.
But it can also be supplied as an application to run on a customer-supplied Linux system, this is referred to as Wavestore as an Application (WaaA).
Note that in both cases it will be necessary to purchase a licence to use the system.
The Wavestore Venus V6 server is called "venusd". It usually runs as user "dvr" and uses a program called "venusexec" to provide privilege escalation when running system scripts from /usr/share/venusd.
Packages required
The currently supported platform is el8: Red Hat Enterprise Linux 8, Alma Linux 8 or similar. (Installation has been tested with Alma Linux 8.8). Wavestore as an Application does not supply an SELinux policy, so SELinux should be disabled. From Wavestore V6.48 the supported platform will be el10.
The following packages are provided by Wavestore and need to be installed:
- venusd venusd-profile venusd-exec venusd-text venusd-services venusd-devices
and (if desired):
- venusd-repo
plus dependencies from venusd repo:
- libcpet fdk-aac
plus dependencies from EL8 repo (over the packages in the minimal install):
- alsa-lib libjpeg-turbo
Note:
- venusd-services is a Wavestore-as-an-Application specific package, comprising service files which we want for Wavestore as an Application.
- venusd-repo is optional. It contains repository information for dnf to pull down the other rpms for Wavestore as an Application.
This section only covers server requirements, not client requirements. It is suitable for installation of a server-only system where the client runs on another machine.
Installing using dnf
Installation instructions:
- Install EL8 minimal installation (AlmaLinux-8.8-minimal has been tested)
- Install Wavestore venusd packages:
sudo rpm --import https://files.wavestore.com/public/repos/wavestore/RPM-GPG-KEY-Wavestore6 sudo rpm -i https://files.wavestore.com/wavestore/venusd-repo.rpm sudo dnf install venusd venusd-profile venusd-exec venusd-services venusd-text venusd-devices
The first line, importing the key, is optional. If you omit it, a warning message will appear when you first install venusd-repo, but it will install successfully, and the key will be installed when you use dnf to install the remaining packages.
Note that venusd-repo.rpm is a link to the most recent release of venusd-repo, for example venusd-repo-6.36.1.rpm.
To keep it up to date (same release, for example 6.36), do:
sudo dnf upgrade
To upgrade to the next release (for example 6.36 to 6.38), do:
sudo dnf install https://files.wavestore.com/wavestore/venusd-repo.rpm --refresh sudo dnf upgrade
Typical install:
$ sudo rpm --import https://files.wavestore.com/public/repos/wavestore/RPM-GPG-KEY-Wavestore6 $ sudo rpm -i https://files.wavestore.com/wavestore/venusd-repo.rpm $ sudo dnf install venusd venusd-profile venusd-exec venusd-services venusd-text venusd-devices ================================================================================ Package Arch Version Repository Size ================================================================================ Installing: venusd x86_64 6.35.597-LASS.el8 venusd 1.6 M venusd-exec noarch 6.35.59-1.el8 venusd 51 k venusd-profile noarch 6.26.0-1.el8 venusd 8.6 k venusd-services noarch 6.35.0-1.el8 venusd 8.8 k venusd-text noarch 6.34-4 venusd 244 k venusd-devices noarch 6.34.49-1.el8 venusd 12 k Installing dependencies: alsa-lib x86_64 1.2.8-2.el8 appstream 495 k fdk-aac x86_64 2.0.0-3.el8 venusd 683 k libcpet x86_64 6.28.2-0.el8 venusd 34 k libjpeg-turbo x86_64 1.5.3-12.el8 appstream 156 k Transaction Summary ================================================================================ Install 10 Packages Total download size: 3.2 M Installed size: 8.6 M Is this ok [y/N]:
Installing using rpm
- Install EL8 minimal installation
- Install prerequisite rpms (alsa-lib libjpeg-turbo) from EL8
- Obtain the list of rpm files needed from https://files.wavestore.com/wavestore/<version>/repodata/aupgrade.txt where <version> is the release version you want. For example, https://files.wavestore.com/wavestore/6.36/repodata/aupgrade.txt
- Pull down the rpm files from https://files.wavestore.com/files.wavestore.com/wavestore/<version>/<file> which you can do one by one using a browser, or automate by using a script. Alternatively you can find them on the Wavestore release ISO
- Install the venusd files using rpm -i or rpm -U
A simple Linux script to obtain the list of files and download them:
VER=6.36; curl https://files.wavestore.com/wavestore/$VER/repodata/aupgrade.txt | while read FILE; do curl -o $FILE https://files.wavestore.com/wavestore/$VER/$FILE done
Starting the service
Use the package manager, systemctl, to start and enable the venusd service:
sudo systemctl start venusd sudo systemctl enable venusd
Log into venusd using WaveView to complete setup.
Older versions and test versions
If desired to install a version other than the latest release, we offer multiple venusd-repo files, one for each alpha, beta and release version in the appropriate directory.
Note that if you wish to switch between versions, it will be necessary to use -U with --oldpackage:
sudo rpm -U --oldpackage https://files.wavestore.com/wavestore/alpha6.35/venusd-repo.rpm sudo rpm -U --oldpackage https://files.wavestore.com/wavestore/beta6.35/venusd-repo.rpm sudo rpm -U --oldpackage https://files.wavestore.com/wavestore/6.36/venusd-repo.rpm
Considerations for Time and NTP
Wavestore as an Application (venusd) does not control the system time. The system time should be correct and increase steadily while venusd is running and must never jump.
In order to ensure the time is correct, steadily increasing and never jumping, a system like cronyd should be configured. Unlike ntpd or systemd-timesyncd (which are not recommended), chronyd is good at slewing rather than jumping, but attention should be paid to two cases:
- If desired to jump the time on start-up, the initstepslew parameter can be configured. Ensure that this happens before venusd starts.
- Do not allow jumping over leapseconds. Configure leapsecmode to slew or ignore. Note that these two options are very similar and slew when a leap second is encountered. Do not leave this as the default, which will jump the time.
leapsecmode ignore
Certificates for HTTPS connections
If you are intending to use HTTPS or other TLS protocols including Wavestore protocol 5 then a certificate (certificate.pem) and private key (privatekey.pem) should be generated and placed in directory /etc/ssl/certs (which is usually a link to /etc/pkt/tls/certs). The private key should be readable by the dvr user.
You can use any method to generate the private key and sign it. The following command will generate a self-signed key and a certificate which is valid for 10 years:
mkcertificate
This will perform:
cd /etc/ssl/certs
/bin/openssl genrsa -out privatekey.pem 3072
/bin/chown dvr.dvr privatekey.pem
/bin/chmod 400 privatekey.pem
echo -e "\n\n.\nDVR\n\n\n" | /bin/openssl req -new -x509 -key privatekey.pem -days 3650 -out certificate.pem
Note that the mkcertificate command is in venusd-services 6.44.2 and later.
System Disk
The system disk identity is used as part of the Machine ID. The system disk is identified using /dev/root. Some systems do not set /dev/root or set it to some unsuitable value like dm-0. If this is not set, it will attempt to choose a system disk by another means. From 6.44 it is likely that no manual action will be needed, as incorrect /dev/root entries (for example, ones linked to dm-0) are automatically removed and replaced by one which appears more suitable (for example, /dev/sda). You can see what it's linked to using
ls -l /dev/root
If you need link the system disk to /dev/root manually, for example if the system disk is /dev/sda, execute :
ln -s /dev/sda /dev/root
GStreamer-Plugins-Bad
Two modified rpms are provided: GStreamer-Plugins-Bad*.rpm available these are available in the AppStream repo from Wavestore. If these clash with files provided by your distribution you should exclude them from your distribution's standard AppStream repos using:
excludepkg=gstreamer1-plugins-bad*
Libnice and Libwebsockets
The install requires libnice and libwebsockets which come from the epel repo. You will need this enabled.
Advanced Configuration: Configuring Storage Devices
Wavestore assigns letters to disk drives which are to be used by Wavestore. This assignment is done in the WaveView Storage Setup Screen. The status of these disks can also be viewed in the same screen.
The list of disk drives shown on the WaveView Storage Setup Screen can be found automatically using the normal get-disks script, however it is often desirable to customise it for your OS requirements: if so, add a file (which must be executable, +x):
/usr/share/venusd/EXEC/disks.sh
which outputs the full paths of disk drives to be shown to the user, one per line. This can ensure the disks screen shows the correct devices only, includes disks which are not usually detected by this normal script, and does not confuse the user with invalid disks.
Example disks.sh:
#!/bin/sh ls /dev/sd*
This disks.sh script can be used on Amazon AWS systems: the if-condition removes system disks and partitions:
#!/bin/sh
/bin/ls /dev/sd* | /bin/sort | while read A
do
if [ -e ${A}1 ] || [ $A != "${A%[1-9]}" ]; then
A=""
else
echo $A
fi
done
Alternatively, the relevant disks can be listed explicitly in disks.sh:
#!/bin/sh echo /dev/mmc1
Remember to chmod +x disks.sh and it should be owned by root or by dvr user.
Network Storage Devices
Network storage devices like NFS or iSCSI should be mounted as network drives using OS tools. Then the network drives should be included in the disk list using one of the methods described above for the Wavestore to use.
Hardware RAID arrays
RAID arrays should be configured as using OS or BIOS tools and then the array should be included in the disk list using one of the methods described above for the Wavestore to use.
HyperRAID arrays
If you wish to configure HyperRaid arrays using Wavestore as an Application then remember you are responsible for mapping the drives to appropriate slot numbers so they can be identified when they fail. Note that LEDs showing which drive has a fault might not work. For this reason, HyperRaid is not recommended when using Wavestore as an Application.
Advanced Configuration: SNMP
In order to get the Wavestore SNMP items (on 1.3.6.1.4.1.39487.1 in the WAVESTORE-MIB) included in your SNMP output, you need to add
pass_persist .1.3.6.1.4.1.39487.1 /usr/bin/vsnmp
to your snmpd.conf file. The vsnmp program is supplied as part of the venusd rpm.
Advanced Configuration: Configuring Failover Floating Network Address
Wavestore in Embedded System mode controls the network interfaces, and allows a secondary "floating" address to be configured for Failover which will be attached to the logical machine and will move when the logical machine fails over.
Wavestore as an Application does not manage network interfaces. If desired to configure a floating address for Failover, some work is needed.
A parameter in [Failover] section called FloatingIf= should be configured with the interface name of the floating address. This will be used when the floating address is to be disabled, and an ioctl(SIOCSIFADDR) will be called to reset the address to 0.0.0.0 which will disable the interface. This is executed as a direct ioctl() to allow the old address to be instantly withdrawn when needed.
A script /usr/share/venusd/networkfua.sh should bring this floating address up on the desired interface. This is run as an external program to allow more flexibility in the setup. It should wait and retry for up to 10 seconds to ensure the interface is up before returning. It is recommended to send additional gratuitous arp packets after bringing the network up to ensure all clients have noticed the change. A script is provided in the venusd rpm called /usr/share/venusd/networkfu.sh which will can be copied to networkfua.sh with appropriate modifications so it performs the desired actions.
Note that these are optional. If not configured then only the primary addresses will be used, and users will need to log into the standby machine manually if a failure occurs.
Note on Linux kernel networking functions: The kernel seems to support both (a) secondary addresses using the xxx:1 notation and (b) by adding another address to interface xxx without giving it a separate :1 name. If we are to bring it down using SIOCSIFADDR then it needs to have a unique name like xxx:1. It is therefore important to set it up with the unique name. Note that "ip addr add" will add the new address to the interface without giving it a unique name.
Advanced Configuration: optional items
Default configuration
If desired, it is possible to allow the "Load Default Configuration" button on the WaveView client to load some useful default. Write this file to /home/dvr/venusd-default.conf. If this file is missing, a null configuration file will be loaded when you "Load Default Configuration", without any users configured.
Identifying and Maintaining WaaA using WaveView
When logging in using WaveView, the Setup > General screen will show Wavestore Name, Status, Version and Build fields, but will not show Distribution or Motherboard fields for a Wavestore as an Application system. It will offer the Restart button to restart the application, but not the Reboot or Shutdown buttons which are system features and only available via WaveView on the embedded systems. Some items in the Setup screens, such as Upgrade and other system features, will be not be available via WaveView for Wavestore as an Application. System maintenance must be carried out using Linux system tools.