1.9 KiB
| layout | page_title | sidebar_current | description |
|---|---|---|---|
| docs | Consul Protocol Compatibility Promise | docs-upgrading-compatibility | We expect Consul to run in large clusters as long-running agents. Because upgrading agents in this sort of environment relies heavily on protocol compatibility, this page makes it clear on our promise to keeping different Consul versions compatible with each other. |
Protocol Compatibility Promise
We expect Consul to run in large clusters as long-running agents. Because upgrading agents in this sort of environment relies heavily on protocol compatibility, this page makes clear our promise to keep different Consul versions compatible with each other.
We promise that every subsequent release of Consul will remain backwards compatible with at least one prior version. Concretely: version 0.5 can speak to 0.4 (and vice versa), but may not be able to speak to 0.1.
The backwards compatibility is automatic unless otherwise noted. Consul agents by default will speak the latest protocol, but can understand earlier ones. If speaking an earlier protocol, new features may not be available. The ability for an agent to speak an earlier protocol is so that they can be upgraded without cluster disruption.
This compatibility guarantee makes it possible to upgrade Consul agents one at a time, one version at a time. For more details on the specifics of upgrading, see the upgrading page.
Protocol Compatibility Table
| Version | Protocol Compatibility |
|---|---|
| 0.1 | 1 |
| 0.2 | 1 |
| 0.3 | 1, 2 |
| 0.4 | 1, 2 |
| 0.5 | 1, 2. 0.5.X servers cannot be mixed with older servers. |