Skip to main content

Upgrade an existing deployment

Supported upgrade pathsโ€‹

Target versionMinimum current versionZero-downtime supportedInstructions
1.8.x1.4.xNoSingle-node โ€ข Multi-nodes
1.8.x1.xNoSingle-node โ€ข Multi-nodes
1.7.x1.4.xYesSingle-node โ€ข Multi-nodes
1.7.x1.xNoSingle-node โ€ข Multi-nodes
1.6.x1.xNoSingle-node โ€ข Multi-nodes
1.6.x1.4.xYesSingle-node โ€ข Multi-nodes
1.5.x1.xNoSingle-node โ€ข Multi-nodes
1.5.x1.4.xYesSingle-node โ€ข Multi-nodes
1.4.x1.xNoSingle-node โ€ข Multi-nodes
1.4.x1.4.xYesSingle-node โ€ข Multi-nodes
1.3.x1.xNoSingle-node โ€ข Multi-nodes
1.3.x1.3.xYesSingle-node โ€ข Multi-nodes
1.2.x1.xNoSingle-node โ€ข Multi-nodes
1.2.x1.2.xYesSingle-node โ€ข Multi-nodes
1.1.x1.xNoSingle-node โ€ข Multi-nodes
1.1.x1.1.xYesSingle-node โ€ข Multi-nodes

Prerequisitesโ€‹

Compatibility versionโ€‹

Verify that you meet the upgrade path requirements above for your desired version and review the relevant release notes for any preparation instructions.

Upgrade a multi-nodes deploymentโ€‹

Preparationโ€‹

  • Prior to upgrading, confirm that all your ledger instances were cleanly shut down
  • Create a backup of your database (e.g. using pg_dump if you're using Postgres as your storage backend, or by copying the SQLite files otherwise)
  • Choose a node where you'll be able to execute numary cli commands

Upgrade instructionsโ€‹

  1. Download the desired target version on the node used for upgrade
  2. Using the new binary, run:
numary storage scan
numary storage list
numary storage upgrade {LEDGER_NAME}
  1. Restart all your nodes with the upgraded ledger binary

Upgrade a multi-nodes deployment (zero-downtime)โ€‹

Upgrade instructionsโ€‹

  1. Download the desired target version
  2. Deploy new nodes with the new upgraded version
  3. Decomission old nodes with the previous version

Upgrade a single-node deploymentโ€‹

Preparationโ€‹

  • Prior to upgrading, confirm that your ledger instance was cleanly shut down
  • Create a backup of your database (e.g. using pg_dump if you're using Postgres as your storage backend, or by copying the SQLite files otherwise)

Upgrade instructionsโ€‹

  1. Download the desired version of Formance Ledger
  2. Using the new binary, run:
numary storage scan
numary storage list
numary storage upgrade {LEDGER_NAME}
  1. Start your ledger instance with new version of ledger binary