Readme file
Ionburst - BYOL Edition (Linux x86_64)
The Ionburst VPC image is intended for existing Ionburst customers looking to deploy on IBM Cloud VPC.
Before you begin
Use of the Ionburst software requires an existing Starter, Premium or Enterprise Licence, available through the Ionburst website.
Ionburst Starter and Premium licences require the deployed VPC image to maintain an internet-enabled connection with the Ionburst licensing server.
Review the deployment and reference architecture materials available in the Ionburst customer docs.
Required resources
The Ionburst VPC image requires the following components and third-party dependencies to operate:
- Microsoft SQL Server
- Memcached
- Temporal
- MongoDB
Installing the software
To get started, access the deployed VPC image over SSH as vpcuser
, change user to ionburst
, and navigate to the /opt/ionburst
directory.
From here, deploy the Ionburst databases using the ionburst-db-prepare
tool, then edit the configuration files for each Ionburst service in the /opt/ionburst
directory with the details of the dependencies listed above.
Once configured, the Ionburst services can be started with systemctl
.
Detailed walkthrough and configuration steps are available in the Ionburst customer docs.
Upgrading to a new version
When a new version of Ionburst is available, you will receive an notification to the email registered against the Ionburst Customer portal. This will include details of any new downloads, artifacts and updated VPC images, and detailed update instructions will be provided in the Ionburst customer docs.
To upgrade your Ionburst deployment:
- Deploy the new VPC image version to a new VPC virtual server instance.
- Backup your metadata databases.
- Stop the old versions of the Ionburst services.
- Transfer your existing configurations details to the new virtual server instance.
- Complete any required database and configuration migrations.
- Start the updated Ionburst services on the new virtual server instance.
Uninstalling the software
- Migrate, delete or otherwise transfer all data protected by Ionburst out of the deployed system.
- Backup your metadata databases.
- Stop the Ionburst services, and shutdown the virtual server instance(s).
- Shutdown and/or de-provision all supporting infrastructure and dependencies.