Merge pull request #14656 from hashicorp/docs/search-metadata-headers

docs: Search Refresh Fixes
This commit is contained in:
Jeff Boruszak 2022-09-16 11:31:14 -05:00 committed by GitHub
commit 07d076a92c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
135 changed files with 171 additions and 171 deletions

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Agents: CLI Reference page_title: Agents - CLI Reference
description: >- description: >-
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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Agents: Configuration File Reference page_title: Agents - Configuration File Reference
description: >- description: >-
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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Agents: Configuration Explained page_title: Agents - Configuration Explained
description: >- description: >-
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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Agents: Enable Metrics page_title: Agents - Enable Telemetry Metrics
description: >- description: >-
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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Certificate Authority: AWS Certificate Manager page_title: Service Mesh Certificate Authority - AWS Certificate Manager
description: >- description: >-
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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Certificate Authority: Built-in Service Mesh CA page_title: Certificate Authority - Built-in Service Mesh CA
description: >- description: >-
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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Certificate Authority: Overview page_title: Service Mesh Certificate Authority - Overview
description: >- 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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Certificate Authority: Vault page_title: Service Mesh Certificate Authority - Vault
description: >- description: >-
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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Cluster Peering: Create and Manage Connections page_title: Cluster Peering - Create and Manage Connections
description: >- description: >-
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. 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.
--- ---

View file

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

View file

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

@ -1,8 +1,8 @@
--- ---
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 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

@ -1,6 +1,6 @@
--- ---
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 control communication 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Proxy Defaults: Configuration Entry Reference page_title: Proxy Defaults - Configuration Entry Reference
description: >- description: >-
The proxy defaults configuration entry kind defines default behaviors for sidecar proxies in the service mesh. Use the reference guide to learn about `""proxy-defaults""` config entry parameters and how to expose HTTP paths through Envoy. The proxy defaults configuration entry kind defines default behaviors for sidecar proxies in the service mesh. Use the reference guide to learn about `""proxy-defaults""` config entry parameters and how to expose HTTP paths through Envoy.
--- ---

