Upgrade to 2.0+ process¶
Upgrading from a previous Early Access release to a 2.0+ Early Access release is a major upgrade that includes file location changes and re-configuration of some features.
Server Upgrade¶
This details the process to upgrade a hub server.
Preparation¶
The recommended upgrade process to version 2.0 and later is to do a full uninstall and re-install. This will require some manual effort to migrate configuration and data to the new installation directory.
Before any upgrade, it is a sensible precaution to backup the hub. To avoid any data loss, ensure that all users log out from the hub, including those logged in to the hub portal from a browser and those logged in from Altair Analytics Workbench.
First stop the hub and all workers using the command on each machine
hubctl service stop
Backup the database¶
It is recommended that the database is backed up following your standard recovery procedures.
If backup procedures are not in place yet, the PostgreSQL utility pg_dump can be used to do this. The details for the database connection can be found using the hubctl command:
hubctl config print database
Backup all configuration¶
Backup all configuration, by taking a copy of the /etc directory e.g.
tar cvf HubConfigBackup.tar /opt/worldprogramming/wpshub-c/etc
Backup S3 storage¶
It is recommended that the S3 storage is backed up following your standard recovery procedures.
If the server is running a local MinIO object store it may be backed up directly by copying the folder, for example:
cp -r /opt/worldprogramming/wpshub-c/var/minio <minio-backup-location>
<minio-backup-location> is a location outside /opt/worldprogramming/wpshub-c/.
Update¶
The First step is to uninstall the old version of Altair SLC Hub with the following command:
sudo dnf remove -y wpshub-*
The next step is to install Altair SLC Hub. Download the new RPM and copy on to the machine as with a fresh install see more.
sudo dnf install -y swhub
cp -r /opt/worldprogramming/wpshub-c/etc /opt/altair/swhub/
Also, move the license file to the new location
mv /opt/worldprogramming/wpshub-c/var/licence.txt [var directory]/licence.txt
Ensure any temporary shared memory file, which may now have incorrect file permissions is removed.
rm /dev/shm/envoy_shared_memory_0
MinIO¶
If the system previously made use of the wpshub-minio-cfg package for setting up a MinIO instance, this package is no longer supported and MinIO setup should be performed to configure a S3 bucket.
It is possible to move the existing data and configure MinIO to serve this directory, or to configure a MinIO instance to serve the existing data directory.
Instructions on installing and configuring MinIO locally for use by Hub are available in the Altair Community.
When migrating it is important to ensure the user MinIO is running under has access to the data directory by setting the permissions:
chown -R [MinIO user] <Directory Name>
chgrp -R [MinIO user group] <Directory Name>
etc/config.d/s3_custom.yaml config file
Postgresql¶
Early versions of Altair SLC Hub allowed installation of wpshub-postgres and wpshub-postgres-repo to provide a simple database setup for use in evaluations. This was deprecated in previous versions of Altair SLC Hub. These are no longer supported and the postgres database should be setup as a pre-requisite of an Altair SLC Hub install, more info here.
Configure HTTPS¶
If HTTPS was previously configured, file ownership of the certificate and key used for external ingress will need to be updated to ensure the updated hub has access, for example:
sudo chown swhub-ingress cert.pem key.pem
Migrate¶
Next make sure the database server is running. Use the hubctl command to perform any necessary database migration and bootstrapping, and then to start the updated Hub services:
hubctl bootstrap
hubctl service start
Worker Upgrade¶
This details the process to upgrade a hub worker. Each worker node should be upgraded.
Preparation¶
The worker services should have been stopped in a previous step with
hubctl service stop
The steps are similar to the server steps. It is a sensible precaution to back up the configuration files, for example:
tar cvf HubConfigBackup.tar /opt/worldprogramming/wpshub-c/etc
Update¶
Uninstall the old version of Altair SLC Hub with the following command:
sudo dnf remove -y wpshub-*
The next step is to install Altair SLC Hub worker RPM. Copy the downloaded file onto the machine and install using dnf:
sudo dnf install -y swhub-worker_<version>-1.rpm
cp -r /opt/worldprogramming/wpshub-c/etc /opt/altair/swhub/
wps_installs.yaml file to slc_installs.yaml
mv /opt/worldprogramming/wpshub-c/etc/wps_installs.yaml [etc directory]/slc_installs.yaml
hubctl command to start the updated Hub services:
hubctl service start
Migrate to new features¶
Link Session configurations¶
Any Link Session configurations that have been defined under /opt/worldprogramming/wpshub-c/etc/linksessionmgr.d/ will need to be recreated as Execution Profiles in Hub.
Operating System Users¶
The concept of "default users" has been removed. Any previous configuration will be ignored. This may mean some configuration is required where a local user needs to run a workload. See Operating System Users for details on configuration options
Namespaces and Execution Profiles¶
Altair SLC Hub contains new features to provide separation, Namespaces, and to enable controlling where jobs are run, Execution Profiles. Users desiring to make use of these features should read these sections and update their configuration as desired.