From df7a421ca9fec5efc1e1d30a1eff544845c1e5a0 Mon Sep 17 00:00:00 2001 From: Meggie Ladlow Date: Wed, 27 Oct 2021 09:46:31 -0400 Subject: [PATCH 1/2] Note on pending etcd v2 API deprecation --- .../content/docs/configuration/storage/etcd.mdx | 5 +++++ .../content/docs/upgrading/upgrade-to-1.9.0.mdx | 15 ++++++++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/website/content/docs/configuration/storage/etcd.mdx b/website/content/docs/configuration/storage/etcd.mdx index 5134892f4df4..9b361c99d473 100644 --- a/website/content/docs/configuration/storage/etcd.mdx +++ b/website/content/docs/configuration/storage/etcd.mdx @@ -13,6 +13,11 @@ The Etcd storage backend is used to persist Vault's data in [Etcd][etcd]. It supports both the v2 and v3 Etcd APIs, and the version is automatically detected based on the version of the Etcd cluster. +~> The Etcd v2 API has been deprecated with the release of Etcd v3.5, and will +be decommissioned by Etcd v3.6. It will be removed from Vault in Vault 1.10. +Users of the Etcd storage backend should prepare to upgrade to the Etcd v3 API +prior to upgrading to Vault 1.10. + - **High Availability** – the Etcd storage backend supports high availability. The v2 API has known issues with HA support and should not be used in HA scenarios. diff --git a/website/content/docs/upgrading/upgrade-to-1.9.0.mdx b/website/content/docs/upgrading/upgrade-to-1.9.0.mdx index 5ab6c94da8db..3a5cd7f38475 100644 --- a/website/content/docs/upgrading/upgrade-to-1.9.0.mdx +++ b/website/content/docs/upgrading/upgrade-to-1.9.0.mdx @@ -39,7 +39,9 @@ To re-enable the old behavior, update the roles with a value of `"*"` to the `allowed_extensions` parameter allowing any/all extensions to be specified by clients. -## HTTP Request Counter Deprecation +## Deprecations + +### HTTP Request Counter Deprecation In Vault 1.9, the internal HTTP Request count [API](https://www.vaultproject.io/api-docs/system/internal-counters#http-requests) @@ -49,3 +51,14 @@ error with a message stating that `functionality on this path has been removed`. Vault does not make backwards compatible guarantees on internal APIs (those prefaced with `sys/internal`). They are subject to change and may disappear without notice. + +### Etcd v2 + +Support for Etcd v2 will be removed from Vault in Vault 1.10 (not this Vault +release, but the next one). The Etcd v2 API +was deprecated with the release of [Etcd +v3.5](https://etcd.io/blog/2021/announcing-etcd-3.5/), and will be +decommissioned in the Etcd v3.6 release. + +Users upgrading to Vault 1.9 and planning to eventually upgrade to Vault 1.10 +should plan to upgrade to the Etcd v3 API. From 07bff44ebe203f7c090d13657d80074b9b115bed Mon Sep 17 00:00:00 2001 From: Meggie Ladlow Date: Fri, 29 Oct 2021 18:08:49 -0400 Subject: [PATCH 2/2] Updating etcd guidance to include migration --- website/content/docs/configuration/storage/etcd.mdx | 7 +++++-- website/content/docs/upgrading/upgrade-to-1.9.0.mdx | 5 ++++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/website/content/docs/configuration/storage/etcd.mdx b/website/content/docs/configuration/storage/etcd.mdx index 9b361c99d473..00665513afae 100644 --- a/website/content/docs/configuration/storage/etcd.mdx +++ b/website/content/docs/configuration/storage/etcd.mdx @@ -15,8 +15,11 @@ based on the version of the Etcd cluster. ~> The Etcd v2 API has been deprecated with the release of Etcd v3.5, and will be decommissioned by Etcd v3.6. It will be removed from Vault in Vault 1.10. -Users of the Etcd storage backend should prepare to upgrade to the Etcd v3 API -prior to upgrading to Vault 1.10. +Users of the Etcd storage backend should prepare to +[migrate](/docs/commands/operator/migrate) Vault storage to an Etcd v3 cluster +prior to upgrading to Vault 1.10. All storage migrations should have +[backups](/docs/concepts/storage#backing-up-vault-s-persisted-data) taken prior +to migration. - **High Availability** – the Etcd storage backend supports high availability. The v2 API has known issues with HA support and should not be used in HA diff --git a/website/content/docs/upgrading/upgrade-to-1.9.0.mdx b/website/content/docs/upgrading/upgrade-to-1.9.0.mdx index 3a5cd7f38475..13a07ebab0fb 100644 --- a/website/content/docs/upgrading/upgrade-to-1.9.0.mdx +++ b/website/content/docs/upgrading/upgrade-to-1.9.0.mdx @@ -61,4 +61,7 @@ v3.5](https://etcd.io/blog/2021/announcing-etcd-3.5/), and will be decommissioned in the Etcd v3.6 release. Users upgrading to Vault 1.9 and planning to eventually upgrade to Vault 1.10 -should plan to upgrade to the Etcd v3 API. +should prepare to [migrate](/docs/commands/operator/migrate) Vault storage to +an Etcd v3 cluster prior to upgrading to Vault 1.10. All storage migrations +should have [backups](/docs/concepts/storage#backing-up-vault-s-persisted-data) +taken prior to migration.