Single Server Upgrade

Kasm Tech recommends installing a separate instance of the application, migrating the data and performing a cutover of the application Please read through the document fully before beginning the process.

Create a Database Backup

Backup the existing Kasm database. This can be saved for later recovery, but will also be used to migrate existing data to the latest version.

  • Stop existing Kasm Services

sudo /opt/kasm/bin/stop

  • Download and extract the new installation media

cd /tmp
curl -O <release url>
tar -xf kasm_release_*.tar.gz

  • Execute the included database backup utility

sudo bash kasm_release/bin/utils/db_backup -f /tmp/kasm_db_backup.tar -p /opt/kasm/1.5.0/

  • Get the existing database password for use in the subsequent commands.

sudo grep password /opt/kasm/current/conf/app/api.app.config.yaml

Perform a clean install

  • Install kasm from the release media downloaded in the prior steps.

sudo bash kasm_release/install.sh -D -Q <DATABASE_PASSWORD>

Modify Configs

  • Copy the server_id and the public_hostname properties from the old agent to the new

grep server_id /opt/kasm/1.5.0/conf/app/agent.app.config.yaml
grep public_hostname /opt/kasm/1.5.0/conf/app/agent.app.config.yaml
sudo vi /opt/kasm/1.6.0/conf/app/agent.app.config.yaml

  • Copy manager_id and server_hostname from the old configuration into the new

grep manager_id /opt/kasm/1.5.0/conf/app/api.app.config.yaml
grep server_hostname /opt/kasm/1.5.0/conf/app/api.app.config.yaml
sudo vi /opt/kasm/1.6.0/conf/app/api.app.config.yaml

  • Copy the auto-generated nginx configs for any Kasms that may exists on the Agent

sudo cp /opt/kasm/1.5.0/conf/nginx/containers.d/* /opt/kasm/1.6.0/conf/nginx/containers.d/

Restoring the Database.

Restore and update the database from the prior version

  • Ensure all Kasm services are stopped

sudo /opt/kasm/bin/stop

  • Execute the database restore command

sudo /opt/kasm/current/bin/utils/db_restore -f /tmp/kasm_db_backup.tar -p  /opt/kasm/current

  • Perform an upgrade of the database schema

sudo /opt/kasm/current/bin/utils/db_upgrade -p /opt/kasm/current

  • Start the Kasm services

sudo /opt/kasm/bin/start

Update Default Images

Each release, the Kasm Technologies team updates the default images with security updates and improvements. If you are using the default images in your environment, it is recommend to update to the latest versions.

If you are running custom images, it is recommended to rebuild based of the latest kasmbweb/core image.

See Default and Custom Images for details.