github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
consul/website/content/commands/config/list.mdx

64 lines
1.9 KiB
Plaintext
Raw Normal View History

Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
---
docs: update structure (#8506) - moved and renamed files/folders based on new structure - updated docs navigation based on new structure - moved CLI to top nav (created commands.jsx and commands-navigation.js) - updated and added redirects - updating to be consistent with standalone categories - changing "overview" link in top nav to lead to where intro was moved (docs/intro) - adding redirects for intro content - deleting old intro folders - format all data/navigation files - deleting old commands folder - reverting changes to glossary page - adjust intro navigation for removal of 'vs' paths - add helm page redirect - fix more redirects - add a missing redirect - fix broken anchor links and formatting mistakes - deleted duplicate section, added redirect, changed link - removed duplicate glossary page
2020-09-01 15:14:13 +00:00
layout: commands
intro and api navigation converted
2020-04-07 18:55:19 +00:00
page_title: 'Commands: Config List'
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>
2023-01-26 18:42:13 +00:00
description: >-
The `consul config list` command lists all configuration entries for each config entry kind.
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
---
# Consul Config List
Command: `consul config list`
docs: Migrate link formats (#15976) * Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * Updating docs-content-check-legacy-links-format hash * Migrating links to new format Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 16:52:43 +00:00
Corresponding HTTP API Endpoint: [\[GET\] /v1/config/:kind](/consul/api-docs/config#list-configurations)
Added Corresponding HTTP API Endpoints for every CLI command
2022-01-10 17:40:11 +00:00
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
The `config list` command lists all given config entries of the given kind.
docs: Migrate link formats (#15976) * Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * Updating docs-content-check-legacy-links-format hash * Migrating links to new format Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 16:52:43 +00:00
See the [configuration entries docs](/consul/docs/agent/config-entries) for more
Add some config entry docs (#5808) * Add some config entry docs * Update website/source/docs/agent/config_entries.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com> * Update website/source/docs/agent/config_entries.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com> * Get rid of double negative * Some incremental updates * Update the config list docs to not point to service-default related things. * A few more doc updates to get rid of some service-defaults specific linking info in the cli docs * In progress update * Update website/source/docs/agent/config_entries.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com> * Reword bootstrap section * Update example proxy-defaults config * Finish up the examples section for managing config entries with the CLI * Update website/source/docs/agent/config_entries.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com> * Use $ for shell command start * Make it very clear that the normal way to manage things is via the API/CLI * Update website/source/docs/agent/options.html.md Co-Authored-By: mkeeler <mkeeler@users.noreply.github.com>
2019-05-08 20:19:37 +00:00
details about configuration entries.
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
docs: Migrate link formats (#15976) * Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * Updating docs-content-check-legacy-links-format hash * Migrating links to new format Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 16:52:43 +00:00
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication). Configuration of
[blocking queries](/consul/api-docs/features/blocking) and [agent caching](/consul/api-docs/features/caching)
Added ACL requirements for CLI commands
2022-01-10 21:44:56 +00:00
are not supported from commands, but may be from the corresponding HTTP endpoint.
Added some missing ACL info, updated details around some permissions, added missing HTTP API refs
2022-01-11 14:41:54 +00:00
| ACL Required<sup>1</sup> |
| ------------------------------------- |
| `service:read`<br />`intentions:read` |
<sup>1</sup> The ACL required depends on the config entry kind being read:
| Config Entry Kind | Required ACL |
| ------------------- | ----------------- |
Backport of Add validation for apigw creation with no routes into release/1.15.x (#16679)
2023-03-20 18:14:05 +00:00
| api-gateway | `mesh:read` |
Added some missing ACL info, updated details around some permissions, added missing HTTP API refs
2022-01-11 14:41:54 +00:00
| ingress-gateway | `service:read` |
| proxy-defaults | `<none>` |
| service-defaults | `service:read` |
| service-intentions | `intentions:read` |
| service-resolver | `service:read` |
| service-router | `service:read` |
| service-splitter | `service:read` |
| terminating-gateway | `service:read` |
Added ACL requirements for CLI commands
2022-01-10 21:44:56 +00:00
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
## Usage
Usage: `consul config list [options]`
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
#### Command Options
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
- `-kind` - Specifies the kind of the config entry to list.
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
Update config entry docs for namespaces
2020-02-07 20:01:04 +00:00
#### Enterprise Options
Website fixups for admin partitions (#11842) * Website fixups for admin partitions Signed-off-by: Mark Anderson <manderson@hashicorp.com>
2021-12-15 01:55:21 +00:00
@include 'http_api_partition_options.mdx'
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
@include 'http_api_namespace_options.mdx'
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
#### API Options
@include 'http_api_options_client.mdx'
Config Entry docs (#5734) * Add api docs for the config entry endpoints * Add enable_central_service_config field to agent docs * Add docs for config entry CLI operations * Fix wording and links in config entry docs * Add links to the central service config option * Update the central service config setting description.
2019-05-01 18:21:11 +00:00
## Examples
$ consul config list -kind service-defaults
billing
db
web