Major Upgrade
For documentation on Upgrades from 8.0.x to 8.0.y, refer to the Minor Upgrades documentation.
This document explains the procedures for performing major upgrades of Sassafras Software components. This is an overview, with specifics being in the following documents for more detail:
Performing a major upgrade of the components is technically simple. KeyAccess is forward and backward compatible, meaning earlier clients can talk to a newer server and newer clients can talk to an older server. Because of this, Client Deployment can be done at any time, but be aware you may not have some newer data types from older clients. KeyServer and KeyConfigure must be upgraded to 8.0 at the same time as they are not cross version compatible.
On some versions of Windows OS, when a folder is opened for viewing its contents using Windows Explorer then the folder and its contents cannot be changed by any other program. Close all open Sassafras Software folders and applications before attempting to run any of the Sassafras Software installers.
The upgrade of KeyServer to 8.0 will transform the existing configuration and data to the 8.0 data formats while preserving a backup copy of your older KeyServer Data Folder. For this reason, upgrading will typically require enough disk space to duplicate the older KeyServer folder in its entirety.
Important - note that if your 7.5 (or older) KeyServer is running on Windows, and data is stored at a non-default location (for example on a non-system drive), the 8.0 Server installer will move the converted data to the default location in C:\Program Files\Sassafras K2\Server unless you select the “KeyServer Data Folder” item within the installer's “Sassafras KeyServer Platform Server Setup” dialog and browse to the existing Data Folder's Drive/Path during the install. This is necessary because the data folder is now a distinct entry in the installer. Choosing this option once will allow the data folder to remain at that location for any subsequent 8.0.x upgrades.
Upgrade KeyServer from 7.x to 8.0
The basic configuration and interface in 8.0 are very similar to 7.7 and later. Significant changes and additions have been made since versions prior to 7.6. Review the following documents for the changes in each major step relevant to your upgrade situation.
- 7.6 totally redesigned and enhanced KeyReporter, added the Automatic Policy Wizard using Family Products, Printers, and more. For more information see 7.5 -> 7.6 Important Changes. Pay special attention to our Tech Note on migration to help guide the process of replacing editions with families in your old policies.
- 7.7 put much more functionality and configuration in KeyReporter, added a guacamole integration for remote access, implemented Single Sign on in KeyReporter, and more. For more information see 7.6 -> 7.7 Important Changes. If you never upgraded to 7.6, pay special attention to our Tech Note on migration to help guide the process of replacing editions with families in your old policies.
- 7.8 focuses on building out Hardware Asset Management by turning the Printers window into the Devices window, adding automated discovery and many 3rd party integrations like JAMF to populate mobile devices, and much more. For more information see 7.7 -> 7.8 Important Changes.
- 7.9 enhances asset management and reporting with History, Pivot Tables, Actions, and general feature enhancements of the Web UI. For more information see 7.8 -> 7.9 Important Changes.
- 8.0 adds more functionality to the Web UI and adds the Hardware Refresh features.
Step by step instructions for performing the upgrade are documented in Server 7.x -> 8.0. You should read this entire document before actually starting the upgrade.
Review Configuration
In general you should consult our Configuration Review document for advice and best practices. The older the version you are upgrading from, the more likely there are important changes you should be aware of.
Major Upgrade of KeyConfigure
Before running the Admin installer, quit KeyConfigure. The version 8.0 Admin installer looks for the “Admin” folder inside the “Sassafras K2” folder. If the Admin folder already contains KeyConfigure 8.0.x, the installer simply updates all the 8.0 components. If the installer finds an older KeyConfigure such as version 7.8, the old Admin folder will be moved aside (e.g. renamed to "7.8 Admin"), in case you need to also maintain a copy of the older version.
KeyConfigure 8.0 will only connect to KeyServer 8.0. If you need to also manage a version 7.9 or earlier KeyServer, you will need to keep a matching version of KeyConfigure.
Major Upgrade of KeyAccess
Clients are easily upgraded from 7.x or earlier to 8.x by simply running the latest ksp-client installer, or using the auto-update feature. Clients will retain their connection information (and portable licenses, if any) after the upgrade.
While we always do everything possible to maintain backward compatibility between new versions of KeyServer and older clients, it is sometimes impossible for old clients to have full functionality when connecting to a new KeyServer. For example, audits and usage of Java programs are only supported by KeyAccess 7.3 or later. KeyServer awareness of a computer that is turned on but has no one logged is only supported by KeyAccess 7.4 or later. The ability to track URL access is only supported by KeyAccess 7.5 or later. Gathering of Device data requires KeyAccess 7.8 or later. Of course it is also best to keep your clients up to date with the latest KeyAccess version to avoid wasting time on bugs that have already been fixed. Consult the Upgrade Warnings and Component History for specific documentation of bug fixes and known issues.
On the other hand, there is never a down side to upgrading KeyAccess whenever possible. A new KeyAccess will always be fully compatible with an old KeyServer. In order to make KeyAccess upgrades easier you may want to consult the Deployment document.