127 Commits

Author SHA1 Message Date
Tu Nguyen
110139a4df revert links to learn 2022-09-06 08:35:01 -07:00
Tu Nguyen
c94f8c26c2
Merge branch 'main' into dev-portal 2022-08-31 11:21:14 -07:00
Jeff Boruszak
e56fd9a45a docs: Additional feedback from PR #12971
This commit incorporates additional feedback received related to
PR #12971.
2022-08-30 11:14:53 -07:00
Tu Nguyen
f06348c73e fix merge conflicts 2022-08-28 19:33:37 -07:00
Chris S. Kim
87962b9713 Merge branch 'main' into catalog-service-list-filter 2022-08-26 11:16:06 -04:00
Tu Nguyen
6dcc2a2110 Update Learn links in prep for devdot 2022-08-25 22:49:29 -07:00
Jared Kirschner
20f291fa06 docs: improve health check related docs
Includes:
- Improved scannability and organization of checks overview
- Checks overview includes more guidance on
  - How to register a health check
  - The options available for a health check definition
- Contextual cross-references to maintenance mode
2022-08-25 13:47:22 -07:00
Jared Kirschner
b0ef7a6674 docs: link pq docs to relevant DNS lookup section 2022-08-23 06:02:47 -07:00
Eric Haberkorn
d281c89ad0
Cluster Peering Prepared Query Failover Documentation (#13846)
Add documentation for cluster peering prepared query failover
2022-08-12 11:06:16 -04:00
Daniel Kimsey
3c4fa9b468 Add support for filtering the 'List Services' API
1. Create a bexpr filter for performing the filtering
2. Change the state store functions to return the raw (not aggregated)
   list of ServiceNodes.
3. Move the aggregate service tags by name logic out of the state store
   functions into a new function called from the RPC endpoint
4. Perform the filtering in the endpoint before aggregation.
2022-08-10 16:52:32 -05:00
Freddy
0455b5e720
Add peering ACL docs (#13855)
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
2022-08-08 11:44:25 -06:00
Jared Kirschner
6add1039b3 docs: adjust HTTP API/CLI characteristics tables 2022-07-25 15:31:39 -07:00
Jared Kirschner
03924fdb30 docs: restructure partition API characteristics
The existing characteristics were restructured into a list.
The corresponding CLI command characteristic was added.
2022-07-25 15:31:38 -07:00
Jeff Boruszak
95aa915b42
Apply suggestions from code review 2022-06-17 13:36:20 -05:00
Jeff Boruszak
5062e89651
Apply suggestions from code review
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-06-17 12:31:11 -05:00
Chris S. Kim
a4c28d1aea
Update docs with peer query parameter (#13462)
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2022-06-16 16:25:44 -04:00
Freddy
7e30357c17
Add peering endpoint API docs (#13454) 2022-06-15 14:18:14 -06:00
Fulvio
d457d8b6ce
UDP check for service stanza #12221 (#12722)
* UDP check for service stanza #12221

* add pass status on timeout condition

* delete useless files

* Update check_test.go

improve comment in test

* fix test

* fix requested changes and update TestRuntimeConfig_Sanitize.golden

* add freeport to TestCheckUDPCritical

* improve comment for CheckUDP struct

* fix requested changes

* fix requested changes

* fix requested changes

* add UDP to proto

* add UDP to proto and add a changelog

* add requested test on agent_endpoint_test.go

* add test for given endpoints

* fix failing tests

* add documentation for udp healthcheck

* regenerate proto using buf

* Update website/content/api-docs/agent/check.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/api-docs/agent/check.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/docs/discovery/checks.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/docs/ecs/configuration-reference.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/docs/ecs/configuration-reference.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* add debug echo

* add debug circle-ci

* add debug circle-ci bash

* use echo instead of status_stage

* remove debug and status from devtools script and use echo instead

* Update website/content/api-docs/agent/check.mdx

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

* fix test

* replace status_stage with status

* replace functions with echo

Co-authored-by: Dhia Ayachi <dhia@hashicorp.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>
2022-06-06 15:13:19 -04:00
David Roca
357fe1c080
docs: Use .snap extension in API snapshot save/restore
Change the `.tgz` file extension in the snapshot save and restore
examples on /api-docs/snapshot to `.snap`.

This is consistent with the file extension used in other example
snapshot save and restore commands, as well as the default extension
used by the Consul Snapshot Agent.
2022-05-27 14:07:37 -07:00
Jared Kirschner
49a7e7086c docs: split HTTP API params into sections by type
Path parameters, query parameters, and request body parameters are now shown in
separate sections rather than combined into one general parameters section.
This makes it much easier to understand quickly where a parameter should be
provided.
2022-05-25 14:45:47 -07:00
Blake Covarrubias
4c0f840c89 docs: Clarify version restriction for snapshot restore
Clarify that Consul snapshots must be restored into clusters running
the same version as the cluster from where the snapshot was taken.
2022-05-10 10:50:37 -07:00
Jared Kirschner
05d1f59720
Merge pull request #12366 from hashicorp/docs/uri-decode-resource-names-for-http-api
Document API ability to URL-decode resource names
2022-05-10 11:54:38 -04:00
Jared Kirschner
a5354b50fb Document API ability to URL-decode resource names
All Consul HTTP API endpoints now URL-decode resource names specified in the
path, enabling resource names containing URL-invalid characters to be used
in HTTP API requests if URL-encoded into the path.

Functionality implemented in Github Pull Requests:
- #11335
- #11957
- #12103
- #12190
- #12297

Also documents CLI accepting URL-invalid resource names.

All Consul HTTP API endpoints now URL-decode resource names specified in the
path, enabling resource names containing URL-invalid characters to be used
in HTTP API requests if URL-encoded into the path. The Consul HTTP API always
supported URL-decoding of query parameters.

The CLI automatically URL-encodes arguments which are inserted as resource
names in the URL path, enabling the CLI to also interact with resource names
that contain URL-invalid characters.
2022-05-10 08:45:58 -07:00
Jared Kirschner
f4e1ade46a
Merge pull request #12463 from hashicorp/docs/consistency-mode-improvements
Improve consistency mode docs
2022-05-09 23:04:00 -04:00
Jared Kirschner
05a648f530 docs: clarify consistency mode operation
Changes include:
- Add diagrams of the operation of different consistency modes
- Note that only stale reads benefit from horizontal scaling
- Increase scannability with headings
- Document consistency mode defaults and how to override for
  DNS and HTTP API interfaces
- Document X-Consul-Effective-Consistency response header
2022-05-09 16:39:48 -07:00
Blake Covarrubias
a78015c5fd
docs: Redirect /docs/security/acl/acl-system (#12975)
/docs/security/acl/acl-system was renamed in e9a42df from PR #12460 to
/docs/security/acl. A corresponding redirect was not added for this
page, resulting in a 404 being returned when accessing the old URL
path.

This commit redirects the former URL path to the new location, and
also updates all links on the site to point to the new location.
2022-05-09 09:04:23 -07:00
Natalie Smith
0a51e145c1 docs: simplify agent docs slugs 2022-04-11 17:38:47 -07:00
Natalie Smith
ddae7d18a2 docs: fix external links to agent config pages 2022-04-11 17:38:11 -07:00
Kyle Havlovitz
3b44343276 Add a field to disable following redirects on http checks 2022-04-05 16:12:18 -07:00
Kyle Havlovitz
763f728df4 Add doc examples for expanded token read CLI and API 2022-03-31 15:03:41 -07:00
Bryce Kalow
6bf67b7ef4
website: redirect /api to /api-docs (#12660) 2022-03-30 16:16:26 -05:00
Jared Kirschner
ca2afce5d6 docs: mention filtered by ACLs in affected APIs 2022-03-21 09:06:45 -07:00
Jared Kirschner
bea07bd6e7
Merge pull request #12489 from hashicorp/docs/results-filtered-by-acl-awareness-coordinate
docs: mention filtered by ACLs in coordinate API
2022-03-19 16:17:08 -04:00
Jared Kirschner
1f9ca248e1 docs: add filtered by ACLs header curl example 2022-03-18 15:47:08 -07:00
Jared Kirschner
109ffcda26 docs: mention filtered by ACLs in coordinate API 2022-03-18 15:47:08 -07:00
mrspanishviking
7180c99960
Revert "[Docs] Agent configuration hierarchy " 2022-03-15 16:13:58 -07:00
trujillo-adam
4151dc097a fixing merge conflicts part 3 2022-03-15 15:25:03 -07:00
trujillo-adam
76d55ac2b4 merging new hierarchy for agent configuration 2022-03-14 15:44:41 -07:00
trujillo-adam
7e98a0dc7b fixing merge conflicts 2022-03-01 09:08:20 -08:00
Blake Covarrubias
f09aea524f Fix spelling errors 2022-01-20 08:54:23 -08:00
Blake Covarrubias
59394e4aa2 docs: Avoid redirects by pointing links to new URLs
Avoid HTTP redirects for internal site links by updating old URLs to
point to the new location for the target content.
2022-01-20 08:52:51 -08:00
Jared Kirschner
8a22562613
Merge pull request #12004 from hashicorp/consul-doc-day-changes-chip
Docs: Updating HTTP API endpoints with CLI equivalent links
2022-01-15 12:40:46 -05:00
Jared Kirschner
451fa0727f docs: add missing link for intention list 2022-01-15 09:31:27 -08:00
Jared Kirschner
0675b30e86 docs: don't treat CLI cmd cross-ref as info box 2022-01-15 09:29:35 -08:00
Blake Covarrubias
f273cfdc67
docs: Use long form of CLI flags (#12030)
Use long form of CLI flags in all example commands.

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
Co-authored-by: David Yu <dyu@hashicorp.com>
2022-01-12 15:05:01 -08:00
Chip Vaughn
2b3fa23425 CLI Link clean-up 2022-01-11 15:51:04 -05:00
Chip Vaughn
47067b0256 Fixing CircleCI issues and adding Partition CLI links 2022-01-11 11:46:50 -05:00
Chip Vaughn
c20050c883 Correcting CLI links and grammer changes part 2 2022-01-11 11:26:05 -05:00
Chip Vaughn
738016b3b0 Correcting CLI links and grammer changes 2022-01-11 10:41:48 -05:00
Chip Vaughn
4d6128d28d Correcting CLI links and grammer changes 2022-01-11 10:37:48 -05:00