-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Open
Labels
docstring-updatestring editsstring editsdocumentationRelates to Salt documentationRelates to Salt documentationmodule doc standardsseverity-medium3rd level, incorrect or bad functionality, confusing and lacks a work around3rd level, incorrect or bad functionality, confusing and lacks a work aroundtime-estimate-sprint
Milestone
Description
Description
Description of http_connect_timeout and http_request_timeout is misleading.
- both have the same description, including note that they should be both bigger than complete request, which is wrong (and default value suggest that)
- they are documented for both master and minion, but looking at code it seems to me only minion is actually using this value.
Suggested Fix
- change description of
http_connect_timeoutto reflect what Tornado says:Timeout for initial connection in secondsand remove suggestion that it should be longer than duration of complete request. - remove those configuration values from salt master documentation.
Type of documentation
Salt documentation
Location or format of documentation
- https://docs.saltproject.io/en/latest/ref/configuration/minion.html#http-connect-timeout
- https://docs.saltproject.io/en/latest/ref/configuration/master.html#http-connect-timeout
Additional context
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
docstring-updatestring editsstring editsdocumentationRelates to Salt documentationRelates to Salt documentationmodule doc standardsseverity-medium3rd level, incorrect or bad functionality, confusing and lacks a work around3rd level, incorrect or bad functionality, confusing and lacks a work aroundtime-estimate-sprint