Skip to content

[ws-proxy] Implement graceful shutdown #18583

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

Merged
merged 4 commits into from
Aug 28, 2023
Merged

[ws-proxy] Implement graceful shutdown #18583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7bf7f2
[ws-proxy] Implement graceful shutdown
aledbf Aug 23, 2023
6bcf027
Align termination grace period with http shutdown timeout
aledbf Aug 23, 2023
c89bac0
Address feedback
aledbf Aug 28, 2023
8fb7e30
Configure http server timeouts
aledbf Aug 28, 2023
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
12 changes: 8 additions & 4 deletions components/ws-proxy/cmd/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import (
"time"

"github.com/bombsimon/logrusr/v2"
"github.com/gitpod-io/golang-crypto/ssh"
"github.com/spf13/cobra"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
Expand All @@ -36,6 +35,7 @@ import (
"github.com/gitpod-io/gitpod/ws-proxy/pkg/config"
"github.com/gitpod-io/gitpod/ws-proxy/pkg/proxy"
"github.com/gitpod-io/gitpod/ws-proxy/pkg/sshproxy"
"github.com/gitpod-io/golang-crypto/ssh"
)

var (
Expand Down Expand Up @@ -159,11 +159,15 @@ var runCmd = &cobra.Command{
}
}

go proxy.NewWorkspaceProxy(cfg.Ingress, cfg.Proxy, proxy.HostBasedRouter(cfg.Ingress.Header, cfg.Proxy.GitpodInstallation.WorkspaceHostSuffix, cfg.Proxy.GitpodInstallation.WorkspaceHostSuffixRegex), infoprov, signers).MustServe()
log.Infof("started proxying on %s", cfg.Ingress.HTTPAddress)
ctrlCtx := ctrl.SetupSignalHandler()

go func() {
log.Infof("startint proxying on %s", cfg.Ingress.HTTPAddress)
proxy.NewWorkspaceProxy(cfg.Ingress, cfg.Proxy, proxy.HostBasedRouter(cfg.Ingress.Header, cfg.Proxy.GitpodInstallation.WorkspaceHostSuffix, cfg.Proxy.GitpodInstallation.WorkspaceHostSuffixRegex), infoprov, signers).MustServe(ctrlCtx)
}()

log.Info("🚪 ws-proxy is up and running")
if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
if err := mgr.Start(ctrlCtx); err != nil {
log.WithError(err).Fatal(err, "problem starting ws-proxy")
}

Expand Down
48 changes: 41 additions & 7 deletions components/ws-proxy/pkg/proxy/proxy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@ package proxy

import (
"bytes"
"context"
"crypto/tls"
"errors"
stdlog "log"
"net/http"
"os"
"path/filepath"
"time"

"github.com/gorilla/mux"
"github.com/klauspost/cpuid/v2"
Expand Down Expand Up @@ -49,13 +52,26 @@ func redirectToHTTPS(w http.ResponseWriter, r *http.Request) {
}

// MustServe starts the proxy and ends the process if doing so fails.
func (p *WorkspaceProxy) MustServe() {
func (p *WorkspaceProxy) MustServe(ctx context.Context) {
handler, err := p.Handler()
if err != nil {
log.WithError(err).Fatal("cannot initialize proxy - this is likely a configuration issue")
return
}
srv := &http.Server{

httpServer := &http.Server{
Addr: p.Ingress.HTTPAddress,
Handler: http.HandlerFunc(redirectToHTTPS),
ErrorLog: stdlog.New(logrusErrorWriter{}, "", 0),
ReadTimeout: 1 * time.Second,
WriteTimeout: 1 * time.Second,
IdleTimeout: 0,
ReadHeaderTimeout: 2 * time.Second,
}

httpServer.SetKeepAlivesEnabled(false)

httpsServer := &http.Server{
Addr: p.Ingress.HTTPSAddress,
Handler: handler,
TLSConfig: &tls.Config{
Expand All @@ -77,17 +93,35 @@ func (p *WorkspaceProxy) MustServe() {
crt = filepath.Join(tproot, crt)
key = filepath.Join(tproot, key)
}

go func() {
err := http.ListenAndServe(p.Ingress.HTTPAddress, http.HandlerFunc(redirectToHTTPS))
if err != nil {
err := httpServer.ListenAndServe()
if err != nil && !errors.Is(err, http.ErrServerClosed) {
log.WithError(err).Fatal("cannot start http proxy")
}
}()

err = srv.ListenAndServeTLS(crt, key)
go func() {
err = httpsServer.ListenAndServeTLS(crt, key)
if err != nil && !errors.Is(err, http.ErrServerClosed) {
log.WithError(err).Fatal("cannot start proxy")
return
}
}()

<-ctx.Done()

shutDownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()

err = httpServer.Shutdown(shutDownCtx)
if err != nil {
log.WithError(err).Fatal("cannot start proxy")
return
log.WithError(err).Fatal("cannot stop HTTP server")
}

err = httpsServer.Shutdown(shutDownCtx)
if err != nil {
log.WithError(err).Fatal("cannot stop HTTPS server")
}
}

Expand Down
1 change: 1 addition & 0 deletions install/installer/pkg/components/ws-proxy/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
SecurityContext: &corev1.PodSecurityContext{
RunAsUser: pointer.Int64(31002),
},
TerminationGracePeriodSeconds: pointer.Int64(360),
Volumes: append([]corev1.Volume{
{
Name: "config",
Expand Down