mirror of https://github.com/status-im/consul.git
Apply suggestions from code review
Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>
This commit is contained in:
Jeff Boruszak
GitHub
parent
f91f01c891
commit
0dba086cdb
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: How to Use Configuration Entries
|
||||
description: >-
|
||||
Configuration entries define default properties for Consul components. Learn how to use the `consul config` command to create, manage, and delete configuration entries.
|
||||
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.
|
||||
---
|
||||
|
||||
# How to Use Configuration Entries
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Agents: Configuration File Reference
|
||||
description: >-
|
||||
Use agent configuration files to assign attributes to agents on startup. 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.
|
||||
---
|
||||
|
||||
# Agents Configuration File Reference ((#configuration_files))
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Agents: Configuration Explained
|
||||
description: >-
|
||||
Agent configuration is the process of defining server and client agents with CLI flags and definition 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.
|
||||
---
|
||||
|
||||
# Agent Configuration
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Agents Overview
|
||||
description: >-
|
||||
Agents maintain membership, register services, respond to queries, and make most of Consul’s functions possible. Learn how to start, stop, and configure agents, as well as their requirements and lifecycles.
|
||||
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.
|
||||
---
|
||||
|
||||
# Agents Overview
|
||||
|
|
|
|||
|
|
@ -2,10 +2,10 @@
|
|||
layout: docs
|
||||
page_title: Sentinel ACL Policies (Enterprise)
|
||||
description: >-
|
||||
Sentinel allows you to include conditional logic when formatting policies. Learn how Consul can use Sentinel policies to extend the ACL system's capabilities.
|
||||
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 ACL Policies
|
||||
# Sentinel for KV ACL Policy Enforcement
|
||||
|
||||
<EnterpriseAlert />
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Agents: Enable Metrics
|
||||
description: >-
|
||||
Configure agent telemetry to collect operations metrics you can use to debug and observe deployments. 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.
|
||||
---
|
||||
|
||||
# Agent Telemetry
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Configure Health Checks
|
||||
description: >-
|
||||
To check the health of a service instance or node, Consul periodically attempts a connection. Learn about the types of health checks and how to define them in agent and service configuration files.
|
||||
Agents can be configured to periodically perform custom checks on the health of a service instance or node. Learn about the types of health checks and how to define them in agent and service configuration files.
|
||||
---
|
||||
|
||||
# Health Checks
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: docs
|
||||
page_title: Query services with DNS
|
||||
page_title: Find services with DNS
|
||||
description: >-
|
||||
Domain Name Service (DNS) is the main way to look up, query, and address Consul nodes and services. Learn how a DNS lookup can help you find services by tag, name, namespace, partition, datacenter, or domain.
|
||||
For service discovery use cases, Domain Name Service (DNS) is the main interface to look up, query, and address Consul nodes and services. Learn how a Consul DNS lookup can help you find services by tag, name, namespace, partition, datacenter, or domain.
|
||||
---
|
||||
|
||||
# Query services with DNS
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
layout: docs
|
||||
page_title: Service Configuration Files
|
||||
page_title: Register Services with Service Definitions
|
||||
description: >-
|
||||
Use configuration files to define and register services with Consul and associate services with health checks. Learn how to format service definitions with this reference page and sample code.
|
||||
Define and register services and their health checks with Consul to make a service available for service discovery or service mesh access. Learn how to format service definitions with this reference page and sample code.
|
||||
---
|
||||
|
||||
# Service Configuration Files
|
||||
# Register Services with Service Definitions
|
||||
|
||||
One of the main goals of service discovery is to provide a catalog of available
|
||||
services. To that end, the agent provides a simple service definition format
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Consul Tools
|
||||
description: >-
|
||||
Consul Tools provide additional functionality by integrating other products and services with Consul. Learn about tools created by Hashicorp, as well as add-ons developed by the Consul community.
|
||||
Consul's capabilities can be extended through integration with other tools. Learn about Consul-related tools created by HashiCorp and by the Consul community.
|
||||
---
|
||||
|
||||
# Download Consul Tools
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Network Infrastructure Automation (NIA) Integration Program
|
||||
description: >-
|
||||
The NIA Integration Program allows approved partners to develop Terraform modules for Consul-Terraform-Sync (CTS) that Hashicorp reviews and officially verifies. Learn about the program and how to get more information.
|
||||
The Network Infrastructure Automation (NIA) Integration Program allows partners to develop Terraform modules for Consul-Terraform-Sync (CTS) that HashiCorp reviews to consider publishing as officially verified. Learn about how to participate in the program.
|
||||
---
|
||||
|
||||
# Network Infrastructure Automation Integration Program
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Consul Integration Program
|
||||
description: >-
|
||||
The Consul Integration Program allows approved partners to develop Consul integrations that Hashicorp reviews and officially verifies. Learn about the program and how to get more information.
|
||||
The Consul Integration Program allows approved partners to develop Consul integrations that HashiCorp reviews to consider publishing as officially verified. Learn about how to participate in the program.
|
||||
---
|
||||
|
||||
# Consul Integration Program
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: docs
|
||||
page_title: ACLs for Federated Datacenters
|
||||
page_title: ACL Setup for WAN Federated Datacenters
|
||||
description: >-
|
||||
You can apply ACLs in federated datacenters to secure access for distributed deployments. Learn how to create replication tokens from agent tokens and apply them to server and client agents.
|
||||
Consul's access control list (ACL) system can span multiple datacenters that are WAN federated. Learn how to replicate the ACL system from the primary datacenter to secondary datacenters using a replication token.
|
||||
---
|
||||
|
||||
# ACLs in Federated Datacenters
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Legacy ACL System
|
||||
description: >-
|
||||
Consul's original ACL system was updated in version 1.4.0 and the legacy system is no longer supported as of 1.11.0. Learn how Consul's original ACLs worked and how it differs from current ACLs.
|
||||
Consul's legacy ACL system was deprecated in version 1.4.0 and removed in version 1.11.0. Learn how Consul's legacy ACL system worked and how it differs from the current ACL system.
|
||||
---
|
||||
|
||||
# ACL System in Legacy Mode
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: docs
|
||||
page_title: Token Migration (ACL)
|
||||
page_title: Legacy ACL Token Migration
|
||||
description: >-
|
||||
Migrate legacy tokens when updating to Consul 1.4.0+ from earlier versions to use the improved ACL system. Learn about the migration process, how to update tokens, and examples for creating policies.
|
||||
Migrate legacy tokens when updating to Consul 1.4.0+ from earlier versions to use the current ACL system. Learn about the migration process, how to update tokens, and examples for creating policies.
|
||||
---
|
||||
|
||||
# ACL Token Migration
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: ACL Policies
|
||||
description: >-
|
||||
Policies are groups of one or more rules that link resources to access permissions and tokens in the ACL system. Learn how to format and combine rules into policies and implement policies in Consul.
|
||||
ACL policies define access control rules for resources in Consul. When an ACL token is submitted with a request, Consul authorizes access based on the token's associated policies. Learn how to format and combine rules into policies and apply them to tokens.
|
||||
---
|
||||
|
||||
# ACL Policies
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: ACL Roles
|
||||
description: >-
|
||||
Roles are a collection of ACL policies that enable service and node identities. Learn how roles allow you to reuse and update policies without requiring unique tokens for each requestor.
|
||||
Roles are a named collection of ACL policies, service identities, and node identities. Learn how roles allow you to reuse and update access control policies without needing to distribute new tokens to users.
|
||||
---
|
||||
|
||||
# ACL Roles
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: ACL Rules
|
||||
description: >-
|
||||
Rules define read, write, and deny access for datacenter resources. Learn about these resources and how to assign rules to them, as well as their restrictions and API interactions.
|
||||
Rules define read, write, and deny access controls for datacenter resources. Learn about these resources and how to assign rules to them, as well as their restrictions and API interactions.
|
||||
---
|
||||
|
||||
# ACL Rules
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: ACL Tokens
|
||||
description: >-
|
||||
Tokens authenticate users, services, and agents in Consul’s ACL system. Learn about token attributes, special-purpose and built-in tokens, and how to pass a token’s SecretID in the CLI and API.
|
||||
Tokens are used to authenticate users, services, and agents and authorize their access to resources in Consul. Learn about token attributes, special-purpose and built-in tokens, and how to pass a token’s SecretID in the CLI and API.
|
||||
---
|
||||
|
||||
# ACL Tokens
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Encryption Systems
|
||||
description: >-
|
||||
Two encryption systems protect Consul’s network communications. Learn how keys secure gossip between agents and how RPC with TLS certificates verifies the authenticity of servers and clients.
|
||||
Consul supports encrypting all of its network traffic. Remote Process Calls (RPCs) between client and server agents can be encrypted with TLS and authenticated with certificates. Gossip communication between all agents can also be encrypted.
|
||||
---
|
||||
|
||||
# Encryption
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: docs
|
||||
page_title: Security Models: Consul Core
|
||||
page_title: Security Models: Consul
|
||||
description: >-
|
||||
The security model for Consul Core details requirements and recommendations for securing access to your network. 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.
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: docs
|
||||
page_title: Security Models: Network Infrastructure Automation (NIA)
|
||||
description: >-
|
||||
The NIA security model details requirements and recommendations for securing access to your network when using Consul-Terraform-Sync (CTS). Learn about potential threats and how to protect Consul 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.
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
|
|
|||
Loading…
Reference in New Issue