From 72e53c7698b0a17f879c16476d2878ced9e54672 Mon Sep 17 00:00:00 2001 From: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Date: Thu, 15 Sep 2022 14:29:34 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: Luke Kysow <1034429+lkysow@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/content/docs/connect/cluster-peering/index.mdx | 2 +- website/content/docs/connect/cluster-peering/k8s.mdx | 2 +- .../docs/connect/config-entries/exported-services.mdx | 2 +- website/content/docs/connect/config-entries/index.mdx | 2 +- .../content/docs/connect/config-entries/ingress-gateway.mdx | 2 +- website/content/docs/connect/config-entries/mesh.mdx | 2 +- .../docs/connect/config-entries/service-defaults.mdx | 2 +- .../content/docs/connect/config-entries/service-router.mdx | 2 +- .../docs/connect/config-entries/service-splitter.mdx | 2 +- .../docs/connect/config-entries/terminating-gateway.mdx | 2 +- website/content/docs/connect/configuration.mdx | 2 +- website/content/docs/connect/connect-internals.mdx | 2 +- website/content/docs/connect/connectivity-tasks.mdx | 2 +- website/content/docs/connect/distributed-tracing.mdx | 2 +- website/content/docs/connect/gateways/index.mdx | 2 +- .../mesh-gateway/service-to-service-traffic-datacenters.mdx | 2 +- .../mesh-gateway/service-to-service-traffic-peers.mdx | 2 +- .../mesh-gateway/wan-federation-via-mesh-gateways.mdx | 2 +- .../content/docs/connect/gateways/terminating-gateway.mdx | 2 +- website/content/docs/connect/index.mdx | 2 +- website/content/docs/connect/intentions.mdx | 2 +- website/content/docs/connect/nomad.mdx | 2 +- website/content/docs/connect/proxies/built-in.mdx | 2 +- website/content/docs/connect/proxies/index.mdx | 2 +- website/content/docs/connect/transparent-proxy.mdx | 6 +++--- 25 files changed, 27 insertions(+), 27 deletions(-) diff --git a/website/content/docs/connect/cluster-peering/index.mdx b/website/content/docs/connect/cluster-peering/index.mdx index faad1dc895..7526d7b25e 100644 --- a/website/content/docs/connect/cluster-peering/index.mdx +++ b/website/content/docs/connect/cluster-peering/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh: What is Cluster Peering? description: >- -Peering establishes communication between independent clusters in Consul, allowing services to interact across datacenters. Learn about the cluster peering process, differences with WAN federation, and technical constraints. +Cluster peering establishes communication between independent clusters in Consul, allowing services to interact across datacenters. Learn about the cluster peering process, differences with WAN federation for multi-datacenter deployments, and technical constraints. --- # What is Cluster Peering? diff --git a/website/content/docs/connect/cluster-peering/k8s.mdx b/website/content/docs/connect/cluster-peering/k8s.mdx index e951387207..e85dfccf17 100644 --- a/website/content/docs/connect/cluster-peering/k8s.mdx +++ b/website/content/docs/connect/cluster-peering/k8s.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Cluster Peering on Kubernetes description: >- -The cluster peering process is different when running Consul on Kubernetes. Learn how to enable cluster peering in Helm, create peering CRDs, and then manage peering connections in k8s. +If you use Consul on Kubernetes, learn how to enable cluster peering, create peering CRDs, and then manage peering connections in consul-k8s. --- # Cluster Peering on Kubernetes diff --git a/website/content/docs/connect/config-entries/exported-services.mdx b/website/content/docs/connect/config-entries/exported-services.mdx index 1d28fef112..d14fa027cc 100644 --- a/website/content/docs/connect/config-entries/exported-services.mdx +++ b/website/content/docs/connect/config-entries/exported-services.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Exported Services: Configuration Entry Reference description: >- -The exported services configuration entry kind defines service availability across admin partitions and cluster peerings. Use the reference guide to learn about `""exported-services""` config entry parameters and exporting services to other datacenters. +An exported services configuration entry defines the availability of a cluster's services to cluster peers and local admin partitions. Learn about `"exported-services"` config entry parameters and exporting services to other datacenters. --- # Exported Services Configuration Entry diff --git a/website/content/docs/connect/config-entries/index.mdx b/website/content/docs/connect/config-entries/index.mdx index ae52cc2ed8..74c5e0a0d2 100644 --- a/website/content/docs/connect/config-entries/index.mdx +++ b/website/content/docs/connect/config-entries/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Configuration Entry Overview description: >- -Configuration entries define global proxy behaviors in the service mesh in order to secure and manage traffic. Learn about Consul’s different config entry kind and get links to configuration reference pages. +Configuration entries define service mesh behaviors in order to secure and manage traffic. Learn about Consul’s different config entry kinds and get links to configuration reference pages. --- # Configuration Entry Overview diff --git a/website/content/docs/connect/config-entries/ingress-gateway.mdx b/website/content/docs/connect/config-entries/ingress-gateway.mdx index 89fd4bf61e..d003d1ef22 100644 --- a/website/content/docs/connect/config-entries/ingress-gateway.mdx +++ b/website/content/docs/connect/config-entries/ingress-gateway.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Ingress Gateway: Configuration Entry Reference description: >- -The ingress gateway configuration entry kind defines proxy behavior to secure incoming communication between the service mesh and external sources. Use the reference guide to learn about `""ingress-gateway""` config entry parameters and exposing TCP and HTTP listeners. +The ingress gateway configuration entry kind defines behavior to secure incoming communication between the service mesh and external sources. Use the reference guide to learn about `"ingress-gateway"` config entry parameters and exposing TCP and HTTP listeners. --- # Ingress Gateway Configuration Entry diff --git a/website/content/docs/connect/config-entries/mesh.mdx b/website/content/docs/connect/config-entries/mesh.mdx index 06212ba276..adfaf38b20 100644 --- a/website/content/docs/connect/config-entries/mesh.mdx +++ b/website/content/docs/connect/config-entries/mesh.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Mesh: Configuration Entry Reference description: >- -The mesh configuration entry kind defines global default settings like TLS version requirements for proxies inside the service mesh. Use the reference guide to learn about `""mesh`"" config entry parameters and how to prevent transparent proxies from communicating with services outside of the mesh. +The mesh configuration entry kind defines global default settings like TLS version requirements for proxies inside the service mesh. Use the reference guide to learn about `""mesh""` config entry parameters and how to control communication with services outside of the mesh. --- # Mesh Configuration Entry diff --git a/website/content/docs/connect/config-entries/service-defaults.mdx b/website/content/docs/connect/config-entries/service-defaults.mdx index bee18e7fc7..c49acda62c 100644 --- a/website/content/docs/connect/config-entries/service-defaults.mdx +++ b/website/content/docs/connect/config-entries/service-defaults.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Defaults: Configuration Entry Reference description: >- -The service intentions configuration entry kind defines sets of communication permissions between service types as intentions. Use the reference guide to learn about `""service-intentions""` config entry parameters and how to authorize L4 and L7 communication in the service mesh with intentions. +The service defaults configuration entry kind defines sets of default configurations that apply to all services in the mesh. Use the examples learn how to define a default protocol, default upstream configuration, and default terminating gateway. --- # Service Defaults Configuration Entry diff --git a/website/content/docs/connect/config-entries/service-router.mdx b/website/content/docs/connect/config-entries/service-router.mdx index 1ad4f1b6f2..11a1ba4415 100644 --- a/website/content/docs/connect/config-entries/service-router.mdx +++ b/website/content/docs/connect/config-entries/service-router.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Router: Configuration Entry Reference description: >- -The service router configuration entry kind defines where the service mesh sends requests based on L7 network information. Use the reference guide to learn about `""service-router""` config entry parameters and how you can route requests and set up retries based on HTTP paths. +The service router configuration entry kind defines where the service mesh routes requests based on L7 network information such as header or path. Use the reference guide to learn about `""service-router""` config entry parameters and how behaviors like request timeouts, retry behavior, header modification, and path rewriting can be applied to a request based on its header or path information. --- # Service Router Configuration Entry diff --git a/website/content/docs/connect/config-entries/service-splitter.mdx b/website/content/docs/connect/config-entries/service-splitter.mdx index f5816d5770..ad15fb8e11 100644 --- a/website/content/docs/connect/config-entries/service-splitter.mdx +++ b/website/content/docs/connect/config-entries/service-splitter.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Splitter: Configuration Entry Reference description: >- -The service splitter configuration entry kind defines how to divide service mesh traffic between service instances. Use the reference guide to learn about `""service-splitter""` config entry parameters and traffic management for deploying updated services. +The service splitter configuration entry kind defines how to divide service mesh traffic between service instances. Use the reference guide to learn about `""service-splitter""` config entry parameters and how it can be used for traffic management behaviors like canary rollouts, blue green deployment, and load balancing across environments. --- # Service Splitter Configuration Entry diff --git a/website/content/docs/connect/config-entries/terminating-gateway.mdx b/website/content/docs/connect/config-entries/terminating-gateway.mdx index 4e403dc58c..97973684b7 100644 --- a/website/content/docs/connect/config-entries/terminating-gateway.mdx +++ b/website/content/docs/connect/config-entries/terminating-gateway.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Terminating Gateway: Configuration Entry Reference description: >- -The terminating gateway configuration entry kind defines proxy behavior to secure outgoing communication between the service mesh and external sources. Use the reference guide to learn about `""terminating-gateway""` config entry parameters and connecting service instances without Consul agents to your service mesh. +The terminating gateway configuration entry kind defines behavior to secure outgoing communication between the service mesh and non-mesh services. Use the reference guide to learn about `""terminating-gateway""` config entry parameters and connecting from your service mesh to external or non-mesh services registered with Consul. --- # Terminating Gateway Configuration Entry diff --git a/website/content/docs/connect/configuration.mdx b/website/content/docs/connect/configuration.mdx index b7d2848216..9f79117d97 100644 --- a/website/content/docs/connect/configuration.mdx +++ b/website/content/docs/connect/configuration.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Configuration: Overview description: >- -Consul's service mesh must be enabled before use. Learn how to enable service mesh in agent configurations, the features you can configure, and how schedulers like Kubernetes and Nomad impact configuration. Consul Connect is another name for Consul’s service mesh functions. +Learn how to enable and configure Consul's service mesh capabilities in agent configurations, and how to integrate with schedulers like Kubernetes and Nomad. ""Connect"" is the subsystem that provides Consul’s service mesh capabilities. --- # Service Mesh Configuration Overview diff --git a/website/content/docs/connect/connect-internals.mdx b/website/content/docs/connect/connect-internals.mdx index 1fcc161bb0..52fb1bc4d9 100644 --- a/website/content/docs/connect/connect-internals.mdx +++ b/website/content/docs/connect/connect-internals.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh: How it Works description: >- -Consul's service mesh uses mutual TLS certificates and intentions to identify and authorize agent communication across datacenters. Learn how mTLS, agents, and intentions work together in the service mesh, also called Consul Connect. +Consul's service mesh enforces secure service communication using mutual TLS (mTLS) encryption and explicit authorization. Learn how the service mesh certificate authorities, intentions, and agents work together in the ""Connect"" subsystem to provide Consul’s service mesh capabilities. --- # How Service Mesh Works diff --git a/website/content/docs/connect/connectivity-tasks.mdx b/website/content/docs/connect/connectivity-tasks.mdx index 09d61fd682..a0c608c0f2 100644 --- a/website/content/docs/connect/connectivity-tasks.mdx +++ b/website/content/docs/connect/connectivity-tasks.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Gateway Types description: >- -Mesh, ingress, and terminating gateways are proxies that direct traffic into, out of, and inside of Consul's service mesh. Learn how these gateways enable different kinds of service-to-service communication. +Ingress, terminating, and mesh gateways are proxies that direct traffic into, out of, and inside of Consul's service mesh. Learn how these gateways enable different kinds of service-to-service communication. --- # Types of Gateway Connections in a Service Mesh diff --git a/website/content/docs/connect/distributed-tracing.mdx b/website/content/docs/connect/distributed-tracing.mdx index 6d478394ce..96e61a44d4 100644 --- a/website/content/docs/connect/distributed-tracing.mdx +++ b/website/content/docs/connect/distributed-tracing.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Distributed Tracing description: >- -Distributed tracing tracks the path of a request as it traverses the service mesh. Consul supports distributed tracing for applications that have it implemented. Learn how to implement tracing libraries in your application and configure Consul to use it. +Distributed tracing tracks the path of a request as it traverses the service mesh. Consul supports distributed tracing for applications that have it implemented. Learn how to integrate tracing libraries in your application and configure Consul to participate in that tracing. --- # Distributed Tracing diff --git a/website/content/docs/connect/gateways/index.mdx b/website/content/docs/connect/gateways/index.mdx index 9f614886eb..6e6638dd8a 100644 --- a/website/content/docs/connect/gateways/index.mdx +++ b/website/content/docs/connect/gateways/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Gateways Overview description: >- -Gateways are proxies that direct traffic into, out of, and inside of Consul's service mesh. They secure communication with external network resources and enable services on different runtimes and cloud providers to communicate with each other. +Gateways are proxies that direct traffic into, out of, and inside of Consul's service mesh. They secure communication with external or non-mesh network resources and enable services on different runtimes, cloud providers, or with overlapping IP addresses to communicate with each other. --- # Gateways Overview diff --git a/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters.mdx b/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters.mdx index 6b99fbff18..1f2ca91828 100644 --- a/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters.mdx +++ b/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Mesh Gateways between Datacenters description: >- -Mesh gateways are specialized proxies that route data between services that cannot communicate directly with upstreams. Learn how to enable service-to-service traffic across datacenters and review example configuration entries. +Mesh gateways are specialized proxies that route data between services that cannot communicate directly. Learn how to enable service-to-service traffic across datacenters and review example configuration entries. --- # Mesh Gateways between Datacenters diff --git a/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx b/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx index e8bd0907a8..b8b9b7a7cd 100644 --- a/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx +++ b/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Mesh Gateways between Peered Clusters description: >- -Mesh gateways are specialized proxies that route data between services that cannot communicate directly with upstreams. Learn how to enable service-to-service traffic across clusters that have an established peering connection. +Mesh gateways are specialized proxies that route data between services that cannot communicate directly. Learn how to enable service-to-service traffic across clusters in different datacenters or admin partitions that have an established peering connection. --- # Mesh Gateways between Peered Clusters diff --git a/website/content/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways.mdx b/website/content/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways.mdx index e7f0a71ea6..53997bd4a9 100644 --- a/website/content/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways.mdx +++ b/website/content/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Mesh Gateways for WAN Federation description: >- -You can use mesh gateways to federate deployments, which enables WAN gossip between agents in different datacenters. Forward service requests, use prepared queries, and replicate key/value entries across geographically separated clusters by configuring a primary datacenter. +You can use mesh gateways to simplify the networking requirements for WAN federated Consul datacenters. Mesh gateways reduce cross-datacenter connection paths, ports, and communication protocols. --- # Mesh Gateways for WAN Federation diff --git a/website/content/docs/connect/gateways/terminating-gateway.mdx b/website/content/docs/connect/gateways/terminating-gateway.mdx index f28b81f893..b351c4a280 100644 --- a/website/content/docs/connect/gateways/terminating-gateway.mdx +++ b/website/content/docs/connect/gateways/terminating-gateway.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Terminating Gateway | Service Mesh description: >- -Terminating gateways send requests from inside the service mesh to external network locations, including upstream sources. Learn about requirements and terminating gateway interactions with Consul's service catalog. +Terminating gateways send requests from inside the service mesh to external network locations and services outside the mesh. Learn about requirements and terminating gateway interactions with Consul's service catalog. --- # Terminating Gateways diff --git a/website/content/docs/connect/index.mdx b/website/content/docs/connect/index.mdx index 1392b6dd82..4b2b6a12b0 100644 --- a/website/content/docs/connect/index.mdx +++ b/website/content/docs/connect/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh on Consul description: >- -Consul’s service mesh makes applications secure and observable through encrypted communication, identity-based mTLS authorization, and sidecar proxies. Learn how Consul’s service mesh works and get started on VMs or Kubernetes. +Consul’s service mesh makes application and microservice networking secure and observable with identity-based authentication, mutual TLS (mTLS) encryption, and explicit service-to-service authorization enforced by sidecar proxies. Learn how Consul’s service mesh works and get started on VMs or Kubernetes. --- # Consul Service Mesh diff --git a/website/content/docs/connect/intentions.mdx b/website/content/docs/connect/intentions.mdx index e0a8befe9e..049467f143 100644 --- a/website/content/docs/connect/intentions.mdx +++ b/website/content/docs/connect/intentions.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Intentions description: >- -Intentions define communication access in the service mesh through inbound and outbound connection permissions between microservices. Learn about configuration basics, wildcard intentions, precedence and match order, and protecting intention management with ACLs. +Intentions define communication permissions in the service mesh between microservices. Learn about configuration basics, wildcard intentions, precedence and match order, and protecting intention management with ACLs. --- # Service Mesh Intentions diff --git a/website/content/docs/connect/nomad.mdx b/website/content/docs/connect/nomad.mdx index 46341bbf9e..416fc86a75 100644 --- a/website/content/docs/connect/nomad.mdx +++ b/website/content/docs/connect/nomad.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Sevice Mesh: Nomad Integration description: >- -Consul's service mesh can be applied to Nomad's scheduler and orchestration functions to provide secure communication for Nomad jobs and task groups. Use the guide and reference documentation to learn more. +Consul's service mesh can be applied to provide secure communication between services managed by Nomad's scheduler and orchestrator functions, including Nomad jobs and task groups. Use the guide and reference documentation to learn more. --- # Consul and Nomad Integration diff --git a/website/content/docs/connect/proxies/built-in.mdx b/website/content/docs/connect/proxies/built-in.mdx index 7c628f40a9..0c6f8f516d 100644 --- a/website/content/docs/connect/proxies/built-in.mdx +++ b/website/content/docs/connect/proxies/built-in.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Built-in Proxy Configuration | Service Mesh description: >- -Consul includes a built-in L4 proxy to use for development and testing. Use the built-in proxy config key reference to learn about the options you can configure. +Consul includes a built-in L4 proxy with limited capabilities to use for development and testing only. Use the built-in proxy config key reference to learn about the options you can configure. --- # Built-in Proxy Configuration for Service Mesh diff --git a/website/content/docs/connect/proxies/index.mdx b/website/content/docs/connect/proxies/index.mdx index 5cfc963706..aebab764a2 100644 --- a/website/content/docs/connect/proxies/index.mdx +++ b/website/content/docs/connect/proxies/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Service Mesh Proxy Overview description: >- -Consul deploys sidecar proxies to services, allowing them to connect to the service mesh without modifying the underlying application code. You can use the built-in proxy, Envoy, or a custom proxy to handle communication and verify TLS connections. +In Consul service mesh, each service has a sidecar proxy that secures connections with other services in the mesh without modifying the underlying application code. You can use the built-in proxy, Envoy, or a custom proxy to handle communication and verify TLS connections. --- # Service Mesh Proxy Overview diff --git a/website/content/docs/connect/transparent-proxy.mdx b/website/content/docs/connect/transparent-proxy.mdx index 6d2c535a9c..6843824235 100644 --- a/website/content/docs/connect/transparent-proxy.mdx +++ b/website/content/docs/connect/transparent-proxy.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Transparent Proxy | Service Mesh +page_title: Service Mesh: Enable Transparent Proxy Mode description: >- -Learn how transparent proxies enable Consul on Kubernetes to direct inbound and outbound traffic through the service mesh. Use a transparent proxy to increase application security without configuring individual services and intentions. +Learn how transparent proxy enables Consul on Kubernetes to direct inbound and outbound traffic through the service mesh. Use transparent proxying to increase application security without configuring individual upstream services. --- -# Transparent Proxies in a Service Mesh +# Enable Transparent Proxy Mode Transparent proxy allows applications to communicate through the mesh without changing their configuration. Transparent proxy also hardens application security by preventing direct inbound connections that bypass the mesh.