Skip to content

Commit

Permalink
Merge pull request #14647 from hashicorp/backport/docs/search-metadat…
Browse files Browse the repository at this point in the history
…a-headers/loosely-grown-grub

Backport of docs: Search Description Refresh into release/1.13.x
  • Loading branch information
boruszak committed Sep 15, 2022
2 parents 300fcbf + 2704e1e commit 82023b0
Show file tree
Hide file tree
Showing 138 changed files with 390 additions and 523 deletions.
7 changes: 3 additions & 4 deletions website/content/docs/agent/config-entries.mdx
@@ -1,12 +1,11 @@
---
layout: docs
page_title: Configuration Entries
page_title: How to Use Configuration Entries
description: >-
Consul allows storing configuration entries centrally to be used as defaults
for configuring other aspects of Consul.
Configuration entries define the behavior of Consul service mesh components. Learn how to use the `consul config` command to create, manage, and delete configuration entries.
---

# Configuration Entries
# How to Use Configuration Entries

Configuration entries can be created to provide cluster-wide defaults for
various aspects of Consul.
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/agent/config/cli-flags.mdx
@@ -1,11 +1,11 @@
---
layout: docs
page_title: Consul Agent CLI Reference
page_title: Agents: CLI Reference
description: >-
This topic describes the supported options for configuring Consul agents on the command line.
Add flags to the `consul agent` command to configure agent properties and actions from the CLI. Learn about configurable options and how to format them with examples.
---

# Command-line Options ((#commandline_options))
# Agents Command-line Reference ((#commandline_options))

