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.

Sign up for GitHub

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

Ensure the proxy service shuts down properly in case of partial init #50710

Merged
merged 2 commits into from
Jan 7, 2025
Merged

Ensure the proxy service shuts down properly in case of partial init #50710

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a969f9a
Ensure the proxy service shuts dowqn properly in case of partial init
hugoShaka Jan 2, 2025
5d5f4b2
Apply suggestions from code review
hugoShaka Jan 6, 2025
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
293 changes: 158 additions & 135 deletions lib/service/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4365,11 +4365,162 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
return trace.Wrap(err)
}

// We register the shutdown function before starting the services because we want to run it even if we encounter an
// error and return early. Some of the registered services don't watch if the context is Done (e.g. proxy.web).
// In case of error, if we don't run "proxy.shutdown", those registered services will run ad vitam aeternam and
// Supervisor.Wait() won't return.
var (
tsrv reversetunnelclient.Server
peerClient *peer.Client
peerQUICTransport *quic.Transport
rcWatcher *reversetunnel.RemoteClusterTunnelManager
peerServer *peer.Server
peerQUICServer *peerquic.Server
webServer *web.Server
minimalWebServer *web.Server
sshProxy *regular.Server
sshGRPCServer *grpc.Server
kubeServer *kubeproxy.TLSServer
grpcServerPublic *grpc.Server
grpcServerMTLS *grpc.Server
alpnServer *alpnproxy.Proxy
reverseTunnelALPNServer *alpnproxy.Proxy
clientTLSConfigGenerator *auth.ClientTLSConfigGenerator
)

defer func() {
rosstimothy marked this conversation as resolved.
Show resolved Hide resolved
// execute this when process is asked to exit:
process.OnExit("proxy.shutdown", func(payload interface{}) {
// Close the listeners at the beginning of shutdown, because we are not
// really guaranteed to be capable to serve new requests if we're
// halfway through a shutdown, and double closing a listener is fine.
listeners.Close()
if payload == nil {
logger.InfoContext(process.ExitContext(), "Shutting down immediately")
if tsrv != nil {
warnOnErr(process.ExitContext(), tsrv.Close(), logger)
}
if rcWatcher != nil {
warnOnErr(process.ExitContext(), rcWatcher.Close(), logger)
}
if peerServer != nil {
warnOnErr(process.ExitContext(), peerServer.Close(), logger)
}
if peerQUICServer != nil {
warnOnErr(process.ExitContext(), peerQUICServer.Close(), logger)
}
if webServer != nil {
warnOnErr(process.ExitContext(), webServer.Close(), logger)
}
if minimalWebServer != nil {
warnOnErr(process.ExitContext(), minimalWebServer.Close(), logger)
}
if peerClient != nil {
warnOnErr(process.ExitContext(), peerClient.Stop(), logger)
}
if sshProxy != nil {
warnOnErr(process.ExitContext(), sshProxy.Close(), logger)
}
if sshGRPCServer != nil {
sshGRPCServer.Stop()
}
if kubeServer != nil {
warnOnErr(process.ExitContext(), kubeServer.Close(), logger)
}
if grpcServerPublic != nil {
grpcServerPublic.Stop()
}
if grpcServerMTLS != nil {
grpcServerMTLS.Stop()
}
if alpnServer != nil {
warnOnErr(process.ExitContext(), alpnServer.Close(), logger)
}
if reverseTunnelALPNServer != nil {
warnOnErr(process.ExitContext(), reverseTunnelALPNServer.Close(), logger)
}

if clientTLSConfigGenerator != nil {
clientTLSConfigGenerator.Close()
}
} else {
logger.InfoContext(process.ExitContext(), "Shutting down gracefully")
ctx := payloadContext(payload)
if tsrv != nil {
warnOnErr(ctx, tsrv.DrainConnections(ctx), logger)
}
if sshProxy != nil {
warnOnErr(ctx, sshProxy.Shutdown(ctx), logger)
}
if sshGRPCServer != nil {
sshGRPCServer.GracefulStop()
}
if webServer != nil {
warnOnErr(ctx, webServer.Shutdown(ctx), logger)
}
if minimalWebServer != nil {
warnOnErr(ctx, minimalWebServer.Shutdown(ctx), logger)
}
if tsrv != nil {
warnOnErr(ctx, tsrv.Shutdown(ctx), logger)
}
if rcWatcher != nil {
warnOnErr(ctx, rcWatcher.Close(), logger)
}
if peerServer != nil {
warnOnErr(ctx, peerServer.Shutdown(), logger)
}
if peerQUICServer != nil {
warnOnErr(ctx, peerQUICServer.Shutdown(ctx), logger)
}
if peerClient != nil {
peerClient.Shutdown(ctx)
}
if kubeServer != nil {
warnOnErr(ctx, kubeServer.Shutdown(ctx), logger)
}
if grpcServerPublic != nil {
grpcServerPublic.GracefulStop()
}
if grpcServerMTLS != nil {
grpcServerMTLS.GracefulStop()
}
if alpnServer != nil {
warnOnErr(ctx, alpnServer.Close(), logger)
}
if reverseTunnelALPNServer != nil {
warnOnErr(ctx, reverseTunnelALPNServer.Close(), logger)
}

// Explicitly deleting proxy heartbeats helps the behavior of
// reverse tunnel agents during rollouts, as otherwise they'll keep
// trying to reach proxies until the heartbeats expire.
if services.ShouldDeleteServerHeartbeatsOnShutdown(ctx) {
if err := conn.Client.DeleteProxy(ctx, process.Config.HostUUID); err != nil {
if !trace.IsNotFound(err) {
logger.WarnContext(ctx, "Failed to delete heartbeat", "error", err)
} else {
logger.DebugContext(ctx, "Failed to delete heartbeat", "error", err)
}
}
}

if clientTLSConfigGenerator != nil {
clientTLSConfigGenerator.Close()
}
}
if peerQUICTransport != nil {
_ = peerQUICTransport.Close()
_ = peerQUICTransport.Conn.Close()
}
warnOnErr(process.ExitContext(), asyncEmitter.Close(), logger)
warnOnErr(process.ExitContext(), conn.Close(), logger)
logger.InfoContext(process.ExitContext(), "Exited")
})
}()

