Backup

If you are using dynamically provisioned persistent volumes for data and logs, be aware that these volumes will be claimed when the ITX Runtime Server instance is installed, but will be recycled after the product has been uninstalled, since at that time the persistent volume claims created by the product when it was installed will be removed as well. For dynamically provisioned persistent volumes, the assumption is that the maps, flows, and associated artifacts will continue to be available in your source systems from which you originally uploaded or deployed them to the ITX Runtime Server environment.

For example, ITX Runtime Server operates on compiled maps (mmc files) which must have all originated from source maps on on-prem systems where they have been produced by compiling the map source definitions (.mms files) with tools like ITX Design Studio. The compiled maps are then uploaded to ITX Runtime Server. In order to be able to upload the maps again if that need arises, they need to continue to remain available at their origin. This is especially critical for the map definitions (.mms files) since they are required to be able to make updates in the future, and can always be compiled again to be uploaded to ITX Runtime Server. Backing up the original storage for those maps, especially the map sources (.mms files) is therefore of utmost importance, and is outside the scope of ITX Runtime Server deployment.

When using persistent volumes, you can choose to configure them with the Retain policy. The content of the persistent volume will then be preserved and can be subsequently retrieved - even after uninstalling ITX Runtime Server. The exact Kubernetes steps for accomplishing this task is documented under the Storage section in the README file of the Helm Chart Examples. After configuring the persistent volume with the Retain policy, the existingClaim setting in the values.yaml file can be used to identify the persistent volumes, thereby ensuring that deployment of maps and flows need not be repeated after re-installation.

If you need to back up any files in the persistent volumes that were produced by the maps or flows running under ITX Runtime Server, you must download those files individually using the provided data and logs GET APIs. Alternatively, you may choose to backup the persistent volume storage directly, if your cluster environment provides for direct access to the backing storage. Note that the data GET APIs work on subfolders as well, in which case the response will contain the names of all subfolders and files in that folder. This can be utilized to implement scripts which will recursively pull all the files in a given directory.