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>
This commit is contained in:
Jeff Boruszak 2022-09-15 14:29:34 -05:00 committed by GitHub
parent 7e40cbc6ac
commit 62b4b4c5cd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
25 changed files with 27 additions and 27 deletions

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Mesh: What is Cluster Peering? page_title: Service Mesh: What is Cluster Peering?
description: >- 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? # What is Cluster Peering?

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Cluster Peering on Kubernetes page_title: Cluster Peering on Kubernetes
description: >- 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 # Cluster Peering on Kubernetes

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Exported Services: Configuration Entry Reference page_title: Exported Services: Configuration Entry Reference
description: >- 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 # Exported Services Configuration Entry

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Configuration Entry Overview page_title: Configuration Entry Overview
description: >- description: >-
Configuration entries define global proxy behaviors in the service mesh in order to secure and manage traffic. Learn about Consuls 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 Consuls different config entry kinds and get links to configuration reference pages.
--- ---
# Configuration Entry Overview # Configuration Entry Overview

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Ingress Gateway: Configuration Entry Reference page_title: Ingress Gateway: Configuration Entry Reference
description: >- 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 # Ingress Gateway Configuration Entry

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Mesh: Configuration Entry Reference page_title: Mesh: Configuration Entry Reference
description: >- 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 # Mesh Configuration Entry

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Defaults: Configuration Entry Reference page_title: Service Defaults: Configuration Entry Reference
description: >- 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 # Service Defaults Configuration Entry

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Router: Configuration Entry Reference page_title: Service Router: Configuration Entry Reference
description: >- 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 # Service Router Configuration Entry

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Splitter: Configuration Entry Reference page_title: Service Splitter: Configuration Entry Reference
description: >- 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 # Service Splitter Configuration Entry

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Terminating Gateway: Configuration Entry Reference page_title: Terminating Gateway: Configuration Entry Reference
description: >- 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 # Terminating Gateway Configuration Entry

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Mesh Configuration: Overview page_title: Service Mesh Configuration: Overview
description: >- 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 Consuls 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 Consuls service mesh capabilities.
--- ---
# Service Mesh Configuration Overview # Service Mesh Configuration Overview

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Mesh: How it Works page_title: Service Mesh: How it Works
description: >- 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 Consuls service mesh capabilities.
--- ---
# How Service Mesh Works # How Service Mesh Works

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Gateway Types page_title: Gateway Types
description: >- 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 # Types of Gateway Connections in a Service Mesh

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Mesh Distributed Tracing page_title: Service Mesh Distributed Tracing
description: >- 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 # Distributed Tracing

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Gateways Overview page_title: Gateways Overview
description: >- 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 # Gateways Overview

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Mesh Gateways between Datacenters page_title: Mesh Gateways between Datacenters
description: >- 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 # Mesh Gateways between Datacenters

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Mesh Gateways between Peered Clusters page_title: Mesh Gateways between Peered Clusters
description: >- 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 # Mesh Gateways between Peered Clusters

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Mesh Gateways for WAN Federation page_title: Mesh Gateways for WAN Federation
description: >- 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 # Mesh Gateways for WAN Federation

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Terminating Gateway | Service Mesh page_title: Terminating Gateway | Service Mesh
description: >- 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 # Terminating Gateways

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Mesh on Consul page_title: Service Mesh on Consul
description: >- description: >-
Consuls service mesh makes applications secure and observable through encrypted communication, identity-based mTLS authorization, and sidecar proxies. Learn how Consuls service mesh works and get started on VMs or Kubernetes. Consuls 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 Consuls service mesh works and get started on VMs or Kubernetes.
--- ---
# Consul Service Mesh # Consul Service Mesh

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Mesh Intentions page_title: Service Mesh Intentions
description: >- 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 # Service Mesh Intentions

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Sevice Mesh: Nomad Integration page_title: Sevice Mesh: Nomad Integration
description: >- 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 # Consul and Nomad Integration

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Built-in Proxy Configuration | Service Mesh page_title: Built-in Proxy Configuration | Service Mesh
description: >- 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 # Built-in Proxy Configuration for Service Mesh

View File

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Service Mesh Proxy Overview page_title: Service Mesh Proxy Overview
description: >- 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 # Service Mesh Proxy Overview

View File

@ -1,11 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Transparent Proxy | Service Mesh page_title: Service Mesh: Enable Transparent Proxy Mode
description: >- 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 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. Transparent proxy also hardens application security by preventing direct inbound connections that bypass the mesh.