diff --git a/website/content/commands/acl/auth-method/create.mdx b/website/content/commands/acl/auth-method/create.mdx index 2f6d853c4e..7a7ef7ea70 100644 --- a/website/content/commands/acl/auth-method/create.mdx +++ b/website/content/commands/acl/auth-method/create.mdx @@ -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 diff --git a/website/content/commands/acl/auth-method/delete.mdx b/website/content/commands/acl/auth-method/delete.mdx index 6a078853bf..fc2e166d36 100644 --- a/website/content/commands/acl/auth-method/delete.mdx +++ b/website/content/commands/acl/auth-method/delete.mdx @@ -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 diff --git a/website/content/commands/acl/auth-method/index.mdx b/website/content/commands/acl/auth-method/index.mdx index e75a6cec3a..b2463dff33 100644 --- a/website/content/commands/acl/auth-method/index.mdx +++ b/website/content/commands/acl/auth-method/index.mdx @@ -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 diff --git a/website/content/commands/acl/auth-method/list.mdx b/website/content/commands/acl/auth-method/list.mdx index 348dac523c..c7d2c0b9c2 100644 --- a/website/content/commands/acl/auth-method/list.mdx +++ b/website/content/commands/acl/auth-method/list.mdx @@ -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 diff --git a/website/content/commands/acl/auth-method/read.mdx b/website/content/commands/acl/auth-method/read.mdx index c9cc50b80b..928863846d 100644 --- a/website/content/commands/acl/auth-method/read.mdx +++ b/website/content/commands/acl/auth-method/read.mdx @@ -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 diff --git a/website/content/commands/acl/auth-method/update.mdx b/website/content/commands/acl/auth-method/update.mdx index 8c9907c16a..aef12ff351 100644 --- a/website/content/commands/acl/auth-method/update.mdx +++ b/website/content/commands/acl/auth-method/update.mdx @@ -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 diff --git a/website/content/commands/acl/binding-rule/create.mdx b/website/content/commands/acl/binding-rule/create.mdx index 4f3c0ebc7f..fd925e8d93 100644 --- a/website/content/commands/acl/binding-rule/create.mdx +++ b/website/content/commands/acl/binding-rule/create.mdx @@ -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 diff --git a/website/content/commands/acl/binding-rule/delete.mdx b/website/content/commands/acl/binding-rule/delete.mdx index 175241f183..c78e360310 100644 --- a/website/content/commands/acl/binding-rule/delete.mdx +++ b/website/content/commands/acl/binding-rule/delete.mdx @@ -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 diff --git a/website/content/commands/acl/binding-rule/index.mdx b/website/content/commands/acl/binding-rule/index.mdx index 01fb442329..0cbeb29b6e 100644 --- a/website/content/commands/acl/binding-rule/index.mdx +++ b/website/content/commands/acl/binding-rule/index.mdx @@ -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 diff --git a/website/content/commands/acl/binding-rule/list.mdx b/website/content/commands/acl/binding-rule/list.mdx index e642e3f6b7..9d01e9d2b1 100644 --- a/website/content/commands/acl/binding-rule/list.mdx +++ b/website/content/commands/acl/binding-rule/list.mdx @@ -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 diff --git a/website/content/commands/acl/binding-rule/read.mdx b/website/content/commands/acl/binding-rule/read.mdx index 62b2502264..86b8b4169c 100644 --- a/website/content/commands/acl/binding-rule/read.mdx +++ b/website/content/commands/acl/binding-rule/read.mdx @@ -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 diff --git a/website/content/commands/acl/binding-rule/update.mdx b/website/content/commands/acl/binding-rule/update.mdx index d6d1870e78..24f6901294 100644 --- a/website/content/commands/acl/binding-rule/update.mdx +++ b/website/content/commands/acl/binding-rule/update.mdx @@ -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 diff --git a/website/content/commands/acl/bootstrap.mdx b/website/content/commands/acl/bootstrap.mdx index 3b14fdb0b9..4ff708f07e 100644 --- a/website/content/commands/acl/bootstrap.mdx +++ b/website/content/commands/acl/bootstrap.mdx @@ -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 diff --git a/website/content/commands/acl/index.mdx b/website/content/commands/acl/index.mdx index 306f5d53f5..31a629feac 100644 --- a/website/content/commands/acl/index.mdx +++ b/website/content/commands/acl/index.mdx @@ -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 diff --git a/website/content/commands/acl/policy/create.mdx b/website/content/commands/acl/policy/create.mdx index e31c2a037b..db871f0caf 100644 --- a/website/content/commands/acl/policy/create.mdx +++ b/website/content/commands/acl/policy/create.mdx @@ -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 diff --git a/website/content/commands/acl/policy/delete.mdx b/website/content/commands/acl/policy/delete.mdx index f41036c916..074dfea607 100644 --- a/website/content/commands/acl/policy/delete.mdx +++ b/website/content/commands/acl/policy/delete.mdx @@ -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 diff --git a/website/content/commands/acl/policy/index.mdx b/website/content/commands/acl/policy/index.mdx index f3d94f51fb..d0fff3f75b 100644 --- a/website/content/commands/acl/policy/index.mdx +++ b/website/content/commands/acl/policy/index.mdx @@ -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 diff --git a/website/content/commands/acl/policy/list.mdx b/website/content/commands/acl/policy/list.mdx index fe78f4167b..7d56fd6f21 100644 --- a/website/content/commands/acl/policy/list.mdx +++ b/website/content/commands/acl/policy/list.mdx @@ -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 diff --git a/website/content/commands/acl/policy/read.mdx b/website/content/commands/acl/policy/read.mdx index e4fbe51e2c..b84b5d3c34 100644 --- a/website/content/commands/acl/policy/read.mdx +++ b/website/content/commands/acl/policy/read.mdx @@ -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 diff --git a/website/content/commands/acl/policy/update.mdx b/website/content/commands/acl/policy/update.mdx index a4229b61a5..e62dfa72d9 100644 --- a/website/content/commands/acl/policy/update.mdx +++ b/website/content/commands/acl/policy/update.mdx @@ -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 diff --git a/website/content/commands/acl/role/create.mdx b/website/content/commands/acl/role/create.mdx index 3e4edec5dd..44af92bd4e 100644 --- a/website/content/commands/acl/role/create.mdx +++ b/website/content/commands/acl/role/create.mdx @@ -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 diff --git a/website/content/commands/acl/role/delete.mdx b/website/content/commands/acl/role/delete.mdx index 592914daac..bb2a179d92 100644 --- a/website/content/commands/acl/role/delete.mdx +++ b/website/content/commands/acl/role/delete.mdx @@ -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 diff --git a/website/content/commands/acl/role/index.mdx b/website/content/commands/acl/role/index.mdx index 90a736d40d..f5976a50c7 100644 --- a/website/content/commands/acl/role/index.mdx +++ b/website/content/commands/acl/role/index.mdx @@ -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 diff --git a/website/content/commands/acl/role/list.mdx b/website/content/commands/acl/role/list.mdx index 06220e266f..ed3699ce3f 100644 --- a/website/content/commands/acl/role/list.mdx +++ b/website/content/commands/acl/role/list.mdx @@ -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 diff --git a/website/content/commands/acl/role/read.mdx b/website/content/commands/acl/role/read.mdx index 38342490b5..7de17d5dcb 100644 --- a/website/content/commands/acl/role/read.mdx +++ b/website/content/commands/acl/role/read.mdx @@ -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 diff --git a/website/content/commands/acl/role/update.mdx b/website/content/commands/acl/role/update.mdx index fc1f56c9cb..d6991a21e0 100644 --- a/website/content/commands/acl/role/update.mdx +++ b/website/content/commands/acl/role/update.mdx @@ -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 diff --git a/website/content/commands/acl/set-agent-token.mdx b/website/content/commands/acl/set-agent-token.mdx index a57eedb280..7279349dbb 100644 --- a/website/content/commands/acl/set-agent-token.mdx +++ b/website/content/commands/acl/set-agent-token.mdx @@ -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 diff --git a/website/content/commands/acl/token/clone.mdx b/website/content/commands/acl/token/clone.mdx index a043730b01..7f2822d6c5 100644 --- a/website/content/commands/acl/token/clone.mdx +++ b/website/content/commands/acl/token/clone.mdx @@ -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 diff --git a/website/content/commands/acl/token/create.mdx b/website/content/commands/acl/token/create.mdx index bcb9f9cba2..f0622ace7e 100644 --- a/website/content/commands/acl/token/create.mdx +++ b/website/content/commands/acl/token/create.mdx @@ -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 diff --git a/website/content/commands/acl/token/delete.mdx b/website/content/commands/acl/token/delete.mdx index 27c5057abc..5ba6595758 100644 --- a/website/content/commands/acl/token/delete.mdx +++ b/website/content/commands/acl/token/delete.mdx @@ -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 diff --git a/website/content/commands/acl/token/index.mdx b/website/content/commands/acl/token/index.mdx index 37b69475fd..7ef9a9b8fa 100644 --- a/website/content/commands/acl/token/index.mdx +++ b/website/content/commands/acl/token/index.mdx @@ -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 diff --git a/website/content/commands/acl/token/list.mdx b/website/content/commands/acl/token/list.mdx index 6226c902c5..d613dba5c5 100644 --- a/website/content/commands/acl/token/list.mdx +++ b/website/content/commands/acl/token/list.mdx @@ -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 diff --git a/website/content/commands/acl/token/read.mdx b/website/content/commands/acl/token/read.mdx index 4d061e3cc9..e339292d96 100644 --- a/website/content/commands/acl/token/read.mdx +++ b/website/content/commands/acl/token/read.mdx @@ -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 diff --git a/website/content/commands/acl/token/update.mdx b/website/content/commands/acl/token/update.mdx index 957c36e26d..33a5380d5a 100644 --- a/website/content/commands/acl/token/update.mdx +++ b/website/content/commands/acl/token/update.mdx @@ -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 diff --git a/website/content/commands/acl/translate-rules.mdx b/website/content/commands/acl/translate-rules.mdx index e75d519b2c..a6413f3a89 100644 --- a/website/content/commands/acl/translate-rules.mdx +++ b/website/content/commands/acl/translate-rules.mdx @@ -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. diff --git a/website/content/commands/catalog/datacenters.mdx b/website/content/commands/catalog/datacenters.mdx index daefae6bdf..c9b70f5ecc 100644 --- a/website/content/commands/catalog/datacenters.mdx +++ b/website/content/commands/catalog/datacenters.mdx @@ -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 diff --git a/website/content/commands/catalog/index.mdx b/website/content/commands/catalog/index.mdx index c95c1343d9..58c1dcdaea 100644 --- a/website/content/commands/catalog/index.mdx +++ b/website/content/commands/catalog/index.mdx @@ -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 diff --git a/website/content/commands/catalog/nodes.mdx b/website/content/commands/catalog/nodes.mdx index 37a9b59b08..f612627be2 100644 --- a/website/content/commands/catalog/nodes.mdx +++ b/website/content/commands/catalog/nodes.mdx @@ -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 diff --git a/website/content/commands/catalog/services.mdx b/website/content/commands/catalog/services.mdx index 4082d444eb..9d05ecbf47 100644 --- a/website/content/commands/catalog/services.mdx +++ b/website/content/commands/catalog/services.mdx @@ -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 diff --git a/website/content/commands/config/delete.mdx b/website/content/commands/config/delete.mdx index f1dc92e5bc..3fc9e6618b 100644 --- a/website/content/commands/config/delete.mdx +++ b/website/content/commands/config/delete.mdx @@ -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 diff --git a/website/content/commands/config/index.mdx b/website/content/commands/config/index.mdx index 0ebb0b4e73..f485cef75e 100644 --- a/website/content/commands/config/index.mdx +++ b/website/content/commands/config/index.mdx @@ -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 diff --git a/website/content/commands/config/list.mdx b/website/content/commands/config/list.mdx index b87c008f01..c72e3e903d 100644 --- a/website/content/commands/config/list.mdx +++ b/website/content/commands/config/list.mdx @@ -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 diff --git a/website/content/commands/config/read.mdx b/website/content/commands/config/read.mdx index af983f8245..a50574aaed 100644 --- a/website/content/commands/config/read.mdx +++ b/website/content/commands/config/read.mdx @@ -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 diff --git a/website/content/commands/config/write.mdx b/website/content/commands/config/write.mdx index 9ea2a7ad62..7e586aff75 100644 --- a/website/content/commands/config/write.mdx +++ b/website/content/commands/config/write.mdx @@ -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 diff --git a/website/content/commands/connect/index.mdx b/website/content/commands/connect/index.mdx index da717a8aa8..166b8ff835 100644 --- a/website/content/commands/connect/index.mdx +++ b/website/content/commands/connect/index.mdx @@ -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 diff --git a/website/content/commands/debug.mdx b/website/content/commands/debug.mdx index c0755251f0..3fea57f43e 100644 --- a/website/content/commands/debug.mdx +++ b/website/content/commands/debug.mdx @@ -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 diff --git a/website/content/commands/intention/check.mdx b/website/content/commands/intention/check.mdx index 4c2f64c97e..a0c384c646 100644 --- a/website/content/commands/intention/check.mdx +++ b/website/content/commands/intention/check.mdx @@ -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 diff --git a/website/content/commands/intention/create.mdx b/website/content/commands/intention/create.mdx index cae1927ee5..b41b9c502f 100644 --- a/website/content/commands/intention/create.mdx +++ b/website/content/commands/intention/create.mdx @@ -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 diff --git a/website/content/commands/intention/delete.mdx b/website/content/commands/intention/delete.mdx index aa68a769fa..1f6971c490 100644 --- a/website/content/commands/intention/delete.mdx +++ b/website/content/commands/intention/delete.mdx @@ -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 diff --git a/website/content/commands/intention/get.mdx b/website/content/commands/intention/get.mdx index c4157d8544..6ac253c898 100644 --- a/website/content/commands/intention/get.mdx +++ b/website/content/commands/intention/get.mdx @@ -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 diff --git a/website/content/commands/intention/index.mdx b/website/content/commands/intention/index.mdx index 5f9b2fb328..9246ef9e05 100644 --- a/website/content/commands/intention/index.mdx +++ b/website/content/commands/intention/index.mdx @@ -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 diff --git a/website/content/commands/intention/list.mdx b/website/content/commands/intention/list.mdx index ea96b34ba7..cc5130ac99 100644 --- a/website/content/commands/intention/list.mdx +++ b/website/content/commands/intention/list.mdx @@ -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 diff --git a/website/content/commands/intention/match.mdx b/website/content/commands/intention/match.mdx index 8b5448a2ac..4936e12ba3 100644 --- a/website/content/commands/intention/match.mdx +++ b/website/content/commands/intention/match.mdx @@ -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 diff --git a/website/content/commands/keyring.mdx b/website/content/commands/keyring.mdx index 8c7b2d0e1c..b1c914fddc 100644 --- a/website/content/commands/keyring.mdx +++ b/website/content/commands/keyring.mdx @@ -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 diff --git a/website/content/commands/kv/delete.mdx b/website/content/commands/kv/delete.mdx index b01d34af46..90e2e54624 100644 --- a/website/content/commands/kv/delete.mdx +++ b/website/content/commands/kv/delete.mdx @@ -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 diff --git a/website/content/commands/kv/export.mdx b/website/content/commands/kv/export.mdx index bb7750d16e..da063e9d82 100644 --- a/website/content/commands/kv/export.mdx +++ b/website/content/commands/kv/export.mdx @@ -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 diff --git a/website/content/commands/kv/get.mdx b/website/content/commands/kv/get.mdx index 47abec4d43..0e83b2facb 100644 --- a/website/content/commands/kv/get.mdx +++ b/website/content/commands/kv/get.mdx @@ -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 diff --git a/website/content/commands/kv/import.mdx b/website/content/commands/kv/import.mdx index 37d99db0fa..574fdfbd87 100644 --- a/website/content/commands/kv/import.mdx +++ b/website/content/commands/kv/import.mdx @@ -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 diff --git a/website/content/commands/kv/index.mdx b/website/content/commands/kv/index.mdx index 7e6a8202af..f95f8be885 100644 --- a/website/content/commands/kv/index.mdx +++ b/website/content/commands/kv/index.mdx @@ -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 diff --git a/website/content/commands/kv/put.mdx b/website/content/commands/kv/put.mdx index 3903ac6be3..efb045179f 100644 --- a/website/content/commands/kv/put.mdx +++ b/website/content/commands/kv/put.mdx @@ -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 diff --git a/website/content/commands/namespace/create.mdx b/website/content/commands/namespace/create.mdx index 887ee1d704..f5d611a542 100644 --- a/website/content/commands/namespace/create.mdx +++ b/website/content/commands/namespace/create.mdx @@ -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 diff --git a/website/content/commands/namespace/delete.mdx b/website/content/commands/namespace/delete.mdx index 960e2f46d7..8742af6f4d 100644 --- a/website/content/commands/namespace/delete.mdx +++ b/website/content/commands/namespace/delete.mdx @@ -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 diff --git a/website/content/commands/namespace/index.mdx b/website/content/commands/namespace/index.mdx index a3938a361c..156d02ac16 100644 --- a/website/content/commands/namespace/index.mdx +++ b/website/content/commands/namespace/index.mdx @@ -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 diff --git a/website/content/commands/namespace/list.mdx b/website/content/commands/namespace/list.mdx index 0070ab0228..5d15c1f115 100644 --- a/website/content/commands/namespace/list.mdx +++ b/website/content/commands/namespace/list.mdx @@ -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 diff --git a/website/content/commands/namespace/read.mdx b/website/content/commands/namespace/read.mdx index 4aaf8c5add..4a4621ef06 100644 --- a/website/content/commands/namespace/read.mdx +++ b/website/content/commands/namespace/read.mdx @@ -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 diff --git a/website/content/commands/namespace/update.mdx b/website/content/commands/namespace/update.mdx index 3872d792fa..6349d307f6 100644 --- a/website/content/commands/namespace/update.mdx +++ b/website/content/commands/namespace/update.mdx @@ -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 diff --git a/website/content/commands/namespace/write.mdx b/website/content/commands/namespace/write.mdx index b1bc02a8b2..678c303a80 100644 --- a/website/content/commands/namespace/write.mdx +++ b/website/content/commands/namespace/write.mdx @@ -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 diff --git a/website/content/commands/peering/delete.mdx b/website/content/commands/peering/delete.mdx index b18bb4a59d..81ba3439db 100644 --- a/website/content/commands/peering/delete.mdx +++ b/website/content/commands/peering/delete.mdx @@ -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 diff --git a/website/content/commands/peering/establish.mdx b/website/content/commands/peering/establish.mdx index 31a2d01f38..a00dc33218 100644 --- a/website/content/commands/peering/establish.mdx +++ b/website/content/commands/peering/establish.mdx @@ -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 diff --git a/website/content/commands/peering/generate-token.mdx b/website/content/commands/peering/generate-token.mdx index ecfe22bd6e..92d007125c 100644 --- a/website/content/commands/peering/generate-token.mdx +++ b/website/content/commands/peering/generate-token.mdx @@ -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 diff --git a/website/content/commands/peering/index.mdx b/website/content/commands/peering/index.mdx index c4669fc3ac..cd3a2b359c 100644 --- a/website/content/commands/peering/index.mdx +++ b/website/content/commands/peering/index.mdx @@ -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) \ No newline at end of file diff --git a/website/content/commands/peering/list.mdx b/website/content/commands/peering/list.mdx index e66b97e14d..f0b1c83777 100644 --- a/website/content/commands/peering/list.mdx +++ b/website/content/commands/peering/list.mdx @@ -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 diff --git a/website/content/commands/peering/read.mdx b/website/content/commands/peering/read.mdx index 58908656a6..596c514520 100644 --- a/website/content/commands/peering/read.mdx +++ b/website/content/commands/peering/read.mdx @@ -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 diff --git a/website/content/commands/services/deregister.mdx b/website/content/commands/services/deregister.mdx index 4b65eea651..5cc774422c 100644 --- a/website/content/commands/services/deregister.mdx +++ b/website/content/commands/services/deregister.mdx @@ -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 diff --git a/website/content/commands/services/index.mdx b/website/content/commands/services/index.mdx index 7b5b8f3f68..ec26946c58 100644 --- a/website/content/commands/services/index.mdx +++ b/website/content/commands/services/index.mdx @@ -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 diff --git a/website/content/commands/services/register.mdx b/website/content/commands/services/register.mdx index d7266d26fe..8e3a9d1333 100644 --- a/website/content/commands/services/register.mdx +++ b/website/content/commands/services/register.mdx @@ -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 diff --git a/website/content/commands/snapshot/agent.mdx b/website/content/commands/snapshot/agent.mdx index 0eee4228dd..9f7c5d1d50 100644 --- a/website/content/commands/snapshot/agent.mdx +++ b/website/content/commands/snapshot/agent.mdx @@ -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 diff --git a/website/content/commands/snapshot/index.mdx b/website/content/commands/snapshot/index.mdx index c21e9d32e6..f32a1a4d76 100644 --- a/website/content/commands/snapshot/index.mdx +++ b/website/content/commands/snapshot/index.mdx @@ -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 diff --git a/website/content/commands/snapshot/inspect.mdx b/website/content/commands/snapshot/inspect.mdx index 596d8a5969..b3e7aade2c 100644 --- a/website/content/commands/snapshot/inspect.mdx +++ b/website/content/commands/snapshot/inspect.mdx @@ -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 diff --git a/website/content/commands/snapshot/restore.mdx b/website/content/commands/snapshot/restore.mdx index 0e3194e72e..e33827f48c 100644 --- a/website/content/commands/snapshot/restore.mdx +++ b/website/content/commands/snapshot/restore.mdx @@ -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 diff --git a/website/content/commands/snapshot/save.mdx b/website/content/commands/snapshot/save.mdx index 397e82f6ff..63b0fbe48f 100644 --- a/website/content/commands/snapshot/save.mdx +++ b/website/content/commands/snapshot/save.mdx @@ -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 diff --git a/website/content/commands/tls/ca.mdx b/website/content/commands/tls/ca.mdx index 0ad2de08e1..21661d9568 100644 --- a/website/content/commands/tls/ca.mdx +++ b/website/content/commands/tls/ca.mdx @@ -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 diff --git a/website/content/commands/tls/cert.mdx b/website/content/commands/tls/cert.mdx index 528ddd31bb..03e84d68e8 100644 --- a/website/content/commands/tls/cert.mdx +++ b/website/content/commands/tls/cert.mdx @@ -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 diff --git a/website/content/commands/tls/index.mdx b/website/content/commands/tls/index.mdx index 47494fa0fc..4e86192239 100644 --- a/website/content/commands/tls/index.mdx +++ b/website/content/commands/tls/index.mdx @@ -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