From 142c0ac4192e4dacc275d00bc84b79a92132bd43 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 26 Apr 2022 13:12:53 -0700 Subject: [PATCH] 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)