mirror of
https://github.com/gitpod-io/gitpod.git
synced 2025-12-08 17:36:30 +00:00
c4e2c43ab1
* cli: SSH / Opening improvements * Fix args in config setting * Log opening with URLs * Changelog * Fix changlog
88 lines
2.6 KiB
Go
88 lines
2.6 KiB
Go
// Copyright (c) 2023 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.
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"log/slog"
|
|
"time"
|
|
|
|
"github.com/bufbuild/connect-go"
|
|
v1 "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1"
|
|
"github.com/gitpod-io/local-app/pkg/helper"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var workspaceSSHOpts struct {
|
|
DryRun bool
|
|
NoImplicitStart bool
|
|
}
|
|
|
|
// workspaceSSHCmd connects to a given workspace
|
|
var workspaceSSHCmd = &cobra.Command{
|
|
Use: "ssh <workspace-id>",
|
|
Short: "Connects to a workspace via SSH",
|
|
Args: cobra.MinimumNArgs(1),
|
|
Example: ` # connect to workspace with current terminal session
|
|
$ gitpod workspace ssh <workspace-id>
|
|
|
|
# Execute a command through SSH
|
|
$ gitpod workspace ssh <workspace-id> -- ls -la
|
|
$ gitpod ws ssh <workspace-id> -- -t watch date
|
|
|
|
# Get all SSH features with --dry-run
|
|
$ $(gitpod workspace ssh <workspace-id> --dry-run) -- ls -la
|
|
$ $(gitpod workspace ssh <workspace-id> --dry-run) -t watch date`,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
cmd.SilenceUsage = true
|
|
|
|
ctx, cancel := context.WithTimeout(cmd.Context(), 5*time.Minute)
|
|
defer cancel()
|
|
|
|
workspaceID := args[0]
|
|
|
|
gitpod, err := getGitpodClient(cmd.Context())
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
ws, err := gitpod.Workspaces.GetWorkspace(ctx, connect.NewRequest(&v1.GetWorkspaceRequest{WorkspaceId: workspaceID}))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if ws.Msg.Result.Status.Instance.Status.Phase != v1.WorkspaceInstanceStatus_PHASE_RUNNING {
|
|
if workspaceSSHOpts.NoImplicitStart {
|
|
return fmt.Errorf("workspace is not running")
|
|
}
|
|
slog.Info("workspace is not running, starting it...")
|
|
_, err := gitpod.Workspaces.StartWorkspace(ctx, connect.NewRequest(&v1.StartWorkspaceRequest{WorkspaceId: workspaceID}))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
_, err = helper.ObserveWorkspaceUntilStarted(ctx, gitpod, workspaceID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
dashDashIndex := cmd.ArgsLenAtDash()
|
|
|
|
sshArgs := []string{}
|
|
if dashDashIndex != -1 {
|
|
sshArgs = args[dashDashIndex:]
|
|
}
|
|
|
|
return helper.SSHConnectToWorkspace(cmd.Context(), gitpod, workspaceID, workspaceSSHOpts.DryRun, sshArgs...)
|
|
},
|
|
}
|
|
|
|
func init() {
|
|
workspaceCmd.AddCommand(workspaceSSHCmd)
|
|
workspaceSSHCmd.Flags().BoolVarP(&workspaceSSHOpts.DryRun, "dry-run", "n", false, "Dry run the command")
|
|
workspaceSSHCmd.Flags().BoolVarP(&workspaceSSHOpts.NoImplicitStart, "no-implicit-start", "", false, "Do not start the workspace if it is not running")
|
|
}
|