luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: CLI page descriptions for automated checker (#16056) 

* ACL

* ACL

* Catalog

* consul config

* consul connect

* top-level updates

* consul intention

* consul kv

* consul namespace

* consul peering

* consul peering delete

* consul services

* consul snapshot

* consul tls

* consul acl auth-method

* acl binding-rule

* acl policy

* acl role

* acl token

* fix

* standardization

* Update website/content/commands/snapshot/save.mdx

Co-authored-by: Bryce Kalow <bkalow@hashicorp.com>

* consul debug
consul keyring

Co-authored-by: Bryce Kalow <bkalow@hashicorp.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
This commit is contained in:
Jeff Boruszak 2023-01-26 12:42:13 -06:00 committed by GitHub
parent 30f5404c89
commit fe2f650240
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
84 changed files with 168 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/content/commands/acl/auth-method/create.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Auth Method Create'
description: |
The `consul acl auth-method create` command creates a new auth method according to defined parameters.
---
# Consul ACL Auth Method Create

2
website/content/commands/acl/auth-method/delete.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Auth Method Delete'
description: |
The `consul acl auth-method delete` command deletes an individually specified auth method.
---
# Consul ACL Auth Method Delete

2
website/content/commands/acl/auth-method/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Auth Methods'
description: |
The `consul acl auth-method` command interacts with Consul's ACL auth methods. It exposes top-level commands for creating, updating, reading, deleting, and listing auth methods.
---
# Consul ACL Auth Methods

2
website/content/commands/acl/auth-method/list.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Auth Method List'
description: |
The `consul acl auth-method list` command outputs a list of active auth methods.
---
# Consul ACL Auth Method List

2
website/content/commands/acl/auth-method/read.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Auth Method Read'
description: |
The `consul acl auth-method read` command outputs configuration details for a specified auth method.
---
# Consul ACL Auth Method Read

2
website/content/commands/acl/auth-method/update.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Auth Method Update'
description: |
The `consul acl auth-method update` command updates auth method configuration information.
---
# Consul ACL Auth Method Update

2
website/content/commands/acl/binding-rule/create.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Binding Rule Create'
description: |
The `consul acl binding-rule create` command creates new ACL binding rules. These rules bind auth methods to specific services or roles.
---
# Consul ACL Binding Rule Create

2
website/content/commands/acl/binding-rule/delete.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Binding Rule Delete'
description: |
The `consul acl binding-rule delete` command deletes an ACL binding rule according to a specified ID. These rules bind auth methods to specific services or roles.
---
# Consul ACL Binding Rule Delete

2
website/content/commands/acl/binding-rule/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Binding Rule'
description: |
The `consul acl binding-rule` command interacts with Consul's ACL binding rules. It exposes commands for creating, updating, reading, deleting, and listing rules that bind auth methods to a specific service or role.
---
# Consul ACL Binding Rules

2
website/content/commands/acl/binding-rule/list.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Binding Rule List'
description: |
The `consul acl binding-rule list` command lists names and details for all ACL binding rules.
---
# Consul ACL Binding Rule List

2
website/content/commands/acl/binding-rule/read.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Binding Rule Read'
description: |
The `consul acl binding-rule read` command outputs the details of an ACL binding rule of a specified ID.
---
# Consul ACL Binding Rule Read

2
website/content/commands/acl/binding-rule/update.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Binding Rule Update'
description: |
The `consul acl binding-rule update` command updates existing ACL binding rules. These rules bind auth methods to specific services or roles.
---
# Consul ACL Binding Rule Update

2
website/content/commands/acl/bootstrap.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Bootstrap'
description: >-
The `consul acl bootstrap` command generates a new token with unlimited privileges to use for management purposes and outputs the token's details.
---
# Consul ACL Bootstrap

2
website/content/commands/acl/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL'
description: >-
The `consul acl` command exposes top-level commands for bootstrapping the ACL system, managing tokens and policies, translating legacy rules, and setting the tokens for use by an agent.
---
# Consul ACLs

2
website/content/commands/acl/policy/create.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Policy Create'
description: |
The `consul acl policy create` command creates new ACL policies that authorize read and write access in the service mesh.
---
# Consul ACL Policy Create

2
website/content/commands/acl/policy/delete.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Policy Delete'
description: |
The `consul acl policy delete` command deletes ACL policies of a specified name, ID, or ID prefix.
---
# Consul ACL Policy Delete

2
website/content/commands/acl/policy/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Policy'
description: |
The `consul acl policy` command interacts with Consul's ACL policies. It exposes commands for creating, updating, reading, deleting, and listing policies.
---
# Consul ACL Policies

2
website/content/commands/acl/policy/list.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Policy List'
description: |
The `consul acl policy list` command lists names and details for all ACL policies in the cluster.
---
# Consul ACL Policy List

2
website/content/commands/acl/policy/read.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Policy Read'
description: |
The `consul acl policy read` command outputs rules that make up an ACL policy of the specified ID.
---
# Consul ACL Policy Read

2
website/content/commands/acl/policy/update.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Policy Update'
description: |
The `consul acl policy update` command updates existing ACL policies to change authorized read and write access in the service mesh.
---
# Consul ACL Policy Update

2
website/content/commands/acl/role/create.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Role Create'
description: |
The `consul acl role create` command creates a new role attached to one or more ACL policies.
---
# Consul ACL Role Create

2
website/content/commands/acl/role/delete.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Role Delete'
description: |
The `consul acl role delete` command deletes the ACL role of the specified ID or name.
---
# Consul ACL Role Delete

2
website/content/commands/acl/role/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Role'
description: |
The `consul acl role` command interacts with Consul's ACL roles. It exposes commands for creating, updating, reading, deleting, and listing roles. Roles consist of one or more ACL policies authorizing communication in the service mesh.
---
# Consul ACL Roles

2
website/content/commands/acl/role/list.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Role List'
description: |
The `consul acl role list` command outputs details for all ACL roles, including the policy IDs attached to each role.
---
# Consul ACL Role List

2
website/content/commands/acl/role/read.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Role Read'
description: |
The `consul acl role read` command outputs details for the ACL role of the specified name or ID, including policies attached to the role.
---
# Consul ACL Role Read

2
website/content/commands/acl/role/update.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Role Update'
description: |
The `consul acl role update` command updates existing ACL roles. Roles consist of one or more ACL policies authorizing communication in the service mesh.
---
# Consul ACL Role Update

2
website/content/commands/acl/set-agent-token.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Set Agent Token'
description: >-
The `consul acl set-agent-token` command updates an agent's ACL tokens to introduce the agent ACL tokens for the first time or to update tokens.
---
# Consul ACL Set Agent Token

2
website/content/commands/acl/token/clone.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Token Clone'
description: |
The `consul acl token clone` command makes a copy of the ACL token of a specified ID.
---
# Consul ACL Token Clone

2
website/content/commands/acl/token/create.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Token Create'
description: |
The `consul acl token create` command creates new ACL tokens. Optional arguments can set TTL duration and attach new tokens to existing policies and roles.
---
# Consul ACL Token Create

2
website/content/commands/acl/token/delete.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Token Delete'
description: |
The `consul acl token delete` command deletes an ACL token of a specified ID. Deleting a token affects the ACL policies and roles attached to the token.
---
# Consul ACL Token Delete

2
website/content/commands/acl/token/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Token'
description: |
The `consul acl token` command interacts with Consul's ACL tokens. It exposes commands for creating, updating, reading, deleting, listing, and cloning tokens. Tokens include secrets that can be attached to policies to secure communication in the service mesh.
---
# Consul ACL Tokens

2
website/content/commands/acl/token/list.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Token List'
description: |
The `consul acl token list` command outputs details for all ACL tokens, including the global management bootstrap token and the anonymous token.
---
# Consul ACL Token List

2
website/content/commands/acl/token/read.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Token Read'
description: |
The `consul acl token read` command outputs details for an ACL token of a specified ID.
---
# Consul ACL Token Read

2
website/content/commands/acl/token/update.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Token Update'
description: |
The `consul acl token update` command updates ACL token details such as attached policies, roles, and service identities. Some token details cannot be changed with this command.
---
# Consul ACL Token Update

2
website/content/commands/acl/translate-rules.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: ACL Translate Rules'
description: >-
The `consul acl translate-rules` command translates the legacy ACL rules into the new syntax when migrating from the legacy ACL system.
---
-> **Deprecated:** This command exists only as a convenience to make legacy ACL migration easier.

2
website/content/commands/catalog/datacenters.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Catalog List Datacenters'
description: >-
The `consul catalog datacenters` command returns a list of all known datacenters.
---
# Consul Catalog List Datacenters

2
website/content/commands/catalog/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Catalog'
description: >-
The `consul catalog` command interacts with Consul's catalog of services and their registered locations. It exposes top-level commands for reading and filtering data from the registry.
---
# Consul Catalog

2
website/content/commands/catalog/nodes.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Catalog List Nodes'
description: >-
The `consul catalog nodes` command returns all known nodes and metadata about them. It can also query nodes that host a particular service or contain specific metadata.
---
# Consul Catalog List Nodes

2
website/content/commands/catalog/services.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Catalog List Services'
description: >-
The `consul catalog services` command returns all known services. It can also get a list of services on a particular node and query services that contain specific metadata.
---
# Consul Catalog List Services

2
website/content/commands/config/delete.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Config Delete'
description: >-
The `consul config delete` command deletes a configuration entry specified by kind and name.
---
# Consul Config Delete

2
website/content/commands/config/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Config'
description: >-
The `consul config` command interacts with configuration entries. It exposes top-level commands for global configurations of proxies, gateways, and services.
---
# Consul Config

2
website/content/commands/config/list.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Config List'
description: >-
The `consul config list` command lists all configuration entries for each config entry kind.
---
# Consul Config List

2
website/content/commands/config/read.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Config Read'
description: >-
The `consul config read` outputs the JSON representation of a configuration entry identified by kind or name.
---
# Consul Config Read

2
website/content/commands/config/write.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Config Write'
description: >-
The `consul config write` command creates or updates a configuration entry and applies it to your deployment.
---
# Consul Config Write

2
website/content/commands/connect/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Connect'
description: >-
The `consul connect` command interacts with Consul's service mesh features. It exposes top-level commands for interacting with the internal CA and service mesh proxies, exposing services through ingress gateways, and applying iptables rules.
---
# Consul Connect

2
website/content/commands/debug.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Debug'
description: >-
The `consul debug` command monitors an agent to capture a record its actions according to defined durations and intervals.
---
# Consul Debug

2
website/content/commands/intention/check.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Intention Check'
description: >-
The `consul intention check` command tests whether a connection between two services is authorized under the current set of intentions.
---
# Consul Intention Check

2
website/content/commands/intention/create.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Intention Create'
description: >-
The `consul intention create` command creates and updates L4 service intentions. It was deprecated in Consul v1.9.0; use `consul config` instead.
---
# Consul Intention Create

2
website/content/commands/intention/delete.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Intention Delete'
description: >-
The `consul intention delete` command delete L4 service intentions that authorize two services to communicate. It was deprecated in Consul v1.9.0; use `consul config` instead.
---
# Consul Intention Delete

2
website/content/commands/intention/get.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Intention Get'
description: >-
The `consul intention get` command returns information about a single L4 service intention that authorizes services to communicate. It was deprecated in Consul v1.9.0; use `consul config` instead.
---
# Consul Intention Get

2
website/content/commands/intention/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Intention'
description: >-
The `consul intention` command interacts with service intentions to secure service mesh traffic. It exposes top-level commands for interacting with intentions. It was deprecated in Consul v1.9.0. To interact with intentions, use `consul config` instead.
---
# Consul Intention

2
website/content/commands/intention/list.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Intention List'
description: >-
The `consul intention list` command returns all L4 service intentions, including a unique ID and intention precendence. It was deprecated in Consul v1.9.0; use `consul config` instead.
---
# Consul Intention List

2
website/content/commands/intention/match.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Intention Match'
description: >-
The `consul intention match` command returns inbound and outbound service intentions for a specific service.
---
# Consul Intention Match

2
website/content/commands/keyring.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Keyring'
description: >-
The `consul keyring` command lists active encryption keys used for gossip pools and enables you to rotate keys for large deployments automatically.
---
# Consul Keyring

2
website/content/commands/kv/delete.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: KV Delete'
description: >-
The `consul kv delete` command removes a value from Consul's key/value store.
---
# Consul KV Delete

2
website/content/commands/kv/export.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: KV Export'
description: >-
The `consul kv export` command outputs KV pairs from Consul's key/value store in JSON to move trees between Consul clusters.
---
# Consul KV Export

2
website/content/commands/kv/get.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: KV Get'
description: >-
The `consul kv get` command retrieves data from Consul's key/value store.
---
# Consul KV Get

2
website/content/commands/kv/import.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: KV Import'
description: >-
The `consul kv import` command adds values to Consul's key/value store according to a JSON representation of the data.
---
# Consul KV Import

2
website/content/commands/kv/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: KV'
description: >-
The `consul kv` command interacts with Consul's key/value store. It exposes top level commands to insert, update, read, and delte data from the store.
---
# Consul KV

2
website/content/commands/kv/put.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: KV Put'
description: >-
The `consul kv put` command writes data to Consul's key/value store.
---
# Consul KV Put

2
website/content/commands/namespace/create.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Namespace Create'
description: |
The `consul namespace create` command generates a new namespace in Consul Enterprise. Policies, roles, and metadata can be assigned when creating a namespace.
---
# Consul Namespace Create

2
website/content/commands/namespace/delete.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Namespace Delete'
description: |
The `consul namespace delete` command deletes a namespace in Consul Enterprise.
---
# Consul Namespace Delete

2
website/content/commands/namespace/index.mdx
View File

@ -2,7 +2,7 @@
layout: commands
page_title: 'Commands: Namespace'
description: |
The namespace command provides management of Consul Enterprise namespaces.
The `consul namespace` command interacts with namespaces in Consul Enterprise. It exposes top-level commands to create and manage namespaces in Consul deployments.
---
# Consul Namespace

2
website/content/commands/namespace/list.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Namespace List'
description: |
The `consul namespace list` command outputs all existing namespaces in Consul Enterprise.
---
# Consul Namespace List

2
website/content/commands/namespace/read.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Namespace Read'
description: |
The `consul namespace read` command outputs information about a single namespace in Consul Enterprise.
---
# Consul Namespace Read

2
website/content/commands/namespace/update.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Namespace Update'
description: |
The `consul namespace update` command updates an individual namespace in Consul Enterprise. Policies, roles, namespace descriptions, and metadata can be updated.
---
# Consul Namespace Update

2
website/content/commands/namespace/write.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Namespace Write'
description: |
The `consul namespace write` command creates or updates a namespace's configuration in Consul Enterprise.
---
# Consul Namespace Write

3
website/content/commands/peering/delete.mdx
View File

@ -1,7 +1,8 @@
---
layout: commands
page_title: 'Commands: Peering Delete'
description: Learn how to use the consul peering delete command to remove a peering connection between Consul clusters.
description: |
The `consul peering delete` command ends a cluster peering connection with another cluster.
---
# Consul Peering Delete

3
website/content/commands/peering/establish.mdx
View File

@ -1,7 +1,8 @@
---
layout: commands
page_title: 'Commands: Peering Establish'
description: Learn how to use the consul peering establish command to establish a peering connection between Consul clusters.
description: |
The `consul peering establish` command starts a cluster peering connection with another cluster after they exchange a peering token.
---
# Consul Peering Establish

3
website/content/commands/peering/generate-token.mdx
View File

@ -1,7 +1,8 @@
---
layout: commands
page_title: 'Commands: Peering Generate Token'
description: Learn how to use the consul peering generate-token command to generate token that enables you to peer Consul clusters.
description: |
The `consul peering generate-token` command creates a peering token that clusters use to establish secure cluster peering connections.
---
# Consul Peering Generate Token

7
website/content/commands/peering/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Peering'
description: |
The `consul peering` command interacts cluster peering connections. It exposes top-level commands to generate peering tokens. establish connections, and manage connections.
---
# Consul Peering
@ -34,7 +36,4 @@ of the subcommand in the sidebar or one of the links below:
- [establish](/consul/commands/peering/establish)
- [generate-token](/consul/commands/peering/generate-token)
- [list](/consul/commands/peering/list)
- [read](/consul/commands/peering/read)
- [read](/consul/commands/peering/read)

2
website/content/commands/peering/list.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Peering List'
description: |
The `consul peering lists` command outputs a list of the local cluster's cluster peering connections, including imported and exported service counts and the connection state.
---
# Consul Peering List

2
website/content/commands/peering/read.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Peering Read'
description: |
The `consul peering read` command outputs information about an individual cluster peering connection.
---
# Consul Peering Read

2
website/content/commands/services/deregister.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Services Deregister'
description: |
The `consul services deregister` command removes a service from the Consul catalog. Run the commeand on the agent that initially registered the service.
---
# Consul Agent Service Deregistration

2
website/content/commands/services/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Services'
description: |
The `consul services` command interacts with services registered with the local agent. It exposes top-level commands for registering and deregistering services with the Consul catalog.
---
# Consul Agent Services

2
website/content/commands/services/register.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Services Register'
description: |
The `consul services register` command registers services with the Consul catalog.
---
# Consul Agent Service Registration

2
website/content/commands/snapshot/agent.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Snapshot Agent'
description: |
The `consul snapshot agent` command starts a process that takes snapshots of the state of the Consul servers in Consul Enterprise. It can capture server state once or it can run as daemon that captures snapshots at defined intervals.
---
# Consul Snapshot Agent

2
website/content/commands/snapshot/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Snapshot'
description: |
The `consul snapshot` command interacts with Consul's snapshot agent to support disaster recovery. It exposes top-level commands for saving, restoring, and inspecting the state of Consul servers.
---
# Consul Snapshot

2
website/content/commands/snapshot/inspect.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Snapshot Inspect'
description: |
The `consul snapshot inspect` command outputs an atomic, point-in-time snapshot of the state of the Consul servers. Output includes key/value entries, registered services in the catalog, prepared queries, sessions, and ACLs.
---
# Consul Snapshot Inspect

2
website/content/commands/snapshot/restore.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Snapshot Restore'
description: |
The `consul snapshot restore` command restores the state of Consul servers after a disaster. A server can restore key/value entries, registered services in the catalog, prepared queries, sessions, and ACLs from a saved snapshot.
---
# Consul Snapshot Restore

2
website/content/commands/snapshot/save.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: Snapshot Save'
description: |
The `consul snapshot save` command retrieves a point-in-time snapshot of the state of the Consul servers and saves it to a specified location. Data saved in snapshots includes key/value entries, registered services in the catalog, prepared queries, sessions, and ACLs from a saved snapshot.
---
# Consul Snapshot Save

2
website/content/commands/tls/ca.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: TLS CA Create'
description: |
The `consul tls ca create` command creates a self-signed certificate authority (CA) for TLS setup.
---
# Consul TLS CA Create

2
website/content/commands/tls/cert.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: TLS Cert Create'
description: |
The `consul tls cert create` command creates certificates for servers, clients, and CLIs to secure their communication.
---
# Consul TLS Cert Create

2
website/content/commands/tls/index.mdx
View File

@ -1,6 +1,8 @@
---
layout: commands
page_title: 'Commands: TLS'
description: |
The `consul tls` command interacts with Consul's built in certificate authority. It exposes top-level commands for setting up the CA and generating certificates for agents.
---
# Consul TLS