// register SSH reverse tunnel server that accepts connections
// from remote teleport nodes
var tsrv reversetunnelclient.Server
var peerClient *peer.Client
var peerQUICTransport *quic.Transport
if !process.Config.Proxy.DisableReverseTunnel {
if listeners.proxyPeer != nil {
if process.Config.Proxy.QUICProxyPeering {
Expand Down Expand Up @@ -4510,8 +4661,6 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {

// Register web proxy server
alpnHandlerForWeb := &alpnproxy.ConnectionHandlerWrapper{}
var webServer *web.Server
var minimalWebServer *web.Server

if !process.Config.Proxy.DisableWebService {
var fs http.FileSystem
Expand Down Expand Up @@ -4755,8 +4904,6 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
}

var peerAddrString string
var peerServer *peer.Server
var peerQUICServer *peerquic.Server
if !process.Config.Proxy.DisableReverseTunnel && listeners.proxyPeer != nil {
peerAddr, err := process.Config.Proxy.PublicPeerAddr()
if err != nil {
Expand Down Expand Up @@ -4849,7 +4996,7 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
logger.InfoContext(process.ExitContext(), "advertising proxy peering QUIC support")
}

sshProxy, err := regular.New(
sshProxy, err = regular.New(
process.ExitContext(),
cfg.SSH.Addr,
cfg.Hostname,
Expand Down Expand Up @@ -4912,7 +5059,7 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
}

// clientTLSConfigGenerator pre-generates specialized per-cluster client TLS config values
clientTLSConfigGenerator, err := auth.NewClientTLSConfigGenerator(auth.ClientTLSConfigGeneratorConfig{
clientTLSConfigGenerator, err = auth.NewClientTLSConfigGenerator(auth.ClientTLSConfigGeneratorConfig{
TLS: sshGRPCTLSConfig,
ClusterName: clusterName,
PermitRemoteClusters: true,
Expand All @@ -4933,7 +5080,7 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
return trace.Wrap(err)
}

sshGRPCServer := grpc.NewServer(
sshGRPCServer = grpc.NewServer(
grpc.ChainUnaryInterceptor(
interceptors.GRPCServerUnaryErrorInterceptor,
//nolint:staticcheck // SA1019. There is a data race in the stats.Handler that is replacing
Expand Down Expand Up @@ -5017,7 +5164,7 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
rcWatchLog := process.logger.With(teleport.ComponentKey, teleport.Component(teleport.ComponentReverseTunnelAgent, process.id))

// Create and register reverse tunnel AgentPool.
rcWatcher, err := reversetunnel.NewRemoteClusterTunnelManager(reversetunnel.RemoteClusterTunnelManagerConfig{
rcWatcher, err = reversetunnel.NewRemoteClusterTunnelManager(reversetunnel.RemoteClusterTunnelManagerConfig{
HostUUID: conn.HostID(),
AuthClient: conn.Client,
AccessPoint: accessPoint,
Expand Down Expand Up @@ -5046,7 +5193,6 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
return nil
})

var kubeServer *kubeproxy.TLSServer
if listeners.kube != nil && !process.Config.Proxy.DisableReverseTunnel {
authorizer, err := authz.NewAuthorizer(authz.AuthorizerOpts{
ClusterName: clusterName,
Expand Down Expand Up @@ -5264,10 +5410,6 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
}
}

var (
grpcServerPublic *grpc.Server
grpcServerMTLS *grpc.Server
)
if alpnRouter != nil {
grpcServerPublic, err = process.initPublicGRPCServer(proxyLimiter, conn, listeners.grpcPublic)
if err != nil {
Expand All @@ -5294,8 +5436,6 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
}
}

var alpnServer *alpnproxy.Proxy
var reverseTunnelALPNServer *alpnproxy.Proxy
if !cfg.Proxy.DisableTLS && !cfg.Proxy.DisableALPNSNIListener && listeners.web != nil {
authDialerService := alpnproxyauth.NewAuthProxyDialerService(
tsrv,
Expand Down Expand Up @@ -5358,123 +5498,6 @@ func (process *TeleportProcess) initProxyEndpoint(conn *Connector) error {
}
}

// execute this when process is asked to exit:
process.OnExit("proxy.shutdown", func(payload interface{}) {
// Close the listeners at the beginning of shutdown, because we are not
// really guaranteed to be capable to serve new requests if we're
// halfway through a shutdown, and double closing a listener is fine.
listeners.Close()
if payload == nil {
logger.InfoContext(process.ExitContext(), "Shutting down immediately.")
if tsrv != nil {
warnOnErr(process.ExitContext(), tsrv.Close(), logger)
}
warnOnErr(process.ExitContext(), rcWatcher.Close(), logger)
if peerServer != nil {
warnOnErr(process.ExitContext(), peerServer.Close(), logger)
}
if peerQUICServer != nil {
warnOnErr(process.ExitContext(), peerQUICServer.Close(), logger)
}
if webServer != nil {
warnOnErr(process.ExitContext(), webServer.Close(), logger)
}
if minimalWebServer != nil {
warnOnErr(process.ExitContext(), minimalWebServer.Close(), logger)
}
if peerClient != nil {
warnOnErr(process.ExitContext(), peerClient.Stop(), logger)
}
warnOnErr(process.ExitContext(), sshProxy.Close(), logger)
sshGRPCServer.Stop()
if kubeServer != nil {
warnOnErr(process.ExitContext(), kubeServer.Close(), logger)
}
if grpcServerPublic != nil {
grpcServerPublic.Stop()
}
if grpcServerMTLS != nil {
grpcServerMTLS.Stop()
}
if alpnServer != nil {
warnOnErr(process.ExitContext(), alpnServer.Close(), logger)
}
if reverseTunnelALPNServer != nil {
warnOnErr(process.ExitContext(), reverseTunnelALPNServer.Close(), logger)
}

if clientTLSConfigGenerator != nil {
clientTLSConfigGenerator.Close()
}
} else {
logger.InfoContext(process.ExitContext(), "Shutting down gracefully.")
ctx := payloadContext(payload)
if tsrv != nil {
warnOnErr(ctx, tsrv.DrainConnections(ctx), logger)
}
warnOnErr(ctx, sshProxy.Shutdown(ctx), logger)
sshGRPCServer.GracefulStop()
if webServer != nil {
warnOnErr(ctx, webServer.Shutdown(ctx), logger)
}
if minimalWebServer != nil {
warnOnErr(ctx, minimalWebServer.Shutdown(ctx), logger)
}
if tsrv != nil {
warnOnErr(ctx, tsrv.Shutdown(ctx), logger)
}
warnOnErr(ctx, rcWatcher.Close(), logger)
if peerServer != nil {
warnOnErr(ctx, peerServer.Shutdown(), logger)
}
if peerQUICServer != nil {
warnOnErr(ctx, peerQUICServer.Shutdown(ctx), logger)
}
if peerClient != nil {
peerClient.Shutdown(ctx)
}
if kubeServer != nil {
warnOnErr(ctx, kubeServer.Shutdown(ctx), logger)
}
if grpcServerPublic != nil {
grpcServerPublic.GracefulStop()
}
if grpcServerMTLS != nil {
grpcServerMTLS.GracefulStop()
}
if alpnServer != nil {
warnOnErr(ctx, alpnServer.Close(), logger)
}
if reverseTunnelALPNServer != nil {
warnOnErr(ctx, reverseTunnelALPNServer.Close(), logger)
}

// Explicitly deleting proxy heartbeats helps the behavior of
// reverse tunnel agents during rollouts, as otherwise they'll keep
// trying to reach proxies until the heartbeats expire.
if services.ShouldDeleteServerHeartbeatsOnShutdown(ctx) {
if err := conn.Client.DeleteProxy(ctx, process.Config.HostUUID); err != nil {
if !trace.IsNotFound(err) {
logger.WarnContext(ctx, "Failed to delete heartbeat.", "error", err)
} else {
logger.DebugContext(ctx, "Failed to delete heartbeat.", "error", err)
}
}
}

if clientTLSConfigGenerator != nil {
clientTLSConfigGenerator.Close()
}
}
if peerQUICTransport != nil {
_ = peerQUICTransport.Close()
_ = peerQUICTransport.Conn.Close()
}
warnOnErr(process.ExitContext(), asyncEmitter.Close(), logger)
warnOnErr(process.ExitContext(), conn.Close(), logger)
logger.InfoContext(process.ExitContext(), "Exited.")
})

return nil
}

Expand Down
Loading