From 7d09a93824470fa07ffd6633cae4874fa33c9611 Mon Sep 17 00:00:00 2001 From: boruszak Date: Fri, 9 Sep 2022 13:27:35 -0500 Subject: [PATCH 1/8] /docs/install pages --- website/content/docs/install/index.mdx | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/website/content/docs/install/index.mdx b/website/content/docs/install/index.mdx index c57fb72d0d..99d0af3ecd 100644 --- a/website/content/docs/install/index.mdx +++ b/website/content/docs/install/index.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Get Started -description: |- - Installing Consul is simple. You can download a precompiled binary, compile - from source or run on Kubernetes. This page details these methods. +page_title: Install Consul +description: >- +Install Consul to get started with service discovery and service mesh. Follow the installation instructions to download the precompiled binary, or use Go to compile from the source manually. --- # Install Consul From e3f6a3a060e597e215652922f4211a7f0a8e1b01 Mon Sep 17 00:00:00 2001 From: boruszak Date: Fri, 9 Sep 2022 13:30:04 -0500 Subject: [PATCH 2/8] /docs/install/index.mdx --- website/content/docs/install/bootstrapping.mdx | 8 ++------ website/content/docs/install/cloud-auto-join.mdx | 5 ++--- website/content/docs/install/glossary.mdx | 3 +-- website/content/docs/install/manual-bootstrap.mdx | 7 ++----- website/content/docs/install/performance.mdx | 6 ++---- website/content/docs/install/ports.mdx | 5 ++--- 6 files changed, 11 insertions(+), 23 deletions(-) diff --git a/website/content/docs/install/bootstrapping.mdx b/website/content/docs/install/bootstrapping.mdx index 849a3fc3c5..23d0d1aeec 100644 --- a/website/content/docs/install/bootstrapping.mdx +++ b/website/content/docs/install/bootstrapping.mdx @@ -1,12 +1,8 @@ --- layout: docs -page_title: Bootstrapping a Datacenter +page_title: Bootstrap a Datacenter description: >- - An agent can run in both client and server mode. Server nodes are responsible - for running the consensus protocol and storing the cluster state. Before a - Consul cluster can begin to service requests, a server node must be elected - leader. Thus, the first nodes that are started are generally the server nodes. - Bootstrapping is the process of joining these server nodes into a cluster. +Bootstrapping a datacenter is the initial deployment process in Consul that starts server agents and joins them together. Learn how to automatically or manually join servers in a cluster. --- # Bootstrapping a Datacenter diff --git a/website/content/docs/install/cloud-auto-join.mdx b/website/content/docs/install/cloud-auto-join.mdx index 3d6072f9b9..47d247d2a1 100644 --- a/website/content/docs/install/cloud-auto-join.mdx +++ b/website/content/docs/install/cloud-auto-join.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Cloud Auto-join +page_title: Auto-join a Cloud Provider description: >- - Consul supports automatically joining a Consul datacenter using cloud metadata - on various providers. +Configure servers to auto-join clusters on startup. Use the CLI or an agent configuration file to specify either an IP address or a cloud provider for the server to join. --- # Cloud Auto-join diff --git a/website/content/docs/install/glossary.mdx b/website/content/docs/install/glossary.mdx index 703761450a..56b444eefa 100644 --- a/website/content/docs/install/glossary.mdx +++ b/website/content/docs/install/glossary.mdx @@ -2,8 +2,7 @@ layout: docs page_title: Glossary description: >- - This page collects brief definitions of some of the technical terms used in - the documentation. +The glossary is a list of technical terms with a specific meaning in Consul. Use the glossary to understand Consul concepts and study for the certification exam. --- # Consul Vocabulary diff --git a/website/content/docs/install/manual-bootstrap.mdx b/website/content/docs/install/manual-bootstrap.mdx index bb72b9aec3..25093e0d92 100644 --- a/website/content/docs/install/manual-bootstrap.mdx +++ b/website/content/docs/install/manual-bootstrap.mdx @@ -1,11 +1,8 @@ --- layout: docs -page_title: Manual Bootstrapping +page_title: Manually Bootstrap a Datacenter description: >- - When deploying Consul to a datacenter for the first time, there is an initial - bootstrapping that must be done. As of Consul 0.4, an automatic bootstrapping - is available and is the recommended approach. However, older versions only - support a manual bootstrap that is documented here. +Manually bootstrap a datacenter to deploy your Consul servers and join them together for the first time. As of Consul v0.4, automatic bootstrapping is recommended instead. --- # Manually Bootstrapping a Datacenter diff --git a/website/content/docs/install/performance.mdx b/website/content/docs/install/performance.mdx index b3e560316a..64062967ec 100644 --- a/website/content/docs/install/performance.mdx +++ b/website/content/docs/install/performance.mdx @@ -1,10 +1,8 @@ --- layout: docs -page_title: Server Performance +page_title: Server Requirements description: >- - Consul requires different amounts of compute resources, depending on cluster - size and expected workload. This guide provides guidance on choosing compute - resources. +Consul servers require computing resources to communicate and process data quickly. Learn about Consul's minimum server requirements and recommendations for different workloads. --- # Server Performance diff --git a/website/content/docs/install/ports.mdx b/website/content/docs/install/ports.mdx index 0923935ba1..bdd48c2cea 100644 --- a/website/content/docs/install/ports.mdx +++ b/website/content/docs/install/ports.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Required Ports +page_title: Port Requirements description: >- - Before starting Consul it is important to have the necessary bind ports - accessible. +Consul requires bind ports for directing DNS, HTTP, gRPC, Serf, and proxy requests. Learn about these reserved ports and how Consul uses them for specific communication functions. --- # Required Ports From 18e18440edff297af91c01222e93c230c5ed10bf Mon Sep 17 00:00:00 2001 From: boruszak Date: Fri, 9 Sep 2022 13:32:41 -0500 Subject: [PATCH 3/8] /docs/troubleshoot --- website/content/docs/troubleshoot/common-errors.mdx | 4 +++- website/content/docs/troubleshoot/faq.mdx | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/website/content/docs/troubleshoot/common-errors.mdx b/website/content/docs/troubleshoot/common-errors.mdx index 2ec8de87c1..9e5ce12358 100644 --- a/website/content/docs/troubleshoot/common-errors.mdx +++ b/website/content/docs/troubleshoot/common-errors.mdx @@ -1,6 +1,8 @@ --- layout: docs -page_title: Common Error Messages +page_title: Common Error Messages | Troubleshoot +description: >- +Troubleshoot issues based on the error message. Common errors result from failed actions, timeouts, multiple entries, bad and expired certificates, invalid characters, syntax parsing, malformed responses, and exceeded deadlines. --- # Common Error Messages diff --git a/website/content/docs/troubleshoot/faq.mdx b/website/content/docs/troubleshoot/faq.mdx index 8c89582ec9..10e5461d4b 100644 --- a/website/content/docs/troubleshoot/faq.mdx +++ b/website/content/docs/troubleshoot/faq.mdx @@ -1,6 +1,8 @@ --- layout: docs -page_title: Frequently Asked Questions +page_title: Common Error Messages | Troubleshoot +description: >- +Troubleshoot issues based on the error message. Common errors result from failed actions, timeouts, multiple entries, bad and expired certificates, invalid characters, syntax parsing, malformed responses, and exceeded deadlines. --- # Frequently Asked Questions From a6cd05933574141ea6606515ac593fc0fa964247 Mon Sep 17 00:00:00 2001 From: boruszak Date: Fri, 9 Sep 2022 13:35:24 -0500 Subject: [PATCH 4/8] /docs/intro --- website/content/docs/intro/index.mdx | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/website/content/docs/intro/index.mdx b/website/content/docs/intro/index.mdx index c1ce0b593c..67c738ac90 100644 --- a/website/content/docs/intro/index.mdx +++ b/website/content/docs/intro/index.mdx @@ -2,11 +2,7 @@ layout: docs page_title: What is Consul? description: >- - Welcome to the intro guide to Consul! This guide is the best place to start - with Consul. We cover what Consul is, what problems it can solve, how it - compares to existing software, and how you can get started using it. If you - are familiar with the basics of Consul, the documentation provides a more - detailed reference of available features. +Consul is a service mesh solution for cloud infrastructure that you can use to deploy, secure, access, and automate microservices across datacenters and providers. Learn how Consul can help you scale operations and provide high availability across your network. --- # Introduction to Consul From eba36ba9b9fb86a9a7fc8e28a188b1b8d6b38ea4 Mon Sep 17 00:00:00 2001 From: boruszak Date: Fri, 9 Sep 2022 13:46:33 -0500 Subject: [PATCH 5/8] /docs/enterprise --- website/content/docs/enterprise/admin-partitions.mdx | 5 +++-- website/content/docs/enterprise/audit-logging.mdx | 4 ++-- website/content/docs/enterprise/backups.mdx | 6 ++---- website/content/docs/enterprise/federation.mdx | 6 ++---- website/content/docs/enterprise/index.mdx | 3 +-- website/content/docs/enterprise/namespaces.mdx | 5 +++-- website/content/docs/enterprise/network-segments.mdx | 7 +++---- website/content/docs/enterprise/read-scale.mdx | 5 ++--- website/content/docs/enterprise/redundancy.mdx | 5 ++--- website/content/docs/enterprise/sentinel.mdx | 6 ++---- website/content/docs/enterprise/upgrades.mdx | 6 ++---- 11 files changed, 24 insertions(+), 34 deletions(-) diff --git a/website/content/docs/enterprise/admin-partitions.mdx b/website/content/docs/enterprise/admin-partitions.mdx index e73d330c03..d3c55a7b0b 100644 --- a/website/content/docs/enterprise/admin-partitions.mdx +++ b/website/content/docs/enterprise/admin-partitions.mdx @@ -1,7 +1,8 @@ --- layout: docs -page_title: Consul Enterprise Admin Partitions -description: Consul Enterprise enables you to create partitions that can be administrated across namespaces. +page_title: Admin Partitions (Enterprise) +description: >- +Enable multi-tenancy in a datacenter by using admin partitions to define the boundaries between services managed by separate teams. Learn about their requirements and how to deploy admin partitions on Kubernetes. --- # Consul Enterprise Admin Partitions diff --git a/website/content/docs/enterprise/audit-logging.mdx b/website/content/docs/enterprise/audit-logging.mdx index 90f876f434..fc21432323 100644 --- a/website/content/docs/enterprise/audit-logging.mdx +++ b/website/content/docs/enterprise/audit-logging.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Consul Enterprise Audit Logging +page_title: Audit Logging (Enterprise) description: >- - Consul Enterprise provides the ability to write events of user behavior with Consul's API so operations and security users can perform legal compliance auditing. +Audit logging secures Consul by capturing a record of HTTP API access and usage. Learn how to format agent configuration files to enable audit logs and specify the path to save logs to. --- # Audit Logging diff --git a/website/content/docs/enterprise/backups.mdx b/website/content/docs/enterprise/backups.mdx index 0a99c68b3b..1476f37c6c 100644 --- a/website/content/docs/enterprise/backups.mdx +++ b/website/content/docs/enterprise/backups.mdx @@ -1,10 +1,8 @@ --- layout: docs -page_title: Consul Enterprise Automated Backups +page_title: Automated Backups (Enterprise) description: >- - Consul Enterprise provides a highly available service that manages taking - snapshots, rotation and sending backup files offsite to Amazon S3 (or - S3-compatible endpoints), Google Cloud Storage, or Azure Blob Storage. +The automated backup process runs a snapshot agent and saves backup files to a cloud storage provider so that you can restore Consul servers. Supported providers include: Amazon S3, Google Cloud Storage, and Azure Blob Storage. --- # Automated Backups diff --git a/website/content/docs/enterprise/federation.mdx b/website/content/docs/enterprise/federation.mdx index e43aabd41e..49beb610fc 100644 --- a/website/content/docs/enterprise/federation.mdx +++ b/website/content/docs/enterprise/federation.mdx @@ -1,10 +1,8 @@ --- layout: docs -page_title: Consul Enterprise Advanced Federation +page_title: Advanced Federation (Enterprise) description: >- - Consul Enterprise enables you to federate Consul datacenters together on a - pairwise basis, enabling partially-connected network topologies like - hub-and-spoke. +Advanced federation connects partial network areas through paired servers. Learn how to support hub-and-spoke and tree network topologies in your Consul deployment. --- # Consul Enterprise Advanced Federation diff --git a/website/content/docs/enterprise/index.mdx b/website/content/docs/enterprise/index.mdx index 8375a32371..dbb28719f3 100644 --- a/website/content/docs/enterprise/index.mdx +++ b/website/content/docs/enterprise/index.mdx @@ -2,8 +2,7 @@ layout: docs page_title: Consul Enterprise description: >- - Consul Enterprise features a number of capabilities beyond the open source - offering that may be beneficial in certain workflows. +Consul Enterprise is a paid offering that adds features to support large and complex deployments. Learn how Enterprise can help you scale infrastructure, simplify operations, and make networks more resilient. --- # Consul Enterprise diff --git a/website/content/docs/enterprise/namespaces.mdx b/website/content/docs/enterprise/namespaces.mdx index 612c47a65a..598d2c8e5d 100644 --- a/website/content/docs/enterprise/namespaces.mdx +++ b/website/content/docs/enterprise/namespaces.mdx @@ -1,7 +1,8 @@ --- layout: docs -page_title: Consul Enterprise Namespaces -description: Consul Enterprise enables data isolation with Namespaces. +page_title: Namespaces (Enterprise) +description: >- +Namespaces reduce operational challenges in large deployments. Learn how to define a namespace so that multiple users or teams can access and use the same datacenter without impacting each other. --- # Consul Enterprise Namespaces diff --git a/website/content/docs/enterprise/network-segments.mdx b/website/content/docs/enterprise/network-segments.mdx index 000316c6bc..9787c9df17 100644 --- a/website/content/docs/enterprise/network-segments.mdx +++ b/website/content/docs/enterprise/network-segments.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Consul Enterprise Network Segments -description: |- - Consul Enterprise enables you create separate LAN gossip pools within one - cluster to segment network groups. +page_title: Network Segments (Enterprise) +description: >- +Network segments enable gossip in a datacenter when network rules or firewalls prevent clients from communicating directly. Learn how to configure server and client agents to use segmented networks. --- # Network Segments diff --git a/website/content/docs/enterprise/read-scale.mdx b/website/content/docs/enterprise/read-scale.mdx index c33f0d774f..f6536b0e64 100644 --- a/website/content/docs/enterprise/read-scale.mdx +++ b/website/content/docs/enterprise/read-scale.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Consul Enterprise Enhanced Read Scalability +page_title: Read Replicas (Enterprise) description: >- - Consul Enterprise supports increased read scalability without impacting write - latency by introducing read replicas. +Learn how you can add non-voting servers to clusters as read replicas to provide enhanced read scalability without impacting write latency. --- # Enhanced Read Scalability with Read Replicas diff --git a/website/content/docs/enterprise/redundancy.mdx b/website/content/docs/enterprise/redundancy.mdx index 3a7fa145de..50d822c19c 100644 --- a/website/content/docs/enterprise/redundancy.mdx +++ b/website/content/docs/enterprise/redundancy.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Consul Enterprise Redundancy Zones +page_title: Redundancy Zones (Enterprise) description: >- - Consul Enterprise redundancy zones enable hot standby servers on a per - availability zone basis. +Add non-voting servers to clusters to create redundancy zones for deployments. Learn how distributed ""hot standby"" servers improve resiliency and scaling by preserving quorum. --- # Redundancy Zones diff --git a/website/content/docs/enterprise/sentinel.mdx b/website/content/docs/enterprise/sentinel.mdx index 1eff5aecdb..3cbf7ed358 100644 --- a/website/content/docs/enterprise/sentinel.mdx +++ b/website/content/docs/enterprise/sentinel.mdx @@ -1,10 +1,8 @@ --- layout: docs -page_title: Sentinel in Consul +page_title: Sentinel in Consul (Enterprise) description: >- - Consul Enterprise uses Sentinel to augment the built-in ACL system to provide - advanced policy enforcement. Sentinel policies can currently execute on KV - modify and service registration. +Sentinel is a framework and language for creating logic-based policies. Learn how Consul can use Sentinel policies to extend the ACL system's capabilities. --- # Sentinel in Consul diff --git a/website/content/docs/enterprise/upgrades.mdx b/website/content/docs/enterprise/upgrades.mdx index 05b1ca7ae6..82bf174ee3 100644 --- a/website/content/docs/enterprise/upgrades.mdx +++ b/website/content/docs/enterprise/upgrades.mdx @@ -1,10 +1,8 @@ --- layout: docs -page_title: Consul Enterprise Automated Upgrades +page_title: Automated Upgrades (Enterprise) description: >- - Consul Enterprise supports an upgrade pattern that allows operators to deploy - a complete cluster of new servers and then just wait for the upgrade to - complete. +Automated upgrades simplify the process for updating Consul. Learn how Consul can deploy a new version on additional servers and then automatically remove outdated versions without server downtime. --- # Automated Upgrades From 8d181dacd681f17cf09688fa85f3f6a63f65e1a6 Mon Sep 17 00:00:00 2001 From: boruszak Date: Fri, 9 Sep 2022 14:57:15 -0500 Subject: [PATCH 6/8] /docs/enterprise/license --- website/content/docs/enterprise/license/faq.mdx | 5 +++-- website/content/docs/enterprise/license/overview.mdx | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/website/content/docs/enterprise/license/faq.mdx b/website/content/docs/enterprise/license/faq.mdx index 2debc88ad4..08d7c888c2 100644 --- a/website/content/docs/enterprise/license/faq.mdx +++ b/website/content/docs/enterprise/license/faq.mdx @@ -1,7 +1,8 @@ --- layout: docs -page_title: Consul Enterprise License FAQ -description: Frequently Asked Questions pertaining to Consul Enterprise Licensing. +page_title: Enterprise License FAQ +description: >- +Review frequently asked questions (FAQs) about Consul Enterprise licenses to learn more about how licenses work, what happens when they expire, and how to get a trial license. --- # Frequently Asked Questions (FAQ) diff --git a/website/content/docs/enterprise/license/overview.mdx b/website/content/docs/enterprise/license/overview.mdx index be1f529608..b08b43344d 100644 --- a/website/content/docs/enterprise/license/overview.mdx +++ b/website/content/docs/enterprise/license/overview.mdx @@ -1,7 +1,8 @@ --- layout: docs -page_title: Consul Enterprise License -description: Consul Enterprise License Overview. +page_title: Enterprise Licenses +description: >- +Consul server, client, and snapshot agents require a license in order to use Enterprise features. Learn how to apply licenses to environment variables and configuration files. --- # Consul Enterprise License From a208928c2f48c25f6e39aca2f5c5262c350e1b83 Mon Sep 17 00:00:00 2001 From: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Date: Thu, 15 Sep 2022 09:46:06 -0500 Subject: [PATCH 7/8] Update website/content/docs/enterprise/admin-partitions.mdx --- website/content/docs/enterprise/admin-partitions.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/enterprise/admin-partitions.mdx b/website/content/docs/enterprise/admin-partitions.mdx index d3c55a7b0b..0360f68a94 100644 --- a/website/content/docs/enterprise/admin-partitions.mdx +++ b/website/content/docs/enterprise/admin-partitions.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Admin Partitions (Enterprise) description: >- -Enable multi-tenancy in a datacenter by using admin partitions to define the boundaries between services managed by separate teams. Learn about their requirements and how to deploy admin partitions on Kubernetes. +Admin partitions define boundaries between services managed by separate teams, enabling a service mesh across k8s clusters controlled by a single Consul server. Learn about their requirements and how to deploy admin partitions on Kubernetes. --- # Consul Enterprise Admin Partitions From 2a86195f2265b465a38ec02199ab8f2efd347c22 Mon Sep 17 00:00:00 2001 From: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Date: Thu, 15 Sep 2022 10:32:23 -0500 Subject: [PATCH 8/8] Apply suggestions from code review Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: Tu Nguyen Co-authored-by: Luke Kysow <1034429+lkysow@users.noreply.github.com> --- website/content/docs/enterprise/backups.mdx | 2 +- website/content/docs/enterprise/federation.mdx | 4 ++-- website/content/docs/enterprise/index.mdx | 2 +- website/content/docs/enterprise/license/overview.mdx | 2 +- website/content/docs/enterprise/network-segments.mdx | 2 +- website/content/docs/enterprise/read-scale.mdx | 2 +- website/content/docs/enterprise/redundancy.mdx | 2 +- website/content/docs/enterprise/sentinel.mdx | 2 +- website/content/docs/enterprise/upgrades.mdx | 2 +- website/content/docs/install/bootstrapping.mdx | 2 +- website/content/docs/install/cloud-auto-join.mdx | 2 +- website/content/docs/install/index.mdx | 2 +- website/content/docs/install/manual-bootstrap.mdx | 2 +- website/content/docs/install/performance.mdx | 4 ++-- website/content/docs/install/ports.mdx | 4 ++-- website/content/docs/troubleshoot/common-errors.mdx | 2 +- 16 files changed, 19 insertions(+), 19 deletions(-) diff --git a/website/content/docs/enterprise/backups.mdx b/website/content/docs/enterprise/backups.mdx index 1476f37c6c..a90825a892 100644 --- a/website/content/docs/enterprise/backups.mdx +++ b/website/content/docs/enterprise/backups.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Automated Backups (Enterprise) description: >- -The automated backup process runs a snapshot agent and saves backup files to a cloud storage provider so that you can restore Consul servers. Supported providers include: Amazon S3, Google Cloud Storage, and Azure Blob Storage. +Learn about launching the snapshot agent to automatically backup files to a cloud storage provider so that you can restore Consul servers. Supported providers include: Amazon S3, Google Cloud Storage, and Azure Blob Storage. --- # Automated Backups diff --git a/website/content/docs/enterprise/federation.mdx b/website/content/docs/enterprise/federation.mdx index 49beb610fc..0f96d6a4d8 100644 --- a/website/content/docs/enterprise/federation.mdx +++ b/website/content/docs/enterprise/federation.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Advanced Federation (Enterprise) +page_title: Federated Network Areas (Enterprise) description: >- -Advanced federation connects partial network areas through paired servers. Learn how to support hub-and-spoke and tree network topologies in your Consul deployment. +Network areas connect individual datacenters in a WAN federation, providing an alternative to connecting every datacenter. Learn how to support hub-and-spoke network topologies in a WAN federated Consul deployment. --- # Consul Enterprise Advanced Federation diff --git a/website/content/docs/enterprise/index.mdx b/website/content/docs/enterprise/index.mdx index dbb28719f3..c0d9026316 100644 --- a/website/content/docs/enterprise/index.mdx +++ b/website/content/docs/enterprise/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Consul Enterprise description: >- -Consul Enterprise is a paid offering that adds features to support large and complex deployments. Learn how Enterprise can help you scale infrastructure, simplify operations, and make networks more resilient. +Consul Enterprise is a paid offering that extends Consul’s open source functions to support large and complex deployments. Learn about scaling infrastructure, simplifying operations, and making networks more resilient with Enterprise. --- # Consul Enterprise diff --git a/website/content/docs/enterprise/license/overview.mdx b/website/content/docs/enterprise/license/overview.mdx index b08b43344d..329a9ed76e 100644 --- a/website/content/docs/enterprise/license/overview.mdx +++ b/website/content/docs/enterprise/license/overview.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Enterprise Licenses description: >- -Consul server, client, and snapshot agents require a license in order to use Enterprise features. Learn how to apply licenses to environment variables and configuration files. +Consul Enterprise server, client, and snapshot agents require a license on startup in order to use Enterprise features. Learn how to apply licenses using environment variables or configuration files. --- # Consul Enterprise License diff --git a/website/content/docs/enterprise/network-segments.mdx b/website/content/docs/enterprise/network-segments.mdx index 9787c9df17..8b6b7ce951 100644 --- a/website/content/docs/enterprise/network-segments.mdx +++ b/website/content/docs/enterprise/network-segments.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Network Segments (Enterprise) description: >- -Network segments enable gossip in a datacenter when network rules or firewalls prevent clients from communicating directly. Learn how to configure server and client agents to use segmented networks. +Network segments enable LAN gossip in a datacenter when network rules or firewalls prevent specific sets of clients from communicating directly. Learn about configuring server and client agents to operate in segmented networks. --- # Network Segments diff --git a/website/content/docs/enterprise/read-scale.mdx b/website/content/docs/enterprise/read-scale.mdx index f6536b0e64..25629f057b 100644 --- a/website/content/docs/enterprise/read-scale.mdx +++ b/website/content/docs/enterprise/read-scale.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Read Replicas (Enterprise) description: >- -Learn how you can add non-voting servers to clusters as read replicas to provide enhanced read scalability without impacting write latency. +Learn how you can add non-voting servers to datacenters as read replicas to provide enhanced read scalability without impacting write latency. --- # Enhanced Read Scalability with Read Replicas diff --git a/website/content/docs/enterprise/redundancy.mdx b/website/content/docs/enterprise/redundancy.mdx index 50d822c19c..e5d3a2433d 100644 --- a/website/content/docs/enterprise/redundancy.mdx +++ b/website/content/docs/enterprise/redundancy.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Redundancy Zones (Enterprise) description: >- -Add non-voting servers to clusters to create redundancy zones for deployments. Learn how distributed ""hot standby"" servers improve resiliency and scaling by preserving quorum. +Redundancy zones are regions of a cluster containing "hot standby" servers, or non-voting servers that can replace voting servers in the event of a failure. Learn about redundancy zones and how they improve resiliency and increase fault tolerance without affecting latency. --- # Redundancy Zones diff --git a/website/content/docs/enterprise/sentinel.mdx b/website/content/docs/enterprise/sentinel.mdx index 3cbf7ed358..cafb05fca1 100644 --- a/website/content/docs/enterprise/sentinel.mdx +++ b/website/content/docs/enterprise/sentinel.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Sentinel in Consul (Enterprise) description: >- -Sentinel is a framework and language for creating logic-based policies. Learn how Consul can use Sentinel policies to extend the ACL system's capabilities. +Sentinel is an access-control-policy-as-code framework and language. Learn how Consul can use Sentinel policies to extend the ACL system's capabilities and further secure your clusters by controlling key-value (KV) store write access. --- # Sentinel in Consul diff --git a/website/content/docs/enterprise/upgrades.mdx b/website/content/docs/enterprise/upgrades.mdx index 82bf174ee3..9e72b9423a 100644 --- a/website/content/docs/enterprise/upgrades.mdx +++ b/website/content/docs/enterprise/upgrades.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Automated Upgrades (Enterprise) description: >- -Automated upgrades simplify the process for updating Consul. Learn how Consul can deploy a new version on additional servers and then automatically remove outdated versions without server downtime. +Automated upgrades simplify the process for updating Consul. Learn how Consul can gracefully transition from existing server agents to a new set of server agents without Consul downtime. --- # Automated Upgrades diff --git a/website/content/docs/install/bootstrapping.mdx b/website/content/docs/install/bootstrapping.mdx index 23d0d1aeec..3d1824b500 100644 --- a/website/content/docs/install/bootstrapping.mdx +++ b/website/content/docs/install/bootstrapping.mdx @@ -5,7 +5,7 @@ description: >- Bootstrapping a datacenter is the initial deployment process in Consul that starts server agents and joins them together. Learn how to automatically or manually join servers in a cluster. --- -# Bootstrapping a Datacenter +# Bootstrap a Datacenter An agent can run in either client or server mode. Server nodes are responsible for running the [consensus protocol](/docs/architecture/consensus) and storing the cluster state. diff --git a/website/content/docs/install/cloud-auto-join.mdx b/website/content/docs/install/cloud-auto-join.mdx index 47d247d2a1..0d2ff059e8 100644 --- a/website/content/docs/install/cloud-auto-join.mdx +++ b/website/content/docs/install/cloud-auto-join.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Auto-join a Cloud Provider description: >- -Configure servers to auto-join clusters on startup. Use the CLI or an agent configuration file to specify either an IP address or a cloud provider for the server to join. +Auto-join enables agents to automatically join other agents running in the cloud. To configure auto-join, specify agent addresses with compute node metadata for the cloud provider instead of an IP address. Use the CLI or an agent configuration file to configure cloud auto-join. --- # Cloud Auto-join diff --git a/website/content/docs/install/index.mdx b/website/content/docs/install/index.mdx index 99d0af3ecd..fe092cda7e 100644 --- a/website/content/docs/install/index.mdx +++ b/website/content/docs/install/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Install Consul description: >- -Install Consul to get started with service discovery and service mesh. Follow the installation instructions to download the precompiled binary, or use Go to compile from the source manually. +Install Consul to get started with service discovery and service mesh. Follow the installation instructions to download the precompiled binary, or use Go to compile from source. --- # Install Consul diff --git a/website/content/docs/install/manual-bootstrap.mdx b/website/content/docs/install/manual-bootstrap.mdx index 25093e0d92..eeaf6e7ec3 100644 --- a/website/content/docs/install/manual-bootstrap.mdx +++ b/website/content/docs/install/manual-bootstrap.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Manually Bootstrap a Datacenter description: >- -Manually bootstrap a datacenter to deploy your Consul servers and join them together for the first time. As of Consul v0.4, automatic bootstrapping is recommended instead. +Manually bootstrap a datacenter to deploy your Consul servers and join them together for the first time. For Consul v0.4+, we recommend automatic bootstrapping instead. --- # Manually Bootstrapping a Datacenter diff --git a/website/content/docs/install/performance.mdx b/website/content/docs/install/performance.mdx index 64062967ec..b0185dc076 100644 --- a/website/content/docs/install/performance.mdx +++ b/website/content/docs/install/performance.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Server Requirements +page_title: Server Performance Requirements description: >- -Consul servers require computing resources to communicate and process data quickly. Learn about Consul's minimum server requirements and recommendations for different workloads. +Consul servers require sufficient compute resources to communicate and process data quickly. Learn about Consul's minimum server requirements and recommendations for different workloads. --- # Server Performance diff --git a/website/content/docs/install/ports.mdx b/website/content/docs/install/ports.mdx index bdd48c2cea..d3479f5286 100644 --- a/website/content/docs/install/ports.mdx +++ b/website/content/docs/install/ports.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Port Requirements +page_title: Required Ports description: >- -Consul requires bind ports for directing DNS, HTTP, gRPC, Serf, and proxy requests. Learn about these reserved ports and how Consul uses them for specific communication functions. +Consul requires multiple ports for directing DNS, HTTP, gRPC, gossip, and sidecar proxy requests. Learn about required and optional ports, and how Consul uses them for specific communication functions. --- # Required Ports diff --git a/website/content/docs/troubleshoot/common-errors.mdx b/website/content/docs/troubleshoot/common-errors.mdx index 9e5ce12358..ce3649e630 100644 --- a/website/content/docs/troubleshoot/common-errors.mdx +++ b/website/content/docs/troubleshoot/common-errors.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Common Error Messages | Troubleshoot +page_title: Common Error Messages - Troubleshoot description: >- Troubleshoot issues based on the error message. Common errors result from failed actions, timeouts, multiple entries, bad and expired certificates, invalid characters, syntax parsing, malformed responses, and exceeded deadlines. ---