github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Website: clean up docs/compatibility.

pull/707/head
Ryan Breen 2015-02-17 14:29:00 -05:00
parent 802804a6cf
commit b7ba331544
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
website/source/docs/compatibility.html.markdown
View File

@ -3,29 +3,29 @@ layout: "docs"
page_title: "Consul Protocol Compatibility Promise"
sidebar_current: "docs-upgrading-compatibility"
description: |-
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.
We expect Consul to run in large clusters of long-running agents. Because safely upgrading agents in this sort of environment relies heavily on backwards compatibility, we have a strong commitment to keeping different Consul versions protocol-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 expect Consul to run in large clusters of long-running agents. Because
safely upgrading agents in this sort of environment relies heavily on backwards
compatibility, we have a strong commitment to keeping different Consul
versions protocol-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.
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.
Backwards compatibility is automatic unless otherwise noted. Consul agents by
default will speak the latest protocol but can understand earlier ones. Note:
if speaking an earlier protocol, _new features may not be available_.
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](/docs/upgrading.html).
The ability for an agent to speak an earlier protocol is to ensure that any agent
can be upgraded without cluster disruption. Consul agents can be updated one
at a time, one version at a time.
For more details on the specifics of upgrading, see the [upgrading page](/docs/upgrading.html).
## Protocol Compatibility Table