Update CHANGELOG.md

This commit is contained in:
James Phillips 2017-09-27 15:47:52 -07:00 committed by GitHub
parent 145d9564de
commit b8db92d1b7
1 changed files with 22 additions and 1 deletions

View File

@ -4,7 +4,28 @@ BREAKING CHANGES:
* **Raft Protocol Now Defaults to 3:** The [`-raft-protocol`](https://www.consul.io/docs/agent/options.html#_raft_protocol) default has been changed from 2 to 3, enabling all [Autopilot](https://www.consul.io/docs/guides/autopilot.html) features by default. Version 3 requires Consul running 0.8.0 or newer on all servers in order to work, so if you are upgrading with older servers in a cluster then you will need to set this back to 2 in order to upgrade. See [Raft Protocol Version Compatibility](https://www.consul.io/docs/upgrade-specific.html#raft-protocol-version-compatibility) for more details. Also the format of `peers.json` used for outage recovery is different when running with the lastest Raft protocol. See [Manual Recovery Using peers.json](https://www.consul.io/docs/guides/outage.html#manual-recovery-using-peers-json) for a description of the required format. [GH-3477] * **Raft Protocol Now Defaults to 3:** The [`-raft-protocol`](https://www.consul.io/docs/agent/options.html#_raft_protocol) default has been changed from 2 to 3, enabling all [Autopilot](https://www.consul.io/docs/guides/autopilot.html) features by default. Version 3 requires Consul running 0.8.0 or newer on all servers in order to work, so if you are upgrading with older servers in a cluster then you will need to set this back to 2 in order to upgrade. See [Raft Protocol Version Compatibility](https://www.consul.io/docs/upgrade-specific.html#raft-protocol-version-compatibility) for more details. Also the format of `peers.json` used for outage recovery is different when running with the lastest Raft protocol. See [Manual Recovery Using peers.json](https://www.consul.io/docs/guides/outage.html#manual-recovery-using-peers-json) for a description of the required format. [GH-3477]
* **Config Files Require an Extension:** As part of supporting the [HCL](https://github.com/hashicorp/hcl#syntax) format for Consul's config files, an `.hcl` or `.json` extension is required for all config files loaded by Consul, even when using the [`-config-file`](https://www.consul.io/docs/agent/options.html#_config_file) argument to specify a file directly. [GH-3480] * **Config Files Require an Extension:** As part of supporting the [HCL](https://github.com/hashicorp/hcl#syntax) format for Consul's config files, an `.hcl` or `.json` extension is required for all config files loaded by Consul, even when using the [`-config-file`](https://www.consul.io/docs/agent/options.html#_config_file) argument to specify a file directly. [GH-3480]
* **HTTP Verbs are Enforced in HTTP APIs:** Many endpoints in the HTTP API that previously took any HTTP verb now check for specific HTTP verbs and enforce them. This may break clients relying on the old behavior. [GH-3405] * **Deprecated Options Have Been Removed:** All of Consul's previously deprecated command line flags and config options have been removed, so these will need to be mapped to their equivalents before upgrading. [GH-3480]
<details><summary>Detailed List of Deprecated Options and their Equivalents</summary>
| Option | Supported Equivalent |
| -------- | -------------------- |
| `-atlas` | None, Atlas is no longer supported. |
| `-atlas-token`| None, Atlas is no longer supported. |
| `-atlas-join` | None, Atlas is no longer supported. |
| `-atlas-endpoint` | None, Atlas is no longer supported. |
| `-dc` | [`-datacenter`](https://www.consul.io/docs/agent/options.html#_datacenter) |
| `-retry-join-azure-tag-name` | [`-retry-join`](https://www.consul.io/docs/agent/options.html#retry-join) |
| `-retry-join-azure-tag-value" | [`-retry-join`](https://www.consul.io/docs/agent/options.html#retry-join) |
| `-retry-join-ec2-region" | [`-retry-join`](https://www.consul.io/docs/agent/options.html#retry-join) |
| `-retry-join-ec2-tag-key" | [`-retry-join`](https://www.consul.io/docs/agent/options.html#retry-join) |
| `-retry-join-ec2-tag-value" | [`-retry-join`](https://www.consul.io/docs/agent/options.html#retry-join) |
| `-retry-join-gce-credentials-file" | [`-retry-join`](https://www.consul.io/docs/agent/options.html#retry-join) |
| `-retry-join-gce-project-name" | [`-retry-join`](https://www.consul.io/docs/agent/options.html#retry-join) |
| `-retry-join-gce-tag-name" | [`-retry-join`](https://www.consul.io/docs/agent/options.html#retry-join) |
| `-retry-join-gce-zone-pattern" | [`-retry-join`](https://www.consul.io/docs/agent/options.html#retry-join) |
* **HTTP Verbs are Now Enforced in Many HTTP APIs:** Many endpoints in the HTTP API that previously took any HTTP verb now check for specific HTTP verbs and enforce them. This may break clients relying on the old behavior. [GH-3405]
<details><summary>Detailed List of Updated Endpoints and Required HTTP Verbs</summary> <details><summary>Detailed List of Updated Endpoints and Required HTTP Verbs</summary>