[supervisor] make it compatible with run-gp

Co-authored-by: Victor Nogueira <[email protected]>
Co-authored-by: Andrea Falzetti <[email protected]>

Author: 3 people

components/gitpod-cli/cmd/tasks-attach.go

@@ -30,7 +30,9 @@ var attachTaskCmd = &cobra.Command{
 	Short: "Attach to a workspace task",
 	Args:  cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		client, err := supervisor.New(context.Background())
+		client, err := supervisor.New(context.Background(), &supervisor.SupervisorClientOption{
+			Address: os.Getenv("SUPERVISOR_DEBUG_ADDR"),
+		})
 		if err != nil {
 			log.Fatal(err)
 		}

components/gitpod-cli/cmd/tasks-list.go

@@ -27,7 +27,9 @@ var listTasksCmd = &cobra.Command{
 		ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 		defer cancel()
 
-		client, err := supervisor.New(ctx)
+		client, err := supervisor.New(ctx, &supervisor.SupervisorClientOption{
+			Address: os.Getenv("SUPERVISOR_DEBUG_ADDR"),
+		})
 		if err != nil {
 			log.Fatalf("cannot get task list: %s", err)
 		}

components/gitpod-cli/cmd/tasks-stop.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"fmt"
 	"log"
+	"os"
 	"time"
 
 	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/supervisor"
@@ -32,7 +33,9 @@ var stopTaskCmd = &cobra.Command{
 			cancel          context.CancelFunc
 		)
 
-		client, err := supervisor.New(context.Background())
+		client, err := supervisor.New(context.Background(), &supervisor.SupervisorClientOption{
+			Address: os.Getenv("SUPERVISOR_DEBUG_ADDR"),
+		})
 		if err != nil {
 			log.Fatalf("annot get task list: %s", err)
 		}

components/gitpod-cli/pkg/supervisor/client.go

@@ -30,7 +30,7 @@ type SupervisorClientOption struct {
 	Address string
 }
 
-func New(ctx context.Context, options ...SupervisorClientOption) (*SupervisorClient, error) {
+func New(ctx context.Context, options ...*SupervisorClientOption) (*SupervisorClient, error) {
 	address := util.GetSupervisorAddress()
 	for _, option := range options {
 		if option.Address != "" {

components/supervisor/.gitignore

@@ -0,0 +1 @@
+supervisor

components/supervisor/cmd/run.go

@@ -23,7 +23,7 @@ var runCmd = &cobra.Command{
 	Short: "starts the supervisor",
 
 	Run: func(cmd *cobra.Command, args []string) {
-		log.Init(ServiceName, Version, true, os.Getenv("SUPERVISOR_DEBUG_ENABLE") == "true")
+		log.Init(ServiceName, Version, !runOpts.RunGP, os.Getenv("SUPERVISOR_DEBUG_ENABLE") == "true")
 		common_grpc.SetupLogging()
 		supervisor.Version = Version
 		supervisor.Run(supervisor.WithRunGP(runOpts.RunGP))

components/supervisor/hot-swap.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+# Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+# Licensed under the GNU Affero General Public License (AGPL).
+# See License.AGPL.txt in the project root for license information.
+
+set -Eeuo pipefail
+
+# This script swaps the backend startup endpoint with a built one
+# in a workspace and restarts the JB backend.
+
+component=${PWD##*/}
+workspaceUrl=$(echo "${1}" |sed -e "s/\/$//")
+echo "URL: $workspaceUrl"
+
+workspaceDesc=$(gpctl workspaces describe "$workspaceUrl" -o=json)
+
+podName=$(echo "$workspaceDesc" | jq .runtime.pod_name -r)
+echo "Pod: $podName"
+
+workspaceId=$(echo "$workspaceDesc" | jq .metadata.meta_id -r)
+echo "ID: $workspaceId"
+
+clusterHost=$(kubectl exec -it "$podName" -- printenv GITPOD_WORKSPACE_CLUSTER_HOST |sed -e "s/\s//g")
+echo "Cluster Host: $clusterHost"
+
+# prepare ssh
+ownerToken=$(kubectl get pod "$podName" -o=json | jq ".metadata.annotations.\"gitpod\/ownerToken\"" -r)
+sshConfig="./ssh-config"
+echo "Host $workspaceId" > "$sshConfig"
+echo "    Hostname \"$workspaceId.ssh.$clusterHost\"" >> "$sshConfig"
+echo "    User \"$workspaceId#$ownerToken\"" >> "$sshConfig"
+
+# build
+go build .
+echo "$component built"
+
+# upload
+uploadDest="/.supervisor/$component"
+echo "Upload Dest: $uploadDest"
+ssh -F "$sshConfig" "$workspaceId" "sudo chmod 777 $uploadDest && sudo rm $uploadDest"
+scp -F "$sshConfig" -r "./supervisor" "$workspaceId":"$uploadDest"
+echo "Swap complete"

components/supervisor/local-hot-swap.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+# Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+# Licensed under the GNU Affero General Public License (AGPL).
+# See License.AGPL.txt in the project root for license information.
+
+set -Eeuo pipefail
+
+# This script swaps the backend startup endpoint with a built one
+# in a workspace and restarts the JB backend.
+
+component=${PWD##*/}
+
+# build
+go build .
+echo "$component built"
+
+sudo rm /.supervisor/supervisor
+sudo mv ./"$component" /.supervisor
+echo "Local Swap complete"

components/supervisor/pkg/supervisor/config.go

@@ -83,6 +83,9 @@ type StaticConfig struct {
 	// APIEndpointPort is the port where to serve the API endpoint on
 	APIEndpointPort int `json:"apiEndpointPort"`
 
+	// HostAPIEndpointPort is the port where to the host API endpoint served
+	HostAPIEndpointPort *int `json:"hostAPIEndpointPort,omitempty"`
+
 	// SSHPort is the port we run the SSH server on
 	SSHPort int `json:"sshPort"`
 }

components/supervisor/pkg/supervisor/supervisor.go

@@ -181,7 +181,7 @@ func Run(options ...RunOption) {
 
 	// BEWARE: we can only call buildChildProcEnv once, because it might download env vars from a one-time-secret
 	//         URL, which would fail if we tried another time.
-	childProcEnvvars := buildChildProcEnv(cfg, nil)
+	childProcEnvvars := buildChildProcEnv(cfg, nil, opts.RunGP)
 
 	err = AddGitpodUserIfNotExists()
 	if err != nil {
@@ -191,15 +191,18 @@ func Run(options ...RunOption) {
 	configureGit(cfg, childProcEnvvars)
 
 	tokenService := NewInMemoryTokenService()
-	tkns, err := cfg.GetTokens(true)
-	if err != nil {
-		log.WithError(err).Warn("cannot prepare tokens")
-	}
-	for i := range tkns {
-		_, err = tokenService.SetToken(context.Background(), &tkns[i].SetTokenRequest)
+
+	if !opts.RunGP {
+		tkns, err := cfg.GetTokens(true)
 		if err != nil {
 			log.WithError(err).Warn("cannot prepare tokens")
 		}
+		for i := range tkns {
+			_, err = tokenService.SetToken(context.Background(), &tkns[i].SetTokenRequest)
+			if err != nil {
+				log.WithError(err).Warn("cannot prepare tokens")
+			}
+		}
 	}
 
 	tunneledPortsService := ports.NewTunneledPortsService(cfg.DebugEnable)
@@ -238,29 +241,41 @@ func Run(options ...RunOption) {
 		desktopIdeReady *ideReadyState = nil
 
 		cstate        = NewInMemoryContentState(cfg.RepoRoot)
+		gitpodService serverapi.APIInterface
+
+		notificationService = NewNotificationService()
+	)
+
+	if !opts.RunGP {
 		gitpodService = serverapi.NewServerApiService(ctx, &serverapi.ServiceConfig{
 			Host:              host,
 			Endpoint:          endpoint,
 			InstanceID:        cfg.WorkspaceInstanceID,
 			WorkspaceID:       cfg.WorkspaceID,
 			SupervisorVersion: Version,
 		}, tokenService)
+	}
 
-		notificationService = NewNotificationService()
-	)
 	if cfg.DesktopIDE != nil {
 		desktopIdeReady = &ideReadyState{cond: sync.NewCond(&sync.Mutex{})}
 	}
-	if !cfg.isHeadless() {
+	if !cfg.isHeadless() && !opts.RunGP {
 		go trackReadiness(ctx, gitpodService, cfg, cstate, ideReady, desktopIdeReady)
 	}
 	tokenService.provider[KindGit] = []tokenProvider{NewGitTokenProvider(gitpodService, cfg.WorkspaceConfig, notificationService)}
 
 	gitpodConfigService := config.NewConfigService(cfg.RepoRoot+"/.gitpod.yml", cstate.ContentReady(), log.Log)
 	go gitpodConfigService.Watch(ctx)
 
+	var exposedPorts ports.ExposedPortsInterface
+
+	if !opts.RunGP {
+		exposedPorts = createExposedPortsImpl(cfg, gitpodService)
+	}
+
+	// createExposedPortsImpl(cfg, gitpodService)
 	portMgmt := ports.NewManager(
-		createExposedPortsImpl(cfg, gitpodService),
+		exposedPorts,
 		&ports.PollingServedPortsObserver{
 			RefreshInterval: 2 * time.Second,
 		},
@@ -270,13 +285,14 @@ func Run(options ...RunOption) {
 	)
 
 	topService := NewTopService()
-	topService.Observe(ctx)
 
 	supervisorMetrics := metrics.NewMetrics()
 	var metricsReporter *metrics.GrpcMetricsReporter
 	if opts.RunGP {
 		cstate.MarkContentReady(csapi.WorkspaceInitFromOther)
 	} else {
+		topService.Observe(ctx)
+
 		if !cfg.isHeadless() {
 			go startAnalyze(ctx, cfg, gitpodConfigService, topService, gitpodService)
 		}
@@ -355,17 +371,28 @@ func Run(options ...RunOption) {
 		wg       sync.WaitGroup
 		shutdown = make(chan ShutdownReason, 1)
 	)
-	wg.Add(1)
-	go startContentInit(ctx, cfg, &wg, cstate, supervisorMetrics)
+
+	if !opts.RunGP {
+		wg.Add(1)
+		go startContentInit(ctx, cfg, &wg, cstate, supervisorMetrics)
+	}
+
 	wg.Add(1)
 	go startAPIEndpoint(ctx, cfg, &wg, apiServices, tunneledPortsService, metricsReporter, apiEndpointOpts...)
-	wg.Add(1)
-	go startSSHServer(ctx, cfg, &wg, childProcEnvvars)
+
+	if !opts.RunGP {
+		wg.Add(1)
+		go startSSHServer(ctx, cfg, &wg, childProcEnvvars)
+	}
+
 	wg.Add(1)
 	tasksSuccessChan := make(chan taskSuccess, 1)
 	go taskManager.Run(ctx, &wg, tasksSuccessChan)
-	wg.Add(1)
-	go socketActivationForDocker(ctx, &wg, termMux)
+
+	if !opts.RunGP {
+		wg.Add(1)
+		go socketActivationForDocker(ctx, &wg, termMux)
+	}
 
 	if cfg.isHeadless() {
 		wg.Add(1)
@@ -899,7 +926,7 @@ func prepareIDELaunch(cfg *Config, ideConfig *IDEConfig, childProcEnvvars []stri
 // of envvars. If envvars is nil, os.Environ() is used.
 //
 // Beware: if config contains an OTS URL the results may differ on subsequent calls.
-func buildChildProcEnv(cfg *Config, envvars []string) []string {
+func buildChildProcEnv(cfg *Config, envvars []string, runGP bool) []string {
 	if envvars == nil {
 		envvars = os.Environ()
 	}
@@ -919,7 +946,13 @@ func buildChildProcEnv(cfg *Config, envvars []string) []string {
 
 		envs[nme] = val
 	}
-	envs["SUPERVISOR_ADDR"] = fmt.Sprintf("localhost:%d", cfg.APIEndpointPort)
+
+	if runGP {
+		envs["SUPERVISOR_ADDR"] = fmt.Sprintf("localhost:%d", cfg.HostAPIEndpointPort)
+		envs["SUPERVISOR_DEBUG_ADDR"] = fmt.Sprintf("localhost:%d", cfg.APIEndpointPort)
+	} else {
+		envs["SUPERVISOR_ADDR"] = fmt.Sprintf("localhost:%d", cfg.APIEndpointPort)
+	}
 
 	if cfg.EnvvarOTS != "" {
 		es, err := downloadEnvvarOTS(cfg.EnvvarOTS)

components/supervisor/pkg/supervisor/supervisor_test.go

@@ -122,7 +122,7 @@ func TestBuildChildProcEnv(t *testing.T) {
 				cfg.EnvvarOTS = srv.URL
 			}
 
-			act := buildChildProcEnv(cfg, test.Input)
+			act := buildChildProcEnv(cfg, test.Input, false)
 			assert(t, act)
 		})
 	}