-> **Note:** Some CLI arguments may be different from HCL keys. See [Configuration Key Reference](/docs/agent/config/config-files#config_key_reference) for equivalent HCL Keys.

Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/agent/config/config-files.mdx
@@ -1,11 +1,11 @@
---
layout: docs
page_title: Consul Agent Configuration Reference
page_title: Agents: Configuration File Reference
description: >-
This topic describes the supported parameters for configuring Consul agents in HCL and JSON configuration files.
Use agent configuration files to assign attributes to agents and configure multiple agents at once. Learn about agent configuration file parameters and formatting with this reference page and sample code.
---

# Configuration Files ((#configuration_files))
# Agents Configuration File Reference ((#configuration_files))

You can create one or more files to configure the Consul agent on startup. We recommend
grouping similar configurations into separate files, such as ACL parameters, to make it
Expand Down
8 changes: 3 additions & 5 deletions website/content/docs/agent/config/index.mdx
@@ -1,13 +1,11 @@
---
layout: docs
page_title: Configuration
page_title: Agents: Configuration Explained
description: >-
The agent has various configuration options that can be specified via the
command-line or via configuration files. All of the configuration options are
completely optional. Defaults are specified with their descriptions.
Agent configuration is the process of defining server and client agent properties with CLI flags and configuration files. Learn what properties can be configured on reload and how Consul sets precedence for configuration settings.
---

# Configuration
# Agent Configuration

The agent has various configuration options that can be specified via
the command-line or via configuration files. All of the configuration
Expand Down
8 changes: 3 additions & 5 deletions website/content/docs/agent/index.mdx
@@ -1,13 +1,11 @@
---
layout: docs
page_title: Agent
page_title: Agents Overview
description: >-
The Consul agent is the core process of Consul. The agent maintains membership
information, registers services, runs checks, responds to queries, and more.
The agent must run on every node that is part of a Consul cluster.
Agents maintain register services, respond to queries, maintain datacenter membership information, and make most of Consul’s functions possible. Learn how to start, stop, and configure agents, as well as their requirements and lifecycle.
---

# Consul Agent
# Agents Overview

This topic provides an overview of the Consul agent, which is the core process of Consul.
The agent maintains membership information, registers services, runs checks, responds to queries, and more.
Expand Down
7 changes: 2 additions & 5 deletions website/content/docs/agent/rpc.mdx
@@ -1,11 +1,8 @@
---
layout: docs
page_title: RPC
page_title: Legacy RPC Protocol
description: >-
The Consul agent provides a complete RPC mechanism that can be used to control
the agent programmatically. This RPC mechanism is the same one used by the CLI
but can be used by other applications to easily leverage the power of Consul
without directly embedding.
Consul agents originally could be controlled through the RPC protocol. This feature was deprecated in version 0.8 in favor of the HTTP API. Learn about agent RPC interactions and how they worked.
---

# RPC Protocol
Expand Down
8 changes: 3 additions & 5 deletions website/content/docs/agent/sentinel.mdx
@@ -1,13 +1,11 @@
---
layout: docs
page_title: Sentinel in Consul
page_title: Sentinel ACL Policies (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 allows you to include conditional logic in access control policies. Learn how Consul can use Sentinel policies to extend the ACL system's capabilities for controlling key-value (KV) write access.
---

# Sentinel Overview
# Sentinel for KV ACL Policy Enforcement

<EnterpriseAlert />

Expand Down
8 changes: 3 additions & 5 deletions website/content/docs/agent/telemetry.mdx
@@ -1,13 +1,11 @@
---
layout: docs
page_title: Telemetry
page_title: Agents: Enable Metrics
description: >-
The Consul agent collects various runtime metrics about the performance of
different libraries and subsystems. These metrics are aggregated on a ten
second interval and are retained for one minute.
Configure agent telemetry to collect operations metrics you can use to debug and observe Consul behavior and performance. Learn about configuration options, the metrics you can collect, and why they're important.
---

# Telemetry
# Agent Telemetry

The Consul agent collects various runtime metrics about the performance of
different libraries and subsystems. These metrics are aggregated on a ten
Expand Down
8 changes: 4 additions & 4 deletions 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 the catalog 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
Expand Down
6 changes: 2 additions & 4 deletions 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 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
Expand Down
3 changes: 2 additions & 1 deletion 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 to sort catalog information by nearness to a given node.
---

# Network Coordinates
Expand Down
8 changes: 2 additions & 6 deletions 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 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
Expand Down
@@ -1,16 +1,11 @@
---
layout: docs
page_title: Improving Consul Resilience
page_title: Fault Tolerance in Consul
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 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.
---

# 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.
Expand Down
6 changes: 2 additions & 4 deletions website/content/docs/architecture/index.mdx
Expand Up @@ -2,12 +2,10 @@
layout: docs
page_title: Consul Architecture
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
Expand Down
9 changes: 3 additions & 6 deletions website/content/docs/architecture/jepsen.mdx
@@ -1,14 +1,11 @@
---
layout: docs
page_title: Jepsen Testing
page_title: Consistency Verification | 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 gracefully recovers from partitions and maintains consistent state.
---

# 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
Expand Down
5 changes: 2 additions & 3 deletions 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 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?
Expand Down
5 changes: 2 additions & 3 deletions 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, 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?
Expand Down
7 changes: 3 additions & 4 deletions 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 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 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
Expand Down
9 changes: 3 additions & 6 deletions website/content/docs/connect/ca/consul.mdx
@@ -1,14 +1,11 @@
---
layout: docs
page_title: Connect - Certificate Management
page_title: Certificate Authority: Built-in Service Mesh 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 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 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
Expand Down
7 changes: 4 additions & 3 deletions 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
Expand Down
7 changes: 3 additions & 4 deletions 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 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 Connect CA
# Vault as a Service Mesh Certificate Authority

Consul can be used with [Vault](https://www.vaultproject.io) to
manage and sign certificates.
Expand Down
@@ -1,11 +1,11 @@
---
layout: docs
page_title: Create and Manage Peering Connections
page_title: Cluster Peering: Create and Manage Connections
description: >-
This page describes how to use the Consul CLI to create, manage, and delete peering connections for cluster peering.
Generate a peering token to establish communication, export services, and authorize requests for cluster peering connections. Learn how to create, list, read, check, and delete peering connections.
---

# Create and Manage Peering Connections
# Create and Manage Cluster Peering Connections

~> **Cluster peering is currently in beta:** Functionality associated with cluster peering is subject to change. You should never use the beta release in secure environments or production scenarios. Features in beta may have performance issues, scaling issues, and limited support.<br /><br />Cluster peering is not currently available in the HCP Consul offering.

Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/connect/cluster-peering/index.mdx
@@ -1,8 +1,8 @@
---
layout: docs
page_title: What is Cluster Peering?
page_title: Service Mesh: What is Cluster Peering?
description: >-
This page details the cluster peering process for connecting Consul clusters across datacenters, including differences between cluster peering and the similar concept of WAN federation.
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?
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/connect/cluster-peering/k8s.mdx
Expand Up @@ -2,7 +2,7 @@
layout: docs
page_title: Cluster Peering on Kubernetes
description: >-
This page describes how to create peering connections, deploy services, export cluster services, and end peering connections for Consul cluster peering using Kubernetes (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
Expand Down
@@ -1,12 +1,11 @@
---
layout: docs
page_title: 'Configuration Entry Kind: Exported Services'
page_title: Exported Services: Configuration Entry Reference
description: >-
The exported-services configuration entry enables you to export services from a single file.
Settings in this configuration entry can apply to services in any namespace of the specified partition. Write access to the mesh resource is required.
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
# Exported Services Configuration Entry

This topic describes the `exported-services` configuration entry type. The `exported-services` configuration entry enables Consul to export service instances to other clusters from a single file and connect services across clusters. For additional information, refer to [Cluster Peering](/docs/connect/cluster-peering) and [Admin Partitions](/docs/enterprise/admin-partitions).

Expand Down
7 changes: 3 additions & 4 deletions website/content/docs/connect/config-entries/index.mdx
@@ -1,12 +1,11 @@
---
layout: docs
page_title: Configuration Entry Definitions
page_title: Configuration Entry Overview
description: >-
Consul allows storing configuration entries centrally to be used as defaults
for configuring other aspects of Consul.
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 Entries
# Configuration Entry Overview

Configuration entries can be used to configure the behavior of Consul Connect.

Expand Down

0 comments on commit 82023b0

Please sign in to comment.