mirror of https://github.com/status-im/consul.git
Merge pull request #14560 from hashicorp/docs/search-desc-batch01
docs: Seach Metadata Batch 01
This commit is contained in:
Jeff Boruszak
GitHub
commit
f1b11e2164
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise Admin Partitions
|
page_title: Admin Partitions (Enterprise)
|
||||||
description: Consul Enterprise enables you to create partitions that can be administrated across namespaces.
|
description: >-
|
||||||
|
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
|
# Consul Enterprise Admin Partitions
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise Audit Logging
|
page_title: Audit Logging (Enterprise)
|
||||||
description: >-
|
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
|
# Audit Logging
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise Automated Backups
|
page_title: Automated Backups (Enterprise)
|
||||||
description: >-
|
description: >-
|
||||||
Consul Enterprise provides a highly available service that manages taking
|
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.
|
||||||
snapshots, rotation and sending backup files offsite to Amazon S3 (or
|
|
||||||
S3-compatible endpoints), Google Cloud Storage, or Azure Blob Storage.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Automated Backups
|
# Automated Backups
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise Advanced Federation
|
page_title: Federated Network Areas (Enterprise)
|
||||||
description: >-
|
description: >-
|
||||||
Consul Enterprise enables you to federate Consul datacenters together on a
|
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.
|
||||||
pairwise basis, enabling partially-connected network topologies like
|
|
||||||
hub-and-spoke.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Enterprise Advanced Federation
|
# Consul Enterprise Advanced Federation
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,7 @@
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise
|
page_title: Consul Enterprise
|
||||||
description: >-
|
description: >-
|
||||||
Consul Enterprise features a number of capabilities beyond the open source
|
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.
|
||||||
offering that may be beneficial in certain workflows.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Enterprise
|
# Consul Enterprise
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise License FAQ
|
page_title: Enterprise License FAQ
|
||||||
description: Frequently Asked Questions pertaining to Consul Enterprise Licensing.
|
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)
|
# Frequently Asked Questions (FAQ)
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise License
|
page_title: Enterprise Licenses
|
||||||
description: Consul Enterprise License Overview.
|
description: >-
|
||||||
|
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
|
# Consul Enterprise License
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise Namespaces
|
page_title: Namespaces (Enterprise)
|
||||||
description: Consul Enterprise enables data isolation with Namespaces.
|
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
|
# Consul Enterprise Namespaces
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise Network Segments
|
page_title: Network Segments (Enterprise)
|
||||||
description: |-
|
description: >-
|
||||||
Consul Enterprise enables you create separate LAN gossip pools within one
|
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.
|
||||||
cluster to segment network groups.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Network Segments
|
# Network Segments
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise Enhanced Read Scalability
|
page_title: Read Replicas (Enterprise)
|
||||||
description: >-
|
description: >-
|
||||||
Consul Enterprise supports increased read scalability without impacting write
|
Learn how you can add non-voting servers to datacenters as read replicas to provide enhanced read scalability without impacting write latency.
|
||||||
latency by introducing read replicas.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Enhanced Read Scalability with Read Replicas
|
# Enhanced Read Scalability with Read Replicas
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise Redundancy Zones
|
page_title: Redundancy Zones (Enterprise)
|
||||||
description: >-
|
description: >-
|
||||||
Consul Enterprise redundancy zones enable hot standby servers on a per
|
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.
|
||||||
availability zone basis.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Redundancy Zones
|
# Redundancy Zones
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Sentinel in Consul
|
page_title: Sentinel in Consul (Enterprise)
|
||||||
description: >-
|
description: >-
|
||||||
Consul Enterprise uses Sentinel to augment the built-in ACL system to provide
|
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.
|
||||||
advanced policy enforcement. Sentinel policies can currently execute on KV
|
|
||||||
modify and service registration.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Sentinel in Consul
|
# Sentinel in Consul
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Consul Enterprise Automated Upgrades
|
page_title: Automated Upgrades (Enterprise)
|
||||||
description: >-
|
description: >-
|
||||||
Consul Enterprise supports an upgrade pattern that allows operators to deploy
|
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.
|
||||||
a complete cluster of new servers and then just wait for the upgrade to
|
|
||||||
complete.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Automated Upgrades
|
# Automated Upgrades
|
||||||
|
|
|
||||||
|
|
@ -1,15 +1,11 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Bootstrapping a Datacenter
|
page_title: Bootstrap a Datacenter
|
||||||
description: >-
|
description: >-
|
||||||
An agent can run in both client and server mode. Server nodes are responsible
|
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.
|
||||||
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
|
# Bootstrap a Datacenter
|
||||||
|
|
||||||
An agent can run in either client or server mode. Server nodes are responsible for running the
|
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.
|
[consensus protocol](/docs/architecture/consensus) and storing the cluster state.
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Cloud Auto-join
|
page_title: Auto-join a Cloud Provider
|
||||||
description: >-
|
description: >-
|
||||||
Consul supports automatically joining a Consul datacenter using cloud metadata
|
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.
|
||||||
on various providers.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Cloud Auto-join
|
# Cloud Auto-join
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,7 @@
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Glossary
|
page_title: Glossary
|
||||||
description: >-
|
description: >-
|
||||||
This page collects brief definitions of some of the technical terms used in
|
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.
|
||||||
the documentation.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Vocabulary
|
# Consul Vocabulary
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Get Started
|
page_title: Install Consul
|
||||||
description: |-
|
description: >-
|
||||||
Installing Consul is simple. You can download a precompiled binary, compile
|
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.
|
||||||
from source or run on Kubernetes. This page details these methods.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Install Consul
|
# Install Consul
|
||||||
|
|
|
||||||
|
|
@ -1,11 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Manual Bootstrapping
|
page_title: Manually Bootstrap a Datacenter
|
||||||
description: >-
|
description: >-
|
||||||
When deploying Consul to a datacenter for the first time, there is an initial
|
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.
|
||||||
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 Bootstrapping a Datacenter
|
# Manually Bootstrapping a Datacenter
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Server Performance
|
page_title: Server Performance Requirements
|
||||||
description: >-
|
description: >-
|
||||||
Consul requires different amounts of compute resources, depending on cluster
|
Consul servers require sufficient compute resources to communicate and process data quickly. Learn about Consul's minimum server requirements and recommendations for different workloads.
|
||||||
size and expected workload. This guide provides guidance on choosing compute
|
|
||||||
resources.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Server Performance
|
# Server Performance
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,7 @@
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Required Ports
|
page_title: Required Ports
|
||||||
description: >-
|
description: >-
|
||||||
Before starting Consul it is important to have the necessary bind ports
|
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.
|
||||||
accessible.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Required Ports
|
# Required Ports
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,7 @@
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: What is Consul?
|
page_title: What is Consul?
|
||||||
description: >-
|
description: >-
|
||||||
Welcome to the intro guide to Consul! This guide is the best place to start
|
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.
|
||||||
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.
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Introduction to Consul
|
# Introduction to Consul
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
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
|
# Common Error Messages
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,8 @@
|
||||||
---
|
---
|
||||||
layout: docs
|
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
|
# Frequently Asked Questions
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue