Documentation
¶
Overview ¶
Package serverutil holds code for running Trillian servers.
Index ¶
Constants ¶
View Source
const ( // DefaultTreeDeleteThreshold is the suggested threshold for tree deletion. // It represents the minimum time a tree has to remain Deleted before being hard-deleted. DefaultTreeDeleteThreshold = 7 * 24 * time.Hour // DefaultTreeDeleteMinInterval is the suggested min interval between tree GC sweeps. // A tree GC sweep consists of listing deleted trees older than the deletion threshold and // hard-deleting them. // Actual runs happen randomly between [minInterval,2*minInterval). DefaultTreeDeleteMinInterval = 4 * time.Hour )
Variables ¶
This section is empty.
Functions ¶
func AnnounceSelf ¶
func AnnounceSelf(ctx context.Context, client *clientv3.Client, etcdService, endpoint string, cancel func()) func()
AnnounceSelf announces this binary's presence to etcd. This calls the cancel function if the keepalive lease with etcd expires. Returns a function that should be called on process exit. AnnounceSelf does nothing if client is nil.
Types ¶
type Main ¶
type Main struct {
// Endpoints for RPC and HTTP servers.
// HTTP is optional, if empty it'll not be bound.
RPCEndpoint, HTTPEndpoint string
// TLS Certificate and Key files for the server.
TLSCertFile, TLSKeyFile string
DBClose func() error
Registry extension.Registry
StatsPrefix string
QuotaDryRun bool
// RegisterServerFn is called to register RPC servers.
RegisterServerFn func(*grpc.Server, extension.Registry) error
// IsHealthy will be called whenever "/healthz" is called on the mux.
// A nil return value from this function will result in a 200-OK response
// on the /healthz endpoint.
IsHealthy func(context.Context) error
// HealthyDeadline is the maximum duration to wait wait for a successful
// IsHealthy() call.
HealthyDeadline time.Duration
// AllowedTreeTypes determines which types of trees may be created through the Admin Server
// bound by Main. nil means unrestricted.
AllowedTreeTypes []trillian.TreeType
TreeGCEnabled bool
TreeDeleteThreshold time.Duration
TreeDeleteMinInterval time.Duration
// These will be added to the GRPC server options.
ExtraOptions []grpc.ServerOption
}
Main encapsulates the data and logic to start a Trillian server (Log or Map).
Source Files
Click to show internal directories.
Click to hide internal directories.