From ebc5ebbd93159109b77340df5e16f81cfafd4b27 Mon Sep 17 00:00:00 2001 From: Chris Capurso <1036769+ccapurso@users.noreply.github.com> Date: Tue, 22 Nov 2022 13:56:18 +0000 Subject: [PATCH] backport of commit 7d9bc82beee0681f49f349f92d9127dfcaaf9e5f --- website/content/api-docs/secret/consul.mdx | 2 ++ .../content/docs/configuration/service-registration/consul.mdx | 2 ++ website/content/docs/configuration/storage/consul.mdx | 2 ++ .../content/docs/platform/k8s/helm/examples/ha-with-consul.mdx | 2 ++ website/content/docs/secrets/consul.mdx | 2 ++ website/content/partials/consul-dataplane-compat.mdx | 1 + 6 files changed, 11 insertions(+) create mode 100644 website/content/partials/consul-dataplane-compat.mdx diff --git a/website/content/api-docs/secret/consul.mdx b/website/content/api-docs/secret/consul.mdx index eb70705ed4883..3751299b0fb3a 100644 --- a/website/content/api-docs/secret/consul.mdx +++ b/website/content/api-docs/secret/consul.mdx @@ -8,6 +8,8 @@ description: This is the API documentation for the Vault Consul secrets engine. @include 'x509-sha1-deprecation.mdx' +@include 'consul-dataplane-compat.mdx' + This is the API documentation for the Vault Consul secrets engine. For general information about the usage and operation of the Consul secrets engine, please see the [Vault Consul documentation](/docs/secrets/consul). diff --git a/website/content/docs/configuration/service-registration/consul.mdx b/website/content/docs/configuration/service-registration/consul.mdx index 3de206b200c4d..0795babc12063 100644 --- a/website/content/docs/configuration/service-registration/consul.mdx +++ b/website/content/docs/configuration/service-registration/consul.mdx @@ -16,6 +16,8 @@ a default health check. When Consul is configured as the storage backend, the st ~> **Version information:** The `service_registration` configuration option was introduced in Vault 1.4.0. +@include 'consul-dataplane-compat.mdx' + - **HashiCorp Supported** – Consul Service Registration is officially supported by HashiCorp. diff --git a/website/content/docs/configuration/storage/consul.mdx b/website/content/docs/configuration/storage/consul.mdx index c19dcd51537c8..96713dc0bb7f8 100644 --- a/website/content/docs/configuration/storage/consul.mdx +++ b/website/content/docs/configuration/storage/consul.mdx @@ -15,6 +15,8 @@ key-value store. In addition to providing durable storage, inclusion of this backend will also register Vault as a service in Consul with a default health check. +@include 'consul-dataplane-compat.mdx' + - **High Availability** – the Consul storage backend supports high availability. - **HashiCorp Supported** – the Consul storage backend is officially supported diff --git a/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx b/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx index 19421bcc4723a..2d216de4dac05 100644 --- a/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx +++ b/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx @@ -10,6 +10,8 @@ description: |- @include 'helm/version.mdx' +@include 'consul-dataplane-compat.mdx' + The below `values.yaml` can be used to set up a five server Vault cluster using Consul as a highly available storage backend, Google Cloud KMS for Auto Unseal. diff --git a/website/content/docs/secrets/consul.mdx b/website/content/docs/secrets/consul.mdx index 35878d6fcc3ad..770aedd89fcb2 100644 --- a/website/content/docs/secrets/consul.mdx +++ b/website/content/docs/secrets/consul.mdx @@ -8,6 +8,8 @@ description: The Consul secrets engine for Vault generates tokens for Consul dyn @include 'x509-sha1-deprecation.mdx' +@include 'consul-dataplane-compat.mdx' + The Consul secrets engine generates [Consul](https://www.consul.io/) API tokens dynamically based on Consul ACL policies. diff --git a/website/content/partials/consul-dataplane-compat.mdx b/website/content/partials/consul-dataplane-compat.mdx new file mode 100644 index 0000000000000..8b039a1953780 --- /dev/null +++ b/website/content/partials/consul-dataplane-compat.mdx @@ -0,0 +1 @@ +~> **Compatibility information:** As of Consul 1.14.0, Consul on Kubernetes uses [Consul Dataplane](https://developer.hashicorp.com/consul/docs/connect/dataplane) by default instead of client agents. Vault does not currently support Consul Dataplane. Please follow the Consul 1.14.0 [upgrade guide](https://developer.hashicorp.com/consul/docs/k8s/upgrade#upgrading-to-consul-dataplane) to ensure that your Consul on Kubernetes deployment continues to use client agents.