Add a field to disable following redirects on http checks #12685
Conversation
github-actions
bot
added
theme/config
|
🤔 This PR has changes in the |
kyhavlov
force-pushed
the
http-check-redirect-option
branch
from
42af751
to
c1cf838
Compare
| @@ -206,6 +206,9 @@ The table below shows this endpoint's support for | |||
|
|
|||
| - `Body` `(string: "")` - Specifies a body that should be sent with `HTTP` checks. | |||
|
|
|||
| - `DisableRedirects` `(bool: false)` - Specifies whether to disable following HTTP | |||
There was a problem hiding this comment.
Do we want caveat about the future change in the default here as well?
There was a problem hiding this comment.
Do we want caveat about the future change in the default here as well?
Friends, no. As a general technical communication principle, we describe current functionality and never future functionality. It potentially causes confusion for users and maintenance overhead.
There was a problem hiding this comment.
If our intent is to change the default later (which would be a breaking change for health checks that relied on redirects) shouldn't we document that beforehand? Or is a changelog note enough?
There was a problem hiding this comment.
It might be better to state this in the 1.12 release notes. When the default value is changed in a later release, it should be called out as a breaking change in the changelog, and also mentioned in the upgrade guide.
There was a problem hiding this comment.
Ok - it's in the changelog but I removed both occurrences of the note from the docs
kyhavlov
force-pushed
the
http-check-redirect-option
branch
from
c1cf838
to
7b773e1
Compare
| @@ -206,6 +206,9 @@ The table below shows this endpoint's support for | |||
|
|
|||
| - `Body` `(string: "")` - Specifies a body that should be sent with `HTTP` checks. | |||
|
|
|||
| - `DisableRedirects` `(bool: false)` - Specifies whether to disable following HTTP | |||
There was a problem hiding this comment.
Do we want caveat about the future change in the default here as well?
Friends, no. As a general technical communication principle, we describe current functionality and never future functionality. It potentially causes confusion for users and maintenance overhead.
| By default, Consul will follow HTTP redirects. This can be disabled by setting the | ||
| `disable_redirects` field to `true`. In a future release, this will default to true. |
There was a problem hiding this comment.
| By default, Consul will follow HTTP redirects. This can be disabled by setting the | |
| `disable_redirects` field to `true`. In a future release, this will default to true. | |
| Consul follows HTTP redirects by default. Set the | |
| `disable_redirects` field to `true` to disable redirects. |
kyhavlov
force-pushed
the
http-check-redirect-option
branch
from
7b773e1
to
3b44343
Compare
|
🍒 If backport labels were added before merging, cherry-picking will start automatically. To retroactively trigger a backport after merging, add backport labels and re-run https://circleci.com/gh/hashicorp/consul/630473. |
|
🍒✅ Cherry pick of commit 9780b67 onto |
Add a field to disable following redirects on http checks
This PR adds a new option for HTTP checks,
disable_redirects, that allows for disabling the following of redirects for HTTP checks. The intention is to default this to true in a future release so that redirects must explicitly be enabled.