Backup

The KeyServer Data Folder contains all of the crucial data for your K2 software management system. You should include this folder as part of a regular backup procedure for your important enterprise services.

In addition to a general backup procedure, you can configure KeyServer to create time stamped duplicates of its most crucial configuration and data files based on an internal "backup schedule".

The KeyServer executable, its license certificates, various support files, and the "Purchase Documents" sub-folder are NOT included in KeyServer's internal backup! If you are making use of K2's document storage feature for purchase orders, you should make sure that the Purchase Documents folder is independently backed up. Likewise, the "Report Documents" folder is not backed up - if a backup of this folder is important, do it independently as well. Additionally, the KeyReporter Data Folder is NOT backed up by the internal backup - again, if you have customized things such as Availability Maps, you should be sure to do a standard file system backup as well.

KeyServer's default location for storing its own duplicated files is a sub-folder of the KeyServer Data Folder named "Backup Folder". To give some protection against hardware failure (e.g. failed disk), you should alias this Backup Folder to a separate disk or remote volume with file create and modify privileges. [On Windows, you may need to reconfigure the KeyServer service to run in a non-SYSTEM account which is set to auto-mount a remote backup drive with the necessary privileges.]

 

An external backup solution should be used in conjunction with the built in backup process. The external backup solution will not be able to reliably backup the database files that are open and in use - these must be backed up either by the built in backup process or when the KeyServer process is stopped. We strongly recommend that you set a backup schedule soon after setting up your KeyServer, and that you configure the backup location on a separate volume. The configuration data in these files is otherwise irreplaceable and if lost must be regenerated from scratch. The external backup solution will not be able to reliably backup the database files that are open and in use - these must be backed up either by the built in backup process or when the KeyServer process is stopped.

KeyServer does not backup everything in the KeyServer Data Folder - just the files which are essential for KeyServer Configuration. As an example, the folder named “Purchase Documents” contains any documents or url's that you may have dragged into the Purchase details window as supporting documentation - even though these files may be quite important, they are not backed up internally! Again, the main reason that KeyServer has a built in backup feature is to allow copying of database files that are always in use so an external backup program has a slight chance of capturing them in a corrupt state.


OPEN
Backup Schedule dialog

Select “Backup Schedule...” from the Config Menu to set a daily, multi-day, or weekly backup schedule. The following dialog appears.

Change backup schedule dialog

Enter the time at which you want the backup to occur, and enter the day(s) of the week on which you want the backups to be done. The backup process will run at any time without interrupting normal KeyServer service – but you may want to choose a time in the night that avoids possible disk contention in case the KeyServer host computer is simultaneously supporting other disk intensive tasks. The Backup Now button can be used to perform an immediate backup regardless of whether a schedule has been defined.

The Backup Folder is organized with a sub-folder for each day of the week plus an Unscheduled sub-folder for "immediate" backups. The critical data files being backed up are all at the root level of the KeyServer Data Folder:

KeyServer Data Folder important site data
server.lic your KeyServer license certificate (and other files with the ".lic" extension)
Admin Permissions Accounts. Passwords, and Permissions for KeyConfigure
Audit Data audit information database
Audit Index Database audit information database
Audit Packages Data audit information database
Audit Packages Index Database audit information database
Audit Packages Primary Data audit information database
Audit Primary audit information database
Authent List users/passwords/groups list forText Authent method
Computer Database computer identity database
Contract Database contracts referrenced from Purchases and Policies
Journal Database admin journal database
Journal History admin journal database
KeyServer Preferences KeyServer settings file
Location Filter Database network access database
Package Database package database
Policy Database policy database
Portable Use Record checked out licenses database
Product Database product database
Program Database program information database
Purchase Database purchase database
Report Database report database
Reservations Record schedules database
Usage Index Database usage events database
Time Set Database the record of schedules when created for custom policies
Usage Log usage events database
User Database user database

[A list of all KeyServer components, data files, etc. available here: Complete File List]

If a restore from backup ever becomes necessary, first create a new KeyServer installation using the server installer appropriate for the host platform - but don't start the KeyServer process. Then copy in all the files listed above from your latest backup (replacing any default copies created by the installer). Then start the KeyServer process. Note: your backed up data files are usable under any host operating system – there is no requirement that you resurrect the KeyServer on the same host or operating system that failed (but of course you will want to preserve the DNS name so that clients can find the new installation).

Alternately, if a standard file system backup exists of the entire Server folder (containing the ks executable and its KeyServer Data Folder), it is quite probable that using it as the source for the restore will be fine - even though there is a slight possibility that an in-use file has been captured in a corrupt state so it will have to be replaced by a copy from the internal backup folder.

After restoring from a backup, re-run the latest KeyServer installer just as an easy way to get the automatic startup of the KeyServer process configured and to make sure you have the latest component versions.