From e0e2b7b54736204551b6b0a751d23b26572f9ff2 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 25 Apr 2022 10:04:06 -0700 Subject: [PATCH 1/2] docs: updated connect docs and re-deploying missed changes --- .../content/docs/connect/configuration.mdx | 23 +++++++++++++++---- .../docs/connect/connect-internals.mdx | 13 +++++++---- website/data/docs-nav-data.json | 2 +- 3 files changed, 27 insertions(+), 11 deletions(-) diff --git a/website/content/docs/connect/configuration.mdx b/website/content/docs/connect/configuration.mdx index e6ebdbf857..2ac2275da9 100644 --- a/website/content/docs/connect/configuration.mdx +++ b/website/content/docs/connect/configuration.mdx @@ -7,29 +7,42 @@ description: >- connections, automatically wrapping and verifying TLS connections. --- -# Connect Configuration +# Service Mesh Configuration -There are many configuration options exposed for Connect. The only option -that must be set is the "enabled" option on Consul Servers to enable Connect. +There are many configuration options exposed for Consul service mesh. The only option +that must be set is the "connect.enabled" option on Consul Servers to enable Consul service mesh. All other configurations are optional and have reasonable defaults. --> **Tip:** Connect is enabled by default when running Consul in +As a reminder, Consul Connect is used interchangeably +with the name Consul Service Mesh and is what this document will use to refer to for Service Mesh functionality within Consul. + +-> **Tip:** Service mesh is enabled by default when running Consul in dev mode with `consul agent -dev`. ## Agent Configuration -The first step to use Connect is to enable Connect for your Consul +The first step to use service mesh is to enable Connect for your Consul cluster. By default, Connect is disabled. Enabling Connect requires changing the configuration of only your Consul _servers_ (not client agents). To enable Connect, add the following to a new or existing [server configuration file](/docs/agent/config/config-files). In an existing cluster, this configuration change requires a Consul server restart, which you can perform one server at a time to maintain availability. In HCL: + + + ```hcl connect { enabled = true } ``` +```json +"connect": { + "enabled": true +} +``` + + This will enable Connect and configure your Consul cluster to use the built-in certificate authority for creating and managing certificates. You may also configure Consul to use an external diff --git a/website/content/docs/connect/connect-internals.mdx b/website/content/docs/connect/connect-internals.mdx index 01232ab1dc..7ec91a2b0b 100644 --- a/website/content/docs/connect/connect-internals.mdx +++ b/website/content/docs/connect/connect-internals.mdx @@ -6,15 +6,18 @@ description: >- and performance, intention and certificate authority replication. --- -# How Connect Works +# How Service Mesh Works -This page details the inner workings of some of Connect's core features. -Understanding how these features work isn't a prerequisite for using Connect, +This page details the inner workings of some of Consul sevice mehs's core features. +Understanding how these features work isn't a prerequisite for using Consul service mesh, but will help you build a mental model of what's going on under the hood, which -may help you reason about Connect's behavior in more complex deployment +may help you reason about service mesh's behavior in more complex deployment scenarios. -To try Connect locally, complete the [Getting Started with Consul service +As a reminder, Consul Connect is used interchangeably +with the name Consul Service Mesh and is what this document will use to refer to for Service Mesh functionality within Consul. + +To try service mesh locally, complete the [Getting Started with Consul service mesh](https://learn.hashicorp.com/tutorials/consul/service-mesh?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index d2e81d9537..04c11e24c5 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -142,7 +142,7 @@ "path": "connect" }, { - "title": "How Connect Works", + "title": "How Service Mesh Works", "path": "connect/connect-internals" }, { From 142c0ac4192e4dacc275d00bc84b79a92132bd43 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 26 Apr 2022 13:12:53 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/content/docs/connect/configuration.mdx | 7 +++---- website/content/docs/connect/connect-internals.mdx | 13 +++++-------- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/website/content/docs/connect/configuration.mdx b/website/content/docs/connect/configuration.mdx index 2ac2275da9..43d646f22a 100644 --- a/website/content/docs/connect/configuration.mdx +++ b/website/content/docs/connect/configuration.mdx @@ -10,18 +10,17 @@ description: >- # Service Mesh Configuration There are many configuration options exposed for Consul service mesh. The only option -that must be set is the "connect.enabled" option on Consul Servers to enable Consul service mesh. +that must be set is the `connect.enabled` option on Consul servers to enable Consul service mesh. All other configurations are optional and have reasonable defaults. -As a reminder, Consul Connect is used interchangeably -with the name Consul Service Mesh and is what this document will use to refer to for Service Mesh functionality within Consul. +Consul Connect is the component shipped with Consul that enables service mesh functionality. The terms _Consul Connect_ and _Consul service mesh_ are used interchangeably throughout this documentation. -> **Tip:** Service mesh is enabled by default when running Consul in dev mode with `consul agent -dev`. ## Agent Configuration -The first step to use service mesh is to enable Connect for your Consul +Begin by enabling Connect for your Consul cluster. By default, Connect is disabled. Enabling Connect requires changing the configuration of only your Consul _servers_ (not client agents). To enable Connect, add the following to a new or existing diff --git a/website/content/docs/connect/connect-internals.mdx b/website/content/docs/connect/connect-internals.mdx index 7ec91a2b0b..eeadaacc8f 100644 --- a/website/content/docs/connect/connect-internals.mdx +++ b/website/content/docs/connect/connect-internals.mdx @@ -8,14 +8,11 @@ description: >- # How Service Mesh Works -This page details the inner workings of some of Consul sevice mehs's core features. -Understanding how these features work isn't a prerequisite for using Consul service mesh, -but will help you build a mental model of what's going on under the hood, which -may help you reason about service mesh's behavior in more complex deployment -scenarios. - -As a reminder, Consul Connect is used interchangeably -with the name Consul Service Mesh and is what this document will use to refer to for Service Mesh functionality within Consul. +This topic describes how many of the core features of Consul's service mesh functionality works. +It is not a prerequisite, +but this information will help you understand how Consul service mesh behaves in more complex scenarios. + +Consul Connect is the component shipped with Consul that enables service mesh functionality. The terms _Consul Connect_ and _Consul service mesh_ are used interchangeably throughout this documentation. To try service mesh locally, complete the [Getting Started with Consul service mesh](https://learn.hashicorp.com/tutorials/consul/service-mesh?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS)