From 76c064d1fd746928a1ec6c305f9e2bef49359204 Mon Sep 17 00:00:00 2001 From: boruszak Date: Tue, 13 Sep 2022 14:55:30 -0500 Subject: [PATCH 1/9] /docs/internals --- website/content/docs/internals/index.mdx | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/website/content/docs/internals/index.mdx b/website/content/docs/internals/index.mdx index ca353c2e66..9dd8c2d648 100644 --- a/website/content/docs/internals/index.mdx +++ b/website/content/docs/internals/index.mdx @@ -1,12 +1,11 @@ --- layout: docs -page_title: Internals +page_title: Internals Overview description: >- - This section covers some of the internals of Consul, such as the architecture, - consensus and gossip protocols, and security model. +Consul is a complex system that relies on a number of protocols and concepts to work. Learn about Consul's internal properties and how it works under the hood. --- -# Consul Internals +# Consul Internals Overview This section covers some of the internals of Consul. Understanding the internals of Consul is necessary to successfully use it in production. From a95a7ec40f475692d8eb2712dd6343d5b03577eb Mon Sep 17 00:00:00 2001 From: boruszak Date: Tue, 13 Sep 2022 14:58:34 -0500 Subject: [PATCH 2/9] /docs/architecture --- website/content/docs/architecture/anti-entropy.mdx | 8 ++++---- website/content/docs/architecture/consensus.mdx | 6 ++---- website/content/docs/architecture/coordinates.mdx | 3 ++- website/content/docs/architecture/gossip.mdx | 8 ++------ .../docs/architecture/improving-consul-resilience.mdx | 11 +++-------- website/content/docs/architecture/index.mdx | 8 +++----- website/content/docs/architecture/jepsen.mdx | 9 +++------ 7 files changed, 19 insertions(+), 34 deletions(-) diff --git a/website/content/docs/architecture/anti-entropy.mdx b/website/content/docs/architecture/anti-entropy.mdx index 7530fae7a5..9219d5e041 100644 --- a/website/content/docs/architecture/anti-entropy.mdx +++ b/website/content/docs/architecture/anti-entropy.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Anti-Entropy -description: | - This section details the process and use of anti-entropy in Consul. +page_title: Anti-Entropy Enforcement +description: >- +Anti-entropy keeps distributed systems consistent. Learn how Consul uses an anti-entropy mechanism to periodically sync agent states with the service catalog to prevent either from becoming stale. --- -# Anti-Entropy +# Anti-Entropy Enforcement Consul uses an advanced method of maintaining service and health information. This page details how services and checks are registered, how the catalog is diff --git a/website/content/docs/architecture/consensus.mdx b/website/content/docs/architecture/consensus.mdx index 361d2336e2..af74c07d23 100644 --- a/website/content/docs/architecture/consensus.mdx +++ b/website/content/docs/architecture/consensus.mdx @@ -1,10 +1,8 @@ --- layout: docs -page_title: Consensus Protocol +page_title: Consensus Protocol | Raft description: >- - Consul uses a consensus protocol to provide Consistency as defined by CAP. The - consensus protocol is based on Raft: In search of an Understandable Consensus - Algorithm. For a visual explanation of Raft, see The Secret Lives of Data. +Consul ensures consensus between server logs by using the Raft protocol to elect cluster leaders. Learn how Raft works in Consul and how consistency modes can lower consensus latency. --- # Consensus Protocol diff --git a/website/content/docs/architecture/coordinates.mdx b/website/content/docs/architecture/coordinates.mdx index 1e642b31b7..b722b58e11 100644 --- a/website/content/docs/architecture/coordinates.mdx +++ b/website/content/docs/architecture/coordinates.mdx @@ -1,7 +1,8 @@ --- layout: docs page_title: Network Coordinates -description: A Decentralized Network Coordinate System, with several improvements based on several follow-on papers. +description: >- +Network coordinates are node locations in network tomography used to estimate round trip time (RTT). Learn how network coordinates manifest in Consul, how it calculates RTT, and how to work with coordinates. --- # Network Coordinates diff --git a/website/content/docs/architecture/gossip.mdx b/website/content/docs/architecture/gossip.mdx index 64d2a66952..a67ced2cc9 100644 --- a/website/content/docs/architecture/gossip.mdx +++ b/website/content/docs/architecture/gossip.mdx @@ -1,12 +1,8 @@ --- layout: docs -page_title: Gossip Protocol +page_title: Gossip Protocol | Serf description: >- - Consul uses a gossip protocol to manage membership and broadcast messages to - the cluster. All of this is provided through the use of the Serf library. The - gossip protocol used by Serf is based on SWIM: Scalable Weakly-consistent - Infection-style Process Group Membership Protocol, with a few minor - adaptations. +Consul agents manage membership and broadcast messages using the Serf protocol. Learn about the differences between LAN and WAN gossip pools and how `serfHealth` affects health checks. --- # Gossip Protocol diff --git a/website/content/docs/architecture/improving-consul-resilience.mdx b/website/content/docs/architecture/improving-consul-resilience.mdx index 12fbe7c683..994127073f 100644 --- a/website/content/docs/architecture/improving-consul-resilience.mdx +++ b/website/content/docs/architecture/improving-consul-resilience.mdx @@ -1,16 +1,11 @@ --- layout: docs -page_title: Improving Consul Resilience +page_title: Fault Tolerance description: >- - Fault tolerance is the ability of a system to continue operating without interruption - despite the failure of one or more components. Consul's resilience, or fault tolerance, - is determined by the configuring of its voting server agents. Recommended strategies for - increasing Consul's fault tolerance include using 3 or 5 voting server agents, spreading - server agents across infrastructure availability zones, and using Consul Enterprise - redundancy zones to enable backup voting servers to automatically replace lost voters. +Fault tolerance is a system's ability to operate without interruption despite component failure. Learn how quorums provide fault tolerance and improve Consul’s resiliency when servers are deployed across redundancy and availability zones. --- -# Improving Consul Resilience +# Fault Tolerance Fault tolerance is the ability of a system to continue operating without interruption despite the failure of one or more components. diff --git a/website/content/docs/architecture/index.mdx b/website/content/docs/architecture/index.mdx index 4f970b9caf..80550feef3 100644 --- a/website/content/docs/architecture/index.mdx +++ b/website/content/docs/architecture/index.mdx @@ -1,13 +1,11 @@ --- layout: docs -page_title: Consul Architecture +page_title: Consul Internals Overview description: >- - Consul is a complex system that has many different moving parts. To help users - and developers of Consul form a mental model of how it works, this page - documents the system architecture. +Consul datacenters consist of clusters of server agents (control plane) and client agents deployed alongside service instances (dataplane). Learn how these components and their different communication methods make Consul possible. --- -# Consul Architecture +# Consul Internals Overview Consul is a complex system that has many different moving parts. To help users and developers of Consul form a mental model of how it works, this diff --git a/website/content/docs/architecture/jepsen.mdx b/website/content/docs/architecture/jepsen.mdx index 77f3a29fdd..1bcabdc3aa 100644 --- a/website/content/docs/architecture/jepsen.mdx +++ b/website/content/docs/architecture/jepsen.mdx @@ -1,14 +1,11 @@ --- layout: docs -page_title: Jepsen Testing +page_title: Jepsen Testing Results description: >- - Jepsen is a tool, written by Kyle Kingsbury, designed to test the partition - tolerance of distributed systems. It creates network partitions while fuzzing - the system with random operations. The results are analyzed to see if the - system violates any of the consistency properties it claims to have. +Jepsen is a tool to measure the reliability and consistency of distributed systems across network partitions. Learn about the Jepsen testing performed on Consul to ensure it can provide consistent deployments. --- -# Jepsen Testing +# Jepsen Testing Results [Jepsen](http://aphyr.com/posts/281-call-me-maybe-carly-rae-jepsen-and-the-perils-of-network-partitions) is a tool, written by Kyle Kingsbury, designed to test the partition From 9c5de92d9f642858992667fa2391d35fea8fb477 Mon Sep 17 00:00:00 2001 From: boruszak Date: Tue, 13 Sep 2022 15:00:43 -0500 Subject: [PATCH 3/9] /docs/concepts --- website/content/docs/concepts/service-discovery.mdx | 5 ++--- website/content/docs/concepts/service-mesh.mdx | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/website/content/docs/concepts/service-discovery.mdx b/website/content/docs/concepts/service-discovery.mdx index 4038ecce45..4174a277fb 100644 --- a/website/content/docs/concepts/service-discovery.mdx +++ b/website/content/docs/concepts/service-discovery.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Service Discovery +page_title: Service Discovery Explained description: >- - Learn what service discovery is, its benefits, and how it works. - Service mesh can solve many of the modern challenges that exist in multi-platform and multi-cloud application architectures, ranging from security to application resiliency. +Service discovery dynamically catalogs microservices with DNS to help you discover, track, and monitor service instances on your network. Learn about the benefits of service discovery and how it works. --- # What is service discovery? diff --git a/website/content/docs/concepts/service-mesh.mdx b/website/content/docs/concepts/service-mesh.mdx index 63a49550dd..97f2dcf196 100644 --- a/website/content/docs/concepts/service-mesh.mdx +++ b/website/content/docs/concepts/service-mesh.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Service Mesh +page_title: Service Mesh Explained description: >- - Learn what a service mesh is, its benefits, and how it works. - A service mesh can solve many of the modern challenges that exist in multi-platform and multi-cloud application architectures, ranging from security to application resiliency. +Service mesh is a dedicated network layer for secure microservice communication. Learn about its benefits and how to solve challenges in hybrid and multicloud environments with Consul’s service mesh. --- # What is a service mesh? From f76983f1fbdd25983dbe58e734e106195c2b54e4 Mon Sep 17 00:00:00 2001 From: boruszak Date: Tue, 13 Sep 2022 15:22:38 -0500 Subject: [PATCH 4/9] /docs/connect/registration --- website/content/docs/connect/registration/index.mdx | 8 +++----- .../docs/connect/registration/service-registration.mdx | 8 +++----- .../docs/connect/registration/sidecar-service.mdx | 9 ++++----- 3 files changed, 10 insertions(+), 15 deletions(-) diff --git a/website/content/docs/connect/registration/index.mdx b/website/content/docs/connect/registration/index.mdx index 0ca1f65ee2..10144d5d7b 100644 --- a/website/content/docs/connect/registration/index.mdx +++ b/website/content/docs/connect/registration/index.mdx @@ -1,13 +1,11 @@ --- layout: docs -page_title: Connect - Proxy Registration +page_title: Service Mesh Proxy: Overview description: >- - To make connect aware of proxies you will need to register them as Consul - services. This section describes the process and options for proxy - registration. +To make Consul aware of proxies in your service mesh, you must register them. Learn more about proxy registration and sidecar service registration, including differences in how registering works. --- -# Proxy Registration +# Service Mesh Proxy Overview To make Connect aware of proxies you will need to register them in a [service definition](/docs/discovery/services), just like you would register any other service with Consul. This section outlines your options for registering Connect proxies, either using independent registrations, or in nested sidecar registrations. diff --git a/website/content/docs/connect/registration/service-registration.mdx b/website/content/docs/connect/registration/service-registration.mdx index 5b6e8ef598..2cbf884e7a 100644 --- a/website/content/docs/connect/registration/service-registration.mdx +++ b/website/content/docs/connect/registration/service-registration.mdx @@ -1,13 +1,11 @@ --- layout: docs -page_title: Connect - Service Registration +page_title: Service Mesh Proxy: Configuration description: >- - A per-service proxy sidecar transparently handles inbound and outbound service - connections. You can register these sidecars with reasonable defaults by nesting - their definitions in the service definition. +Use service mesh proxy configuration files to define the parameters and behaviors of custom proxies deployed with services in your mesh. Learn about configuration options and how to format them with examples. --- -# Proxy Service Registration +# Service Mesh Proxy Configuration This topic describes how to declare a proxy as a `connect-proxy` in service definitions. The `kind` must be declared and information about the service they represent must be provided to function as a Consul service mesh proxy. diff --git a/website/content/docs/connect/registration/sidecar-service.mdx b/website/content/docs/connect/registration/sidecar-service.mdx index 80c798323f..1cf6f1aeff 100644 --- a/website/content/docs/connect/registration/sidecar-service.mdx +++ b/website/content/docs/connect/registration/sidecar-service.mdx @@ -1,12 +1,11 @@ --- layout: docs -page_title: Connect - Sidecar Service Registration -description: |- - Sidecar service registrations provide a convenient shorthand for registering a - sidecar proxy inline with a regular service definition. +page_title: Service Mesh Proxy: Sidecar Configuration +description: >- +In a service mesh, sidecar proxies run in the same node as service instances and are configured in service definition files. Learn about default settings, customizable parameters, limitations, and lifecycle behaviors. --- -# Sidecar Service Registration +# Service Mesh Proxy Sidecar Configuration Connect proxies are typically deployed as "sidecars" that run on the same node as the single service instance that they handle traffic for. They might be on From 4b6fef4c9743373278c16cb24bea702839ace667 Mon Sep 17 00:00:00 2001 From: boruszak Date: Tue, 13 Sep 2022 15:24:43 -0500 Subject: [PATCH 5/9] /docs/connect/native --- website/content/docs/connect/native/go.mdx | 9 +++------ website/content/docs/connect/native/index.mdx | 8 +++----- 2 files changed, 6 insertions(+), 11 deletions(-) diff --git a/website/content/docs/connect/native/go.mdx b/website/content/docs/connect/native/go.mdx index 43016a851c..f773975267 100644 --- a/website/content/docs/connect/native/go.mdx +++ b/website/content/docs/connect/native/go.mdx @@ -1,14 +1,11 @@ --- layout: docs -page_title: Connect - Native Application Integration - Go +page_title: Service Mesh Native App Integration: Go Apps description: >- - We provide a library that makes it drop-in simple to integrate Connect with - most Go applications. For most Go applications, Connect can be natively - integrated in just a single line of code excluding imports and struct - initialization. +Consul's service mesh supports custom applications written in Go as Consul-Native Integrations. Example code demonstrates how to connect custom apps to your service mesh. --- -# Connect-Native Integration with Go +# Service Mesh Native App Integration with Go -> **Note:** When calling `ConnectAuthorize()` on incoming connections this library will return _deny_ if `Permissions` are defined on the matching intention. diff --git a/website/content/docs/connect/native/index.mdx b/website/content/docs/connect/native/index.mdx index 57b7e461d5..02aad0464e 100644 --- a/website/content/docs/connect/native/index.mdx +++ b/website/content/docs/connect/native/index.mdx @@ -1,13 +1,11 @@ --- layout: docs -page_title: Connect - Native Application Integration +page_title: Service Mesh Native App Integration: Overview description: >- - Applications can natively integrate with the Connect API to support accepting - and establishing connections to other Connect services without the overhead of - a proxy sidecar. +Applications with proxy sidecar issues can be deployed as ""Connect-Native"" integrations in a service mesh instead. Learn how Connect-Native apps use mTLS to authenticate with Consul and how to add integrations to service registrations. --- -# Connect-Native App Integration +# Service Mesh Native App Integration Overview ~> **Note:** The Native App Integration does not support many of the Connect service mesh features, and is not under active development. From df9702f9d1467cefd109acdaf3e301669238e53f Mon Sep 17 00:00:00 2001 From: boruszak Date: Tue, 13 Sep 2022 15:26:51 -0500 Subject: [PATCH 6/9] /docs/connect/l7-traffic --- .../content/docs/connect/l7-traffic/discovery-chain.mdx | 8 +++----- website/content/docs/connect/l7-traffic/index.mdx | 7 +++---- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/website/content/docs/connect/l7-traffic/discovery-chain.mdx b/website/content/docs/connect/l7-traffic/discovery-chain.mdx index 39ea48df5f..19653498fc 100644 --- a/website/content/docs/connect/l7-traffic/discovery-chain.mdx +++ b/website/content/docs/connect/l7-traffic/discovery-chain.mdx @@ -1,13 +1,11 @@ --- layout: docs -page_title: Discovery Chain +page_title: Service Mesh Traffic Management: Discovery Chain description: >- - The service discovery process can be modeled as a "discovery chain" which - passes through three distinct stages: routing, splitting, and resolution. Each - of these stages is controlled by a set of configuration entries. +Discovery chains compile service routing, splitting, and resolution configuration entries to direct traffic to specific instances in a service mesh. Learn about compiled discovery chain results, including discovery graph nodes and targets. --- -# Discovery Chain +# Discovery Chain for Service Mesh Traffic Management -> **1.6.0+:** This feature is available in Consul versions 1.6.0 and newer. diff --git a/website/content/docs/connect/l7-traffic/index.mdx b/website/content/docs/connect/l7-traffic/index.mdx index b01a46e7e0..a3e1a261bd 100644 --- a/website/content/docs/connect/l7-traffic/index.mdx +++ b/website/content/docs/connect/l7-traffic/index.mdx @@ -1,14 +1,13 @@ --- layout: docs -page_title: Connect - L7 Traffic Management +page_title: Service Mesh Traffic Management: Overview description: >- - Layer 7 traffic management allows operators to divide L7 traffic between - different subsets of service instances when using Connect. +Consul can route, split, and resolve Layer 7 traffic in a service mesh to support workflows like canary testing and blue/green deployments. Learn about the three config entry kind that define L7 traffic management behavior in Consul. --- -> **1.6.0+:** This feature is available in Consul versions 1.6.0 and newer. -# L7 Traffic Management +# Service Mesh Traffic Management Overview Layer 7 traffic management allows operators to divide L7 traffic between different From b79fb73468ad9b1df265fdf24d32126309e8d358 Mon Sep 17 00:00:00 2001 From: boruszak Date: Tue, 13 Sep 2022 15:30:45 -0500 Subject: [PATCH 7/9] /docs/connect/ca --- website/content/docs/connect/ca/aws.mdx | 7 +++---- website/content/docs/connect/ca/consul.mdx | 9 +++------ website/content/docs/connect/ca/index.mdx | 7 ++++--- website/content/docs/connect/ca/vault.mdx | 7 +++---- 4 files changed, 13 insertions(+), 17 deletions(-) diff --git a/website/content/docs/connect/ca/aws.mdx b/website/content/docs/connect/ca/aws.mdx index 1c608c2c62..1c3499c353 100644 --- a/website/content/docs/connect/ca/aws.mdx +++ b/website/content/docs/connect/ca/aws.mdx @@ -1,12 +1,11 @@ --- layout: docs -page_title: Connect - Certificate Management +page_title: Service Mesh Certificate Authority: AWS Certificate Manager description: >- - Consul can be used with AWS Certificate Manager Private CA to manage and sign - certificates. +You can use the AWS Certificate Manager Private Certificate Authority instead of Consul's built-in CA to secure your service mesh. Learn how to configure the AWS ACM Private CA, its limitations in Consul, and cost planning considerations. --- -# AWS Certificate Manager Private CA as a Connect CA +# AWS Certificate Manager as a Service Mesh Certificate Authority Consul can be used with [AWS Certificate Manager (ACM) Private Certificate Authority diff --git a/website/content/docs/connect/ca/consul.mdx b/website/content/docs/connect/ca/consul.mdx index 3f65a85e24..8cd00b319a 100644 --- a/website/content/docs/connect/ca/consul.mdx +++ b/website/content/docs/connect/ca/consul.mdx @@ -1,14 +1,11 @@ --- layout: docs -page_title: Connect - Certificate Management +page_title: Service Mesh Certificate Authority: Built-in CA description: >- - Consul ships with a built-in CA system so that Connect can be easily enabled - out of the box. The built-in CA generates and stores the root certificate and - private key on Consul servers. It can also be configured with a custom - certificate and private key if needed. +Consul has a built-in certificate authority for your service mesh that you can configure to work with custom certificates and private keys. Learn how to configure the built-in CA and use it alongside your preferred PKI. --- -# Built-In CA +# Built-In Certificate Authority for Service Mesh Consul ships with a built-in CA system so that Connect can be easily enabled out of the box. The built-in CA generates and stores the diff --git a/website/content/docs/connect/ca/index.mdx b/website/content/docs/connect/ca/index.mdx index 45b9b31498..ff058792df 100644 --- a/website/content/docs/connect/ca/index.mdx +++ b/website/content/docs/connect/ca/index.mdx @@ -1,10 +1,11 @@ --- layout: docs -page_title: Connect - Certificate Management -description: An overview of the Connect Certificate Authority mechanisms. +page_title: Service Mesh Certificate Authority: Overview +description: >- +Consul uses a certificate authority (CA) to generate, use, manage, sign, and store certificates for your service mesh. Learn about certificate management, including configuration, root cert rotation, cross-signing, and regenerating the CA. --- -# Connect Certificate Management +# Service Mesh Certificate Authority Overview Certificate management in Connect is done centrally through the Consul servers using the configured CA (Certificate Authority) provider. A CA provider diff --git a/website/content/docs/connect/ca/vault.mdx b/website/content/docs/connect/ca/vault.mdx index b5f410fa3e..3f99450e33 100644 --- a/website/content/docs/connect/ca/vault.mdx +++ b/website/content/docs/connect/ca/vault.mdx @@ -1,12 +1,11 @@ --- layout: docs -page_title: Connect - Certificate Management +page_title: Service Mesh Certificate Authority: Vault description: >- - Consul can be used with Vault to manage and sign certificates. The Vault CA - provider uses the Vault PKI secrets engine to generate and sign certificates. +You can use the Vault certificate authority instead of Consul’s built-in CA to secure your service mesh. Learn how to configure the Vault CA and manage PKI paths with either Vault or Consul. --- -# Vault as a Connect CA +# Vault as a Service Mesh Certificate Authority Consul can be used with [Vault](https://www.vaultproject.io) to manage and sign certificates. From 2b122dd2624ebece46990440ea2c44587b3982c9 Mon Sep 17 00:00:00 2001 From: boruszak Date: Tue, 13 Sep 2022 15:34:10 -0500 Subject: [PATCH 8/9] /docs/connect/observability --- website/content/docs/connect/observability/index.mdx | 9 ++++----- .../docs/connect/observability/ui-visualization.mdx | 9 ++++----- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/website/content/docs/connect/observability/index.mdx b/website/content/docs/connect/observability/index.mdx index eadc3e498d..f0e173104b 100644 --- a/website/content/docs/connect/observability/index.mdx +++ b/website/content/docs/connect/observability/index.mdx @@ -1,12 +1,11 @@ --- layout: docs -page_title: Connect - Observability -description: |- - This page documents the configurations necessary for L7 observability using - Consul Connect. +page_title: Service Mesh Observability: Overview +description: >- +To use Consul's observability features, configure proxies in the service mesh to collect and emit L7 metrics. Learn about configuring metrics destinations, the service protocol, and upstreams. --- -# Observability +# Service Mesh Observability Overview In order to take advantage of Connect's L7 observability features you will need to: diff --git a/website/content/docs/connect/observability/ui-visualization.mdx b/website/content/docs/connect/observability/ui-visualization.mdx index edbc96defd..d8b5ec7b3d 100644 --- a/website/content/docs/connect/observability/ui-visualization.mdx +++ b/website/content/docs/connect/observability/ui-visualization.mdx @@ -1,12 +1,11 @@ --- layout: docs -page_title: Connect - UI Visualization -description: |- - This page describes how to set up and customize the Service Mesh Topology - visualization in Consul's UI. +page_title: Service Mesh Observability: UI Metrics +description: >- +Consul's UI includes network topology visualization features to display metrics from the service mesh. Learn how to configure the UI to collect metrics, modify access for metrics proxies, and integrate custom metrics providers. --- -# UI Visualization +# UI Metrics for Service Mesh Observability -> Coming here from "Configure metrics dashboard" or "Configure dashboard"? See [Configuring Dashboard URLs](#configuring-dashboard-urls). From 2b171fc893851d2e57f24ef0a062e0a0ef268f6a Mon Sep 17 00:00:00 2001 From: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Date: Thu, 15 Sep 2022 13:58:47 -0500 Subject: [PATCH 9/9] Apply suggestions from code review Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> --- website/content/docs/architecture/anti-entropy.mdx | 2 +- website/content/docs/architecture/consensus.mdx | 2 +- website/content/docs/architecture/coordinates.mdx | 2 +- website/content/docs/architecture/gossip.mdx | 2 +- .../docs/architecture/improving-consul-resilience.mdx | 4 ++-- website/content/docs/architecture/index.mdx | 2 +- website/content/docs/architecture/jepsen.mdx | 4 ++-- website/content/docs/concepts/service-discovery.mdx | 2 +- website/content/docs/concepts/service-mesh.mdx | 2 +- website/content/docs/connect/ca/aws.mdx | 2 +- website/content/docs/connect/ca/consul.mdx | 4 ++-- website/content/docs/connect/ca/vault.mdx | 2 +- website/content/docs/connect/l7-traffic/discovery-chain.mdx | 2 +- website/content/docs/connect/l7-traffic/index.mdx | 2 +- website/content/docs/connect/native/go.mdx | 4 ++-- website/content/docs/connect/native/index.mdx | 2 +- website/content/docs/connect/observability/index.mdx | 2 +- .../content/docs/connect/observability/ui-visualization.mdx | 6 +++--- website/content/docs/connect/registration/index.mdx | 4 ++-- .../docs/connect/registration/service-registration.mdx | 6 +++--- .../content/docs/connect/registration/sidecar-service.mdx | 6 +++--- website/content/docs/internals/index.mdx | 2 +- 22 files changed, 33 insertions(+), 33 deletions(-) diff --git a/website/content/docs/architecture/anti-entropy.mdx b/website/content/docs/architecture/anti-entropy.mdx index 9219d5e041..40cceb7f3b 100644 --- a/website/content/docs/architecture/anti-entropy.mdx +++ b/website/content/docs/architecture/anti-entropy.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Anti-Entropy Enforcement description: >- -Anti-entropy keeps distributed systems consistent. Learn how Consul uses an anti-entropy mechanism to periodically sync agent states with the service catalog to prevent either from becoming stale. +Anti-entropy keeps distributed systems consistent. Learn how Consul uses an anti-entropy mechanism to periodically sync agent states with the service catalog to prevent the catalog from becoming stale. --- # Anti-Entropy Enforcement diff --git a/website/content/docs/architecture/consensus.mdx b/website/content/docs/architecture/consensus.mdx index af74c07d23..d1525cce48 100644 --- a/website/content/docs/architecture/consensus.mdx +++ b/website/content/docs/architecture/consensus.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Consensus Protocol | Raft description: >- -Consul ensures consensus between server logs by using the Raft protocol to elect cluster leaders. Learn how Raft works in Consul and how consistency modes can lower consensus latency. +Consul ensures a consistent state using the Raft protocol. A quorum, or a majority of server agents with one leader, agree to state changes before committing to the state log. Learn how Raft works in Consul to ensure state consistency and how that state can be read with different consistency modes to balance read latency and consistency. --- # Consensus Protocol diff --git a/website/content/docs/architecture/coordinates.mdx b/website/content/docs/architecture/coordinates.mdx index b722b58e11..e70e55f411 100644 --- a/website/content/docs/architecture/coordinates.mdx +++ b/website/content/docs/architecture/coordinates.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Network Coordinates description: >- -Network coordinates are node locations in network tomography used to estimate round trip time (RTT). Learn how network coordinates manifest in Consul, how it calculates RTT, and how to work with coordinates. +Network coordinates are node locations in network tomography used to estimate round trip time (RTT). Learn how network coordinates manifest in Consul, how it calculates RTT, and how to work with coordinates to sort catalog information by nearness to a given node. --- # Network Coordinates diff --git a/website/content/docs/architecture/gossip.mdx b/website/content/docs/architecture/gossip.mdx index a67ced2cc9..4fdab2f75b 100644 --- a/website/content/docs/architecture/gossip.mdx +++ b/website/content/docs/architecture/gossip.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Gossip Protocol | Serf description: >- -Consul agents manage membership and broadcast messages using the Serf protocol. Learn about the differences between LAN and WAN gossip pools and how `serfHealth` affects health checks. +Consul agents manage membership in datacenters and WAN federations using the Serf protocol. Learn about the differences between LAN and WAN gossip pools and how `serfHealth` affects health checks. --- # Gossip Protocol diff --git a/website/content/docs/architecture/improving-consul-resilience.mdx b/website/content/docs/architecture/improving-consul-resilience.mdx index 994127073f..30e8159da5 100644 --- a/website/content/docs/architecture/improving-consul-resilience.mdx +++ b/website/content/docs/architecture/improving-consul-resilience.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Fault Tolerance +page_title: Fault Tolerance in Consul description: >- -Fault tolerance is a system's ability to operate without interruption despite component failure. Learn how quorums provide fault tolerance and improve Consul’s resiliency when servers are deployed across redundancy and availability zones. +Fault tolerance is a system's ability to operate without interruption despite component failure. Learn how a set of Consul servers provide fault tolerance through use of a quorum, and how to further improve control plane resilience through use of infrastructure zones and Enterprise redundancy zones. --- # Fault Tolerance diff --git a/website/content/docs/architecture/index.mdx b/website/content/docs/architecture/index.mdx index 80550feef3..ff7013e71c 100644 --- a/website/content/docs/architecture/index.mdx +++ b/website/content/docs/architecture/index.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Consul Internals Overview +page_title: Consul Architecture description: >- Consul datacenters consist of clusters of server agents (control plane) and client agents deployed alongside service instances (dataplane). Learn how these components and their different communication methods make Consul possible. --- diff --git a/website/content/docs/architecture/jepsen.mdx b/website/content/docs/architecture/jepsen.mdx index 1bcabdc3aa..b03a172207 100644 --- a/website/content/docs/architecture/jepsen.mdx +++ b/website/content/docs/architecture/jepsen.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Jepsen Testing Results +page_title: Consistency Verification | Jepsen Testing Results description: >- -Jepsen is a tool to measure the reliability and consistency of distributed systems across network partitions. Learn about the Jepsen testing performed on Consul to ensure it can provide consistent deployments. +Jepsen is a tool to measure the reliability and consistency of distributed systems across network partitions. Learn about the Jepsen testing performed on Consul to ensure it gracefully recovers from partitions and maintains consistent state. --- # Jepsen Testing Results diff --git a/website/content/docs/concepts/service-discovery.mdx b/website/content/docs/concepts/service-discovery.mdx index 4174a277fb..18d569dc1c 100644 --- a/website/content/docs/concepts/service-discovery.mdx +++ b/website/content/docs/concepts/service-discovery.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Discovery Explained description: >- -Service discovery dynamically catalogs microservices with DNS to help you discover, track, and monitor service instances on your network. Learn about the benefits of service discovery and how it works. +Service discovery dynamically tracks and monitors service instances on your network and makes them discoverable through DNS queries. Learn about the benefits of service discovery and how it works. --- # What is service discovery? diff --git a/website/content/docs/concepts/service-mesh.mdx b/website/content/docs/concepts/service-mesh.mdx index 97f2dcf196..1fdb8292c9 100644 --- a/website/content/docs/concepts/service-mesh.mdx +++ b/website/content/docs/concepts/service-mesh.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Explained description: >- -Service mesh is a dedicated network layer for secure microservice communication. Learn about its benefits and how to solve challenges in hybrid and multicloud environments with Consul’s service mesh. +Service mesh is a dedicated network layer for secure, resilient, observable microservice communication. Learn about using Consul's service mesh to solve service networking challenges in application architectures and manage complexity in multi-cloud, hybrid cloud, and multi-platform environments. --- # What is a service mesh? diff --git a/website/content/docs/connect/ca/aws.mdx b/website/content/docs/connect/ca/aws.mdx index 1c3499c353..92df1530ac 100644 --- a/website/content/docs/connect/ca/aws.mdx +++ b/website/content/docs/connect/ca/aws.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Certificate Authority: AWS Certificate Manager description: >- -You can use the AWS Certificate Manager Private Certificate Authority instead of Consul's built-in CA to secure your service mesh. Learn how to configure the AWS ACM Private CA, its limitations in Consul, and cost planning considerations. +You can use the AWS Certificate Manager Private Certificate Authority as the Consul service mesh's certificate authority to secure your service mesh. Learn how to configure the AWS ACM Private CA, its limitations in Consul, and cost planning considerations. --- # AWS Certificate Manager as a Service Mesh Certificate Authority diff --git a/website/content/docs/connect/ca/consul.mdx b/website/content/docs/connect/ca/consul.mdx index 8cd00b319a..ab1121cdfc 100644 --- a/website/content/docs/connect/ca/consul.mdx +++ b/website/content/docs/connect/ca/consul.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Service Mesh Certificate Authority: Built-in CA +page_title: Certificate Authority: Built-in Service Mesh CA description: >- -Consul has a built-in certificate authority for your service mesh that you can configure to work with custom certificates and private keys. Learn how to configure the built-in CA and use it alongside your preferred PKI. +Consul has a built-in service mesh certificate authority that can be used to secure your service mesh without needing a separate CA system. Learn how to configure the built-in service mesh CA as a root CA or an intermediate CA connected to an existing PKI system. --- # Built-In Certificate Authority for Service Mesh diff --git a/website/content/docs/connect/ca/vault.mdx b/website/content/docs/connect/ca/vault.mdx index 3f99450e33..c660d24089 100644 --- a/website/content/docs/connect/ca/vault.mdx +++ b/website/content/docs/connect/ca/vault.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Certificate Authority: Vault description: >- -You can use the Vault certificate authority instead of Consul’s built-in CA to secure your service mesh. Learn how to configure the Vault CA and manage PKI paths with either Vault or Consul. +You can use a Vault PKI secrets engine as the Consul service mesh's certificate authority to secure your service mesh. Learn how to configure the Vault CA as a root CA or an intermediate CA connected to an existing PKI system, and how to manage PKI paths with either Vault or Consul. --- # Vault as a Service Mesh Certificate Authority diff --git a/website/content/docs/connect/l7-traffic/discovery-chain.mdx b/website/content/docs/connect/l7-traffic/discovery-chain.mdx index 19653498fc..8de9eb4ba1 100644 --- a/website/content/docs/connect/l7-traffic/discovery-chain.mdx +++ b/website/content/docs/connect/l7-traffic/discovery-chain.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Traffic Management: Discovery Chain description: >- -Discovery chains compile service routing, splitting, and resolution configuration entries to direct traffic to specific instances in a service mesh. Learn about compiled discovery chain results, including discovery graph nodes and targets. +The discovery chain compiles service router, splitter, and resolver configuration entries to direct traffic to specific instances in a service mesh. Learn about compiled discovery chain results, including discovery graph nodes and targets. --- # Discovery Chain for Service Mesh Traffic Management diff --git a/website/content/docs/connect/l7-traffic/index.mdx b/website/content/docs/connect/l7-traffic/index.mdx index a3e1a261bd..ab86b71687 100644 --- a/website/content/docs/connect/l7-traffic/index.mdx +++ b/website/content/docs/connect/l7-traffic/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Traffic Management: Overview description: >- -Consul can route, split, and resolve Layer 7 traffic in a service mesh to support workflows like canary testing and blue/green deployments. Learn about the three config entry kind that define L7 traffic management behavior in Consul. +Consul can route, split, and resolve Layer 7 traffic in a service mesh to support workflows like canary testing and blue/green deployments. Learn about the three configuration entry kinds that define L7 traffic management behavior in Consul. --- -> **1.6.0+:** This feature is available in Consul versions 1.6.0 and newer. diff --git a/website/content/docs/connect/native/go.mdx b/website/content/docs/connect/native/go.mdx index f773975267..c047e95bbb 100644 --- a/website/content/docs/connect/native/go.mdx +++ b/website/content/docs/connect/native/go.mdx @@ -2,10 +2,10 @@ layout: docs page_title: Service Mesh Native App Integration: Go Apps description: >- -Consul's service mesh supports custom applications written in Go as Consul-Native Integrations. Example code demonstrates how to connect custom apps to your service mesh. +Consul's service mesh supports native integrations of Go applications into the service mesh through a Go library. Example code demonstrates how to connect your Go applications to the service mesh. --- -# Service Mesh Native App Integration with Go +# Service Mesh Native Integration for Go Applications -> **Note:** When calling `ConnectAuthorize()` on incoming connections this library will return _deny_ if `Permissions` are defined on the matching intention. diff --git a/website/content/docs/connect/native/index.mdx b/website/content/docs/connect/native/index.mdx index 02aad0464e..f8d12481f5 100644 --- a/website/content/docs/connect/native/index.mdx +++ b/website/content/docs/connect/native/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Native App Integration: Overview description: >- -Applications with proxy sidecar issues can be deployed as ""Connect-Native"" integrations in a service mesh instead. Learn how Connect-Native apps use mTLS to authenticate with Consul and how to add integrations to service registrations. +When using sidecar proxies is not possible, applications can natively integrate with Consul service mesh, but have reduced access to service mesh features. Learn how “Connect-Native” apps use mTLS to authenticate with Consul and how to add integrations to service registrations. --- # Service Mesh Native App Integration Overview diff --git a/website/content/docs/connect/observability/index.mdx b/website/content/docs/connect/observability/index.mdx index f0e173104b..9957e7366c 100644 --- a/website/content/docs/connect/observability/index.mdx +++ b/website/content/docs/connect/observability/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Observability: Overview description: >- -To use Consul's observability features, configure proxies in the service mesh to collect and emit L7 metrics. Learn about configuring metrics destinations, the service protocol, and upstreams. +To use Consul's observability features, configure sidecar proxies in the service mesh to collect and emit L7 metrics. Learn about configuring metrics destinations and a service's protocol and upstreams. --- # Service Mesh Observability Overview diff --git a/website/content/docs/connect/observability/ui-visualization.mdx b/website/content/docs/connect/observability/ui-visualization.mdx index d8b5ec7b3d..3afb8848e2 100644 --- a/website/content/docs/connect/observability/ui-visualization.mdx +++ b/website/content/docs/connect/observability/ui-visualization.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Service Mesh Observability: UI Metrics +page_title: Service Mesh Observability: UI Visualization description: >- -Consul's UI includes network topology visualization features to display metrics from the service mesh. Learn how to configure the UI to collect metrics, modify access for metrics proxies, and integrate custom metrics providers. +Consul's UI can display a service's topology and associated metrics from the service mesh. Learn how to configure the UI to collect metrics from your metrics provider, modify access for metrics proxies, and integrate custom metrics providers. --- -# UI Metrics for Service Mesh Observability +# Service Mesh Observability: UI Visualization -> Coming here from "Configure metrics dashboard" or "Configure dashboard"? See [Configuring Dashboard URLs](#configuring-dashboard-urls). diff --git a/website/content/docs/connect/registration/index.mdx b/website/content/docs/connect/registration/index.mdx index 10144d5d7b..dce7510d20 100644 --- a/website/content/docs/connect/registration/index.mdx +++ b/website/content/docs/connect/registration/index.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Service Mesh Proxy: Overview +page_title: Service Mesh Proxy Registration Overview description: >- -To make Consul aware of proxies in your service mesh, you must register them. Learn more about proxy registration and sidecar service registration, including differences in how registering works. +To make Consul aware of proxies in your service mesh, you must register them. Learn about methods for configuring and registering sidecar proxies. --- # Service Mesh Proxy Overview diff --git a/website/content/docs/connect/registration/service-registration.mdx b/website/content/docs/connect/registration/service-registration.mdx index 2cbf884e7a..29495b3c86 100644 --- a/website/content/docs/connect/registration/service-registration.mdx +++ b/website/content/docs/connect/registration/service-registration.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Service Mesh Proxy: Configuration +page_title: Register a Service Mesh Proxy Outside of a Service Registration description: >- -Use service mesh proxy configuration files to define the parameters and behaviors of custom proxies deployed with services in your mesh. Learn about configuration options and how to format them with examples. +You can register a service mesh sidecar proxy separately from the registration of the service instance it fronts. Learn about proxy configuration options and how to format them with examples. --- -# Service Mesh Proxy Configuration +# Register a Service Mesh Proxy Outside of a Service Registration This topic describes how to declare a proxy as a `connect-proxy` in service definitions. The `kind` must be declared and information about the service they represent must be provided to function as a Consul service mesh proxy. diff --git a/website/content/docs/connect/registration/sidecar-service.mdx b/website/content/docs/connect/registration/sidecar-service.mdx index 1cf6f1aeff..e4caadd7c4 100644 --- a/website/content/docs/connect/registration/sidecar-service.mdx +++ b/website/content/docs/connect/registration/sidecar-service.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Service Mesh Proxy: Sidecar Configuration +page_title: Register a Service Mesh Proxy in a Service Registration description: >- -In a service mesh, sidecar proxies run in the same node as service instances and are configured in service definition files. Learn about default settings, customizable parameters, limitations, and lifecycle behaviors. +You can register a service instance and its sidecar proxy at the same time. Learn about default settings, customizable parameters, limitations, and lifecycle behaviors of the sidecar proxy. --- -# Service Mesh Proxy Sidecar Configuration +# Register a Service Mesh Proxy in a Service Registration Connect proxies are typically deployed as "sidecars" that run on the same node as the single service instance that they handle traffic for. They might be on diff --git a/website/content/docs/internals/index.mdx b/website/content/docs/internals/index.mdx index 9dd8c2d648..d34baedab6 100644 --- a/website/content/docs/internals/index.mdx +++ b/website/content/docs/internals/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Internals Overview description: >- -Consul is a complex system that relies on a number of protocols and concepts to work. Learn about Consul's internal properties and how it works under the hood. +To enhance your understanding of how to use, troubleshoot, and secure Consul, learn more about Consul's internal properties and how it works under the hood. --- # Consul Internals Overview