dbeb8a23dc
docs: link pq docs to relevant DNS lookup section
2022-08-23 06:02:47 -07:00
21b5aade56
Cluster Peering Prepared Query Failover Documentation ( #13846 )
...
Add documentation for cluster peering prepared query failover
2022-08-12 11:06:16 -04:00
3989a8b71c
Add peering ACL docs ( #13855 )
...
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
2022-08-08 11:44:25 -06:00
dd81f6a76f
docs: adjust HTTP API/CLI characteristics tables
2022-07-25 15:31:39 -07:00
dd12584981
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
1e6ddc8f82
Apply suggestions from code review
2022-06-17 13:36:20 -05:00
85463445b4
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
42f7d6a403
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
082bc3632b
Add peering endpoint API docs ( #13454 )
2022-06-15 14:18:14 -06:00
f155ff347c
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
c4cc793066
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
daf5e3ea10
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
45ff0ebc91
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
d335a2a711
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
4de15e822f
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
a18d7092cb
Merge pull request #12463 from hashicorp/docs/consistency-mode-improvements
...
Improve consistency mode docs
2022-05-09 23:04:00 -04:00
bc69d70a55
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
01ef26dea0
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
b9ec2222db
docs: simplify agent docs slugs
2022-04-11 17:38:47 -07:00
cd73f27c84
docs: fix external links to agent config pages
2022-04-11 17:38:11 -07:00
b3db499c74
Add a field to disable following redirects on http checks
2022-04-05 16:12:18 -07:00
7a016a4c46
Add doc examples for expanded token read CLI and API
2022-03-31 15:03:41 -07:00
04ec4c2aa4
website: redirect /api to /api-docs ( #12660 )
2022-03-30 16:16:26 -05:00
fcec9a18ce
docs: mention filtered by ACLs in affected APIs
2022-03-21 09:06:45 -07:00
e90c2a6994
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
724838e600
docs: add filtered by ACLs header curl example
2022-03-18 15:47:08 -07:00
37385058d8
docs: mention filtered by ACLs in coordinate API
2022-03-18 15:47:08 -07:00
1ae820ea0a
Revert "[Docs] Agent configuration hierarchy "
2022-03-15 16:13:58 -07:00
667976c94f
fixing merge conflicts part 3
2022-03-15 15:25:03 -07:00
60a88bb40f
merging new hierarchy for agent configuration
2022-03-14 15:44:41 -07:00
b588620385
fixing merge conflicts
2022-03-01 09:08:20 -08:00
f46bbb7205
Fix spelling errors
2022-01-20 08:54:23 -08:00
d81889bb41
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
9d24242b73
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
fa6200bba3
docs: add missing link for intention list
2022-01-15 09:31:27 -08:00
65d5836951
docs: don't treat CLI cmd cross-ref as info box
2022-01-15 09:29:35 -08:00
5a12f2cf20
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
e210e7cb58
CLI Link clean-up
2022-01-11 15:51:04 -05:00
fd71fdbefb
Fixing CircleCI issues and adding Partition CLI links
2022-01-11 11:46:50 -05:00
cd0405ff0d
Correcting CLI links and grammer changes part 2
2022-01-11 11:26:05 -05:00
db58296ce8
Correcting CLI links and grammer changes
2022-01-11 10:41:48 -05:00
0f6e660077
Correcting CLI links and grammer changes
2022-01-11 10:37:48 -05:00
7f61e9f677
Editing links and grammer changes
2022-01-11 10:36:09 -05:00
d33bcda622
docs: move the ACL 'Authorization' section
...
This section was actually about authentication (not authorization).
We already have sections in our api and cli docs. This commit removes the section and replaces
it with a short paragraph in the Tokens section which links to the existing docs.
2022-01-10 17:10:39 -05:00
309f1eab4b
Updating HTTP API endpoints with CLI equivalent links
2022-01-10 14:21:32 -05:00
14e1898544
Add LastErrorMessage to /acl/replication docs ( #11990 )
2022-01-10 13:42:57 -05:00
dd8d8fb6fd
Incorporate feedback from @jkirschner-hashicorp and @karl-cardenas-coding
2022-01-10 15:53:41 +00:00
e69ad56141
docs: clarify transaction usage and limitations in kv api docs
2022-01-10 13:59:43 +00:00
952bb3c4a2
docs: Fix service_id description on agent deregister API
2021-12-22 09:43:20 -08:00
80ce6b54e2
Document /v1/agent/force-leave prune and wan params ( #11886 )
...
Document prune parameter added in #6571 and wan parameter added in
#11722 .
Co-authored-by: Freddy <freddygv@users.noreply.github.com>
2021-12-20 15:56:13 -08:00
Jared Kirschner