View file

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

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Intentions: Configuration Entry Reference page_title: Service Intentions - Configuration Entry Reference
description: >- description: >-
The service intentions configuration entry kind defines the communication permissions between service types. Use the reference guide to learn about `""service-intentions""` config entry parameters and how to authorize L4 and L7 communication int he service mesh with intentions. The service intentions configuration entry kind defines the communication permissions between service types. Use the reference guide to learn about `""service-intentions""` config entry parameters and how to authorize L4 and L7 communication int he service mesh with intentions.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Resolver: Configuration Entry Reference page_title: Service Resolver - Configuration Entry Reference
description: >- description: >-
The service resolver configuration entry kind defines subsets of service instances that satisfy upstream discovery requests. Use the reference guide to learn about `""service-resolver""` config entry parameters and how filtering by service subsets helps route traffic based on properties like version number. The service resolver configuration entry kind defines subsets of service instances that satisfy upstream discovery requests. Use the reference guide to learn about `""service-resolver""` config entry parameters and how filtering by service subsets helps route traffic based on properties like version number.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
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 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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
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 how it can be used for traffic management behaviors like canary rollouts, blue green deployment, and load balancing across environments. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
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 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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Configuration: Overview page_title: Service Mesh Configuration - Overview
description: >- description: >-
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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh: How it Works page_title: Service Mesh - How it Works
description: >- description: >-
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. 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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Traffic Management: Discovery Chain page_title: Service Mesh Traffic Management - Discovery Chain
description: >- description: >-
The discovery chain compiles service router, splitter, and resolver configuration entries to direct traffic to specific instances in a service mesh. Learn about compiled discovery chain results, including discovery graph nodes and targets. The discovery chain compiles service router, splitter, and resolver configuration entries to direct traffic to specific instances in a service mesh. Learn about compiled discovery chain results, including discovery graph nodes and targets.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Traffic Management: Overview page_title: Service Mesh Traffic Management - Overview
description: >- description: >-
Consul can route, split, and resolve Layer 7 traffic in a service mesh to support workflows like canary testing and blue/green deployments. Learn about the three configuration entry kinds that define L7 traffic management behavior in Consul. Consul can route, split, and resolve Layer 7 traffic in a service mesh to support workflows like canary testing and blue/green deployments. Learn about the three configuration entry kinds that define L7 traffic management behavior in Consul.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Native App Integration: Go Apps page_title: Service Mesh Native App Integration - Go Apps
description: >- description: >-
Consul's service mesh supports native integrations of Go applications into the service mesh through a Go library. Example code demonstrates how to connect your Go applications to the service mesh. Consul's service mesh supports native integrations of Go applications into the service mesh through a Go library. Example code demonstrates how to connect your Go applications to the service mesh.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Native App Integration: Overview page_title: Service Mesh Native App Integration - Overview
description: >- description: >-
When using sidecar proxies is not possible, applications can natively integrate with Consul service mesh, but have reduced access to service mesh features. Learn how “Connect-Native” apps use mTLS to authenticate with Consul and how to add integrations to service registrations. When using sidecar proxies is not possible, applications can natively integrate with Consul service mesh, but have reduced access to service mesh features. Learn how “Connect-Native” apps use mTLS to authenticate with Consul and how to add integrations to service registrations.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
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 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'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.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Observability: Overview page_title: Service Mesh Observability - Overview
description: >- description: >-
To use Consul's observability features, configure sidecar proxies in the service mesh to collect and emit L7 metrics. Learn about configuring metrics destinations and a service's protocol and upstreams. To use Consul's observability features, configure sidecar proxies in the service mesh to collect and emit L7 metrics. Learn about configuring metrics destinations and a service's protocol and upstreams.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Observability: UI Visualization page_title: Service Mesh Observability - UI Visualization
description: >- description: >-
Consul's UI can display a service's topology and associated metrics from the service mesh. Learn how to configure the UI to collect metrics from your metrics provider, modify access for metrics proxies, and integrate custom metrics providers. Consul's UI can display a service's topology and associated metrics from the service mesh. Learn how to configure the UI to collect metrics from your metrics provider, modify access for metrics proxies, and integrate custom metrics providers.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh Security: Best Practices page_title: Service Mesh Security - Best Practices
description: >- description: >-
Consul provides secure service mesh communication by default. Additional configuration can improve network security by preventing unauthorized access and traffic sniffing. Review security considerations, our recommendations, and best practices. Consul provides secure service mesh communication by default. Additional configuration can improve network security by preventing unauthorized access and traffic sniffing. Review security considerations, our recommendations, and best practices.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Service Mesh: Enable Transparent Proxy Mode page_title: Service Mesh - Enable Transparent Proxy Mode
description: >- description: >-
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. 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.
--- ---

View file

@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Automated Backups (Enterprise) page_title: Automated Backups (Enterprise)
description: >- description: >-
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. 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 # Automated Backups

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Access Control List (ACL): Overview page_title: Access Control List (ACL) - Overview
description: >- description: >-
Consul's ACL system secures communication and controls access to the API, CLI, and UI. Learn about ACL components and how they interact to authenticate requests and authorize access for your network. Consul's ACL system secures communication and controls access to the API, CLI, and UI. Learn about ACL components and how they interact to authenticate requests and authorize access for your network.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Security: Overview page_title: Security - Overview
description: >- description: >-
Security requirements and recommendations for Consul vary depending on workloads and environments. Learn how ACLs and encryption can protect access to and communication within your datacenter. Security requirements and recommendations for Consul vary depending on workloads and environments. Learn how ACLs and encryption can protect access to and communication within your datacenter.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Security Models: Consul page_title: Security Models - Consul
description: >- description: >-
The security model for Consul Core details requirements and recommendations for securing your deployment of Consul. Learn about potential threats and how to protect Consul from malicious actors. The security model for Consul Core details requirements and recommendations for securing your deployment of Consul. Learn about potential threats and how to protect Consul from malicious actors.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Security Models: Overview page_title: Security Models - Overview
description: >- description: >-
Security models are the set of requirements and recommendations for securely operating a Consul deployment. Learn about security models and how they differ between environments. Security models are the set of requirements and recommendations for securely operating a Consul deployment. Learn about security models and how they differ between environments.
--- ---

View file

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Security Models: Network Infrastructure Automation (NIA) page_title: Security Models - Network Infrastructure Automation (NIA)
description: >- description: >-
The NIA security model details requirements and recommendations for securing your Consul-Terraform-Sync (CTS) deployment. Learn about potential threats and how to protect CTS from malicious actors. The NIA security model details requirements and recommendations for securing your Consul-Terraform-Sync (CTS) deployment. Learn about potential threats and how to protect CTS from malicious actors.
--- ---