Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add detail on ShutdownStopTimeout #7921

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions cmd/boulder-wfe2/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,19 @@ type Config struct {
TLSListenAddress string `validate:"omitempty,hostname_port"`

// Timeout is the per-request overall timeout. This should be slightly
// lower than the upstream's timeout when making requests to the WFE.
// lower than the upstream's timeout when making requests to this service.
Timeout config.Duration `validate:"-"`

// ShutdownStopTimeout determines the maximum amount of time to wait
// for extant request handlers to complete before exiting. It should be
// greater than Timeout.
ShutdownStopTimeout config.Duration

ServerCertificatePath string `validate:"required_with=TLSListenAddress"`
ServerKeyPath string `validate:"required_with=TLSListenAddress"`

AllowOrigins []string

ShutdownStopTimeout config.Duration

SubscriberAgreementURL string

TLS cmd.TLSConfig
Expand Down
11 changes: 7 additions & 4 deletions cmd/ocsp-responder/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,15 @@ type Config struct {
// OCSP requests. This has a default value of ":80".
ListenAddress string `validate:"omitempty,hostname_port"`

// When to timeout a request. This should be slightly lower than the
// upstream's timeout when making request to ocsp-responder.
// Timeout is the per-request overall timeout. This should be slightly
// lower than the upstream's timeout when making requests to this service.
Timeout config.Duration `validate:"-"`

// ShutdownStopTimeout determines the maximum amount of time to wait
// for extant request handlers to complete before exiting. It should be
// greater than Timeout.
ShutdownStopTimeout config.Duration

// How often a response should be signed when using Redis/live-signing
// path. This has a default value of 60h.
LiveSigningPeriod config.Duration `validate:"-"`
Expand All @@ -80,8 +85,6 @@ type Config struct {
// 40 * 5 / 0.02 = 10,000 requests before the oldest request times out.
MaxSigningWaiters int `validate:"min=0"`

ShutdownStopTimeout config.Duration

RequiredSerialPrefixes []string `validate:"omitempty,dive,hexadecimal"`

Features features.Config
Expand Down
7 changes: 4 additions & 3 deletions cmd/sfe/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,12 @@ type Config struct {
ListenAddress string `validate:"omitempty,hostname_port"`

// Timeout is the per-request overall timeout. This should be slightly
// lower than the upstream's timeout when making requests to the SFE.
// lower than the upstream's timeout when making requests to this service.
Timeout config.Duration `validate:"-"`

// ShutdownStopTimeout is the duration that the SFE will wait before
// shutting down any listening servers.
// ShutdownStopTimeout determines the maximum amount of time to wait
// for extant request handlers to complete before exiting. It should be
// greater than Timeout.
ShutdownStopTimeout config.Duration

TLS cmd.TLSConfig
Expand Down
Loading