start_single_engine_offline_upgrade.py

The start_single_engine_offline_upgrade.py script upgrades a single engine deployment to the latest release of MATRIXX.

This script:

  • Checks that it is running on a checkpointing server and that no other engines are running.
  • Adds a virtual IP address, if one is not available, and mounts persistent storage for the publishing pod.
  • Starts the checkpointing pod.
  • Waits for single_engine_upgrade_xxx files to trigger offline upgrade.
  • Loads pricing.
  • Loads tax data if US taxation is enabled.
  • Waits for offline upgrade to complete, triggering creation of the new checkpoint.
  • Waits for any local checkpoint data to be moved to persistent storage.

Syntax

start_single_engine_offline_upgrade.py [ -h | --help --CheckpointName=checkpointname --pricingFile=pricingfile --taxFile=taxfile --timeToWait=timetowait --message_size_in_kilobytes=message_size_in_kilobytes --character_buffer_size=character_buffer_size ]

Options

The start_single_engine_offline_upgrade.py script has the following options in addition to the common engine administration script options.

-c checkpointname, --CheckpointName=checkpointname
The checkpoint data in the $MTX_SHARED_DIR/checkpoints directory to be used for upgrade. If empty, the latest shared checkpoint data is used.
-p pricingfile, --pricingFile=pricingfile

The full path to the base pricing file in local storage to apply to the upgraded engine. Subsequent to a base pricing file, the option can be used again to specify tenant pricing in the form tenant_pricing_file:tenant_id. For example:

-p base_pricing file -p tenant1_pricing_file:tenant1_id -p tenant2_pricing_file:tenant2_id
-x taxfile, --taxFile=taxfile

The full path to the tax file in local storage to apply to the upgraded engine.

-t timetowait, --timeToWait=timetowait

The time to wait, in seconds, until the checkpoint pod is ready to load pricing. The default delay is 120 seconds.

-n message_size_in_kilobytes, --message_size_in_kilobytes=message_size_in_kilobytes

The target size, in kilobytes, of pricing or tax messages. The default size is 300 KB.

-s character_buffer_size, ----character_buffer_size=character_buffer_size

The size, in characters, of the character buffer used in price loading. The default size is 4096 characters.