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
589e7cfab4
docs: improve consistency of DNS lookup variables
...
Previously, some variables were wrapped in < > while others were not,
creating ambiguity in whether some labels were a string literal or a
variable.
Now, all variables are wrapped in < >.
2022-08-23 06:47:17 -07:00
Chris S. Kim
e27d1eb12c
Update docs for peered transparent proxy
2022-08-08 18:33:57 -04:00
Freddy
3542138e4d
Parse peer name for virtual IP DNS queries ( #13602 )
...
This commit updates the DNS query locality parsing so that the virtual
IP for an imported service can be queried.
Note that:
- Support for parsing a peer in other service discovery queries was not
added.
- Querying another datacenter for a virtual IP is not supported. This
was technically allowed in 1.11 but is being rolled back for 1.13
because it is not a use-case we intended to support. Virtual IPs in
different datacenters are going to collide because they are allocated
sequentially.
2022-07-06 10:30:04 -06:00
Kyle Havlovitz
0cfe43f594
docs: Clarify section on partitioned node DNS lookups
2022-06-22 10:41:13 -07:00
Kyle Havlovitz
7f62571419
Add dns node lookup support in partitions
2022-06-10 11:23:51 -07: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
Blake Covarrubias
ab9c7d2dd4
Remove unnecessary quotes from HCL variables
2022-05-13 10:35:24 -07:00
Blake Covarrubias
8edee753d1
docs: Fix spelling errors across site ( #12973 )
2022-05-10 07:28:33 -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
Bryce Kalow
6bf67b7ef4
website: redirect /api to /api-docs ( #12660 )
2022-03-30 16:16:26 -05:00
mrspanishviking
7180c99960
Revert "[Docs] Agent configuration hierarchy "
2022-03-15 16:13:58 -07:00
trujillo-adam
9cc9122be8
fixed merge conflicts pt2
2022-03-15 14:01:24 -07:00
trujillo-adam
76d55ac2b4
merging new hierarchy for agent configuration
2022-03-14 15:44:41 -07: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
Blake Covarrubias
1495a1f111
docs: Document .addr DNS domain in SRV responses ( #12056 )
...
Document `.addr` DNS subdomain that can be returned in SRV response
records.
Co-authored-by: Neena Pemmaraju <neena@hashicorp.com>
2022-01-19 09:45:30 -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
Blake Covarrubias
e3f36ad45c
docs: Fix spelling errors
2022-01-11 09:37:09 -08:00
Natalie Smith
24c67f2dfa
docs: simplify agent docs slugs
2022-01-10 17:37:18 -08:00
Natalie Smith
00c2444cfc
docs: fix external links to agent config pages
2022-01-10 17:11:50 -08:00
Preetha
92cc690e0d
Updated health check docs page with HCL examples ( #12000 )
...
All healthcheck JSON examples now have HCL equivalents.
2022-01-10 17:19:39 -06:00
Preetha
295ab0b3a5
Added HCL examples to service discovery page ( #11989 )
...
Improved HCL examples in the service discovery docs page
2022-01-10 13:12:42 -06:00
Kyle Havlovitz
b40e7da006
Update wording of partition format section
2021-12-14 15:56:49 -08:00
Kyle Havlovitz
1a03cd6a4c
docs: add virtual IP section to DNS docs
2021-12-14 11:39:17 -08:00
Kyle Havlovitz
d11c55e4c7
docs: Update namespaced DNS services section for partitions format
2021-12-14 11:05:41 -08:00
Jared Kirschner
d3018e6846
improve location of DNS alt domain docs section
2021-12-07 15:10:14 -05:00
Jared Kirschner
eb90c7f3ad
Merge pull request #11458 from kbabuadze/docs-altDomain-section
...
added Alternative Domain section to dns page in docs
2021-12-03 15:48:55 -05:00
Konstantine
34df6ced93
added hcl
2021-12-03 00:54:39 +02:00
Konstantine
0a3c012691
Update website/content/docs/discovery/dns.mdx
...
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-12-02 22:39:21 +02:00
Konstantine
664211d508
Update website/content/docs/discovery/dns.mdx
...
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-12-02 22:39:14 +02:00
Konstantine
a2205318ff
Update website/content/docs/discovery/dns.mdx
...
Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>
2021-12-02 22:39:02 +02:00
Konstantine
67c81de2af
Update website/content/docs/discovery/dns.mdx
...
Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>
2021-12-02 22:38:57 +02:00
Konstantine
b114124d2b
added missing 'be'
2021-11-22 01:17:33 +02:00
Konstantine
2900f3861a
Update website/content/docs/discovery/dns.mdx
...
Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>
2021-11-22 01:14:19 +02:00
Konstantine
eb21aab1b5
Update website/content/docs/discovery/dns.mdx
...
Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>
2021-11-22 01:09:39 +02:00
Konstantine
90e2828601
Update website/content/docs/discovery/dns.mdx
...
Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>
2021-11-22 01:07:22 +02:00
Konstantine
f02be1e2c3
Update website/content/docs/discovery/dns.mdx
...
Co-authored-by: Evan Culver <eculver@users.noreply.github.com>
2021-11-16 21:55:15 +02:00
Daniel Nephin
51d8417545
Merge pull request #10690 from tarat44/h2c-support-in-ping-checks
...
add support for h2c in h2 ping health checks
2021-11-02 13:53:06 -04:00
Konstantine
adaaa225e8
added Alternative Domain section to dns page in docs
2021-10-30 16:45:58 +03:00
Konstantine
ec98e33140
fixed configurations options order in dns.mdx
2021-10-27 02:33:36 +03:00
Konstantine
a8643339bc
describe how alt-domain works in docs
2021-10-26 12:38:13 -04:00
tarat44
e52f5071d0
fix mistakes in docs
2021-10-07 02:29:41 -04:00
tarat44
c1ed3a9a94
change config option to H2PingUseTLS
2021-10-05 00:12:21 -04:00
tarat44
092626986b
remove trailing comma from example in docs
2021-10-04 22:51:15 -04:00
tarat44
3c9f5a73d9
add support for h2c in h2 ping health checks
2021-10-04 22:51:08 -04:00
Daniel Nephin
1f9479603c
Add failures_before_warning to checks ( #10969 )
...
Signed-off-by: Jakub Sokołowski <jakub@status.im>
* agent: add failures_before_warning setting
The new setting allows users to specify the number of check failures
that have to happen before a service status us updated to be `warning`.
This allows for more visibility for detected issues without creating
alerts and pinging administrators. Unlike the previous behavior, which
caused the service status to not update until it reached the configured
`failures_before_critical` setting, now Consul updates the Web UI view
with the `warning` state and the output of the service check when
`failures_before_warning` is breached.
The default value of `FailuresBeforeWarning` is the same as the value of
`FailuresBeforeCritical`, which allows for retaining the previous default
behavior of not triggering a warning.
When `FailuresBeforeWarning` is set to a value higher than that of
`FailuresBeforeCritical it has no effect as `FailuresBeforeCritical`
takes precedence.
Resolves: https://github.com/hashicorp/consul/issues/10680
Signed-off-by: Jakub Sokołowski <jakub@status.im>
Co-authored-by: Jakub Sokołowski <jakub@status.im>
2021-09-14 12:47:52 -04:00
Jared Kirschner
b89832221c
docs: discuss use of ACLs on DNS page
2021-09-10 15:33:23 -07:00