fix GraceTimeOut description

Documentation stated that GraceTimeOut describes the timeout between
hot-reloads, which is not the case. GraceTimeOut describes the timeout
Traefik uses to finish serving active requests before stopping only.
This commit is contained in:
Marco Jantke 2017-07-18 11:50:07 +02:00 committed by Ludovic Fernandez
parent 40d9058bb6
commit cd28e7b24f
3 changed files with 9 additions and 9 deletions

View file

@ -9,10 +9,10 @@
# Global configuration # Global configuration
################################################################ ################################################################
# Duration to give active requests a chance to finish during hot-reloads. # Duration to give active requests a chance to finish before Traefik stops.
# Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw # Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw values (digits).
# values (digits). If no units are provided, the value is parsed assuming # If no units are provided, the value is parsed assuming seconds.
# seconds. # Note: in this time frame no new requests are accepted.
# #
# Optional # Optional
# Default: "10s" # Default: "10s"

View file

@ -40,7 +40,7 @@ type TraefikConfiguration struct {
// GlobalConfiguration holds global configuration (with providers, etc.). // GlobalConfiguration holds global configuration (with providers, etc.).
// It's populated from the traefik configuration file passed as an argument to the binary. // It's populated from the traefik configuration file passed as an argument to the binary.
type GlobalConfiguration struct { type GlobalConfiguration struct {
GraceTimeOut flaeg.Duration `short:"g" description:"Duration to give active requests a chance to finish during hot-reload"` GraceTimeOut flaeg.Duration `short:"g" description:"Duration to give active requests a chance to finish before Traefik stops"`
Debug bool `short:"d" description:"Enable debug mode"` Debug bool `short:"d" description:"Enable debug mode"`
CheckNewVersion bool `description:"Periodically check if a new version has been released"` CheckNewVersion bool `description:"Periodically check if a new version has been released"`
AccessLogsFile string `description:"(Deprecated) Access logs file"` // Deprecated AccessLogsFile string `description:"(Deprecated) Access logs file"` // Deprecated

View file

@ -2,10 +2,10 @@
# Global configuration # Global configuration
################################################################ ################################################################
# Duration to give active requests a chance to finish during hot-reloads. # Duration to give active requests a chance to finish before Traefik stops.
# Can be provided in a format supported by Go's time.ParseDuration function or # Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw values (digits).
# as raw values (digits). If no units are provided, the value is parsed assuming # If no units are provided, the value is parsed assuming seconds.
# seconds. # Note: in this time frame no new requests are accepted.
# #
# Optional # Optional
# Default: "10s" # Default: "10s"