Tarantool Cartridge

Cluster management in Tarantool is powered by the Tarantool Cartridge framework.

Here we explain how you can benefit with Tarantool Cartridge, a framework for developing, deploying, and managing applications based on Tarantool.

This documentation contains the following sections:

• Overview
  • About Tarantool Cartridge
  • Getting started
  • Contributing
• Developer’s guide
  • Introduction
  • Installing Tarantool Cartridge
  • Creating a project
  • Cluster roles
  • Using the built-in HTTP server
  • Implementing authorization in the web interface
  • Application versioning
  • Using .cartridge.ignore files
  • Failover architecture
  • Configuring instances
  • Deploying an application
  • Starting/stopping instances
  • Error handling guidelines
  • Cluster instance lifecycle
• Administrator’s guide
  • Versions compatibility and known issues about upgrading
  • Deploying the cluster
  • Bootstrapping from an existing cluster (optional)
  • Cluster setup
  • Updating the configuration
  • Managing the cluster
  • Managing users
  • Resolving conflicts
  • Monitoring a cluster via CLI
  • Issues and suggestions
  • Instances general info
  • Rebalancer control
  • Setting instances zones
  • Migrations
  • SSL in Cartridge
  • Changing cluster cookie
  • Changing membership encryption key
  • Getting rid of expelled instances in membership
  • Fixing broken instance configuration
  • Forcefully removing broken instances
  • Recover from OperationError caused by a broken instance configuration
  • Upgrading schema
  • Disaster recovery
  • Backups
• Troubleshooting
  • Problems with replica
  • Editing clusterwide configuration in WebUI returns an error
  • An instance is stuck in the ConnectingFullmesh state upon restart
  • I want to run an instance with a new advertise_uri
  • The cluster is doomed, I’ve edited the config manually. How do I reload it?
  • Repairing cluster using Cartridge CLI repair command
  • Broken failover promote in Cartridge 2.7.7/2.7.8
  • A ‘Connection refused’ error in unconfigured instance since 2.7.4
  • ‘Address already in use’ errors
• Cartridge API
  • Module cartridge
  • Module cartridge.auth
  • Module cartridge.roles
  • Module cartridge.issues
  • Module cartridge.argparse
  • Module cartridge.twophase
  • Module cartridge.failover
  • Module cartridge.topology
  • Module cartridge.clusterwide-config
  • Module cartridge.rpc
  • Module cartridge.tar
  • Module cartridge.pool
  • Module cartridge.upload
  • Module cartridge.confapplier
  • Module cartridge.remote-control
  • Module cartridge.service-registry
  • Module custom-role
  • Module cartridge.lua-api.stat
  • Module cartridge.lua-api.boxinfo
  • Module cartridge.lua-api.get-topology
  • Module cartridge.lua-api.edit-topology
  • Module cartridge.lua-api.topology
  • Module cartridge.lua-api.failover
  • Module cartridge.lua-api.vshard
  • Module cartridge.lua-api.deprecated
  • Module cartridge.lua-api.compression
  • Class cartridge.test-helpers.cluster
  • Class cartridge.test-helpers.server
  • Class cartridge.test-helpers.etcd
  • Class cartridge.test-helpers.stateboard
• Changelog
  • Unreleased
  • [2.16.1] - 2025-07-04
  • [2.16.0] - 2025-06-20
  • [2.15.4] - 2025-06-11
  • [2.15.3] - 2025-04-24
  • [2.15.2] - 2025-03-31
  • [2.15.1] - 2025-03-12
  • [2.15.0] - 2025-03-11
  • [2.14.0] - 2025-02-13
  • [2.13.0] - 2024-11-28
  • [2.12.4] - 2024-09-16
  • [2.12.3] - 2024-08-16
  • [2.12.2] - 2024-06-24
  • [2.12.1] - 2024-06-06
  • [2.12.0] - 2024-05-28
  • [2.11.0] - 2024-05-15
  • [2.10.0] - 2024-04-10
  • [2.9.0] - 2024-03-06
  • [2.8.6] - 2024-02-01
  • [2.8.5] - 2024-01-18
  • [2.8.4] - 2023-10-31
  • [2.8.3] - 2023-09-28
  • [2.8.2] - 2023-08-22
  • [2.8.1] - 2023-07-20
  • [2.8.0] - 2023-05-25
  • [2.7.9] - 2023-04-06
  • [2.7.8] - 2023-01-27 - Update to this release is broken
  • [2.7.7] - 2022-12-09 - Update to this release is broken
  • [2.7.6] - 2022-08-22
  • [2.7.5] - 2022-06-28
  • [2.7.4] - 2022-04-11
  • [2.7.3] - 2021-10-27
  • [2.7.2] - 2021-10-08
  • [2.7.1] - 2021-08-18
  • [2.7.0] - 2021-08-10
  • [2.6.0] - 2021-04-26
  • [2.5.1] - 2021-03-24
  • [2.5.0] - 2021-03-05
  • [2.4.0] - 2020-12-29
  • [2.3.0] - 2020-08-26
  • [2.2.0] - 2020-06-23
  • [2.1.2] - 2020-04-24
  • [2.1.1] - 2020-04-20
  • [2.1.0] - 2020-04-16
  • [2.0.2] - 2020-03-17
  • [2.0.1] - 2020-01-15
  • [2.0.0] - 2019-12-27
  • [1.2.0] - 2019-10-21
  • [1.1.0] - 2019-09-24
  • [1.0.0] - 2019-08-29
  • [0.10.0] - 2019-08-01
  • [0.9.2] - 2019-07-12
  • [0.9.1] - 2019-07-10
  • [0.9.0] - 2019-07-02
  • [0.8.0] - 2019-05-20
  • [0.7.0] - 2019-04-05
  • [0.6.3] - 2019-02-08
  • [0.6.2] - 2019-02-07
  • [0.6.1] - 2019-02-05
  • [0.6.0] - 2019-01-30
  • [0.5.1] - 2018-12-12
  • [0.5.0] - 2018-12-11
  • [0.4.0] - 2018-11-27
  • [0.3] - 2018-10-30
  • [0.2] - 2018-10-01
  • [0.1] - 2018-09-25