Renames

coder · Emyrk · Mar 16, 2023 · Mar 14, 2023 · Mar 15, 2023 · Mar 15, 2023
commit 952c591d9a51a4a8e36989553c9cc792476e24fa
diff --git a/cli/configssh_test.go b/cli/configssh_test.go
@@ -68,7 +68,7 @@ func TestConfigSSH(t *testing.T) {
 	const expectedKey = "ConnectionAttempts"
 	client := coderdtest.New(t, &coderdtest.Options{
 		IncludeProvisionerDaemon: true,
-		ConfigSSH: codersdk.CLISSHConfigResponse{
+		ConfigSSH: codersdk.SSHConfigResponse{
 			HostnamePrefix: "test-coder",
 			SSHConfigOptions: map[string]string{
 				// Something we can test for

diff --git a/cli/server.go b/cli/server.go
@@ -701,7 +701,7 @@ flags, and YAML configuration. The precedence is as follows:
 				LoginRateLimit:              loginRateLimit,
 				FilesRateLimit:              filesRateLimit,
 				HTTPClient:                  httpClient,
-				ConfigSSH: codersdk.CLISSHConfigResponse{
+				SSHConfig: codersdk.SSHConfigResponse{
 					HostnamePrefix:   cfg.CLISSH.DeploymentName.String(),
 					SSHConfigOptions: configSSHOptions,
 				},

diff --git a/coderd/clissh.go b/coderd/clissh.go
@@ -12,7 +12,7 @@ import (
 // @Produce json
 // @Tags General
 // @Success 200 {object} codersdk.CLISSHConfigResponse
-// @Router /config-ssh [get]
+// @Router /deployment/ssh [get]
 func (a *API) cliSSHConfig(rw http.ResponseWriter, r *http.Request) {
-	httpapi.Write(r.Context(), rw, http.StatusOK, a.ConfigSSH)
+	httpapi.Write(r.Context(), rw, http.StatusOK, a.SSHConfig)
 }
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -138,8 +138,8 @@ type Options struct {
 	DeploymentValues            *codersdk.DeploymentValues
 	UpdateCheckOptions          *updatecheck.Options // Set non-nil to enable update checking.
 
-	// ConfigSSH is the response clients use to configure config-ssh locally.
-	ConfigSSH codersdk.CLISSHConfigResponse
+	// SSHConfig is the response clients use to configure config-ssh locally.
+	SSHConfig codersdk.SSHConfigResponse
 
 	HTTPClient *http.Client
 }
@@ -213,8 +213,8 @@ func New(options *Options) *API {
 	if options.Auditor == nil {
 		options.Auditor = audit.NewNop()
 	}
-	if options.ConfigSSH.HostnamePrefix == "" {
-		options.ConfigSSH.HostnamePrefix = "coder."
+	if options.SSHConfig.HostnamePrefix == "" {
+		options.SSHConfig.HostnamePrefix = "coder."
 	}
 	// TODO: remove this once we promote authz_querier out of experiments.
 	if experiments.Enabled(codersdk.ExperimentAuthzQuerier) {
@@ -405,17 +405,11 @@ func New(options *Options) *API {
 		r.Post("/csp/reports", api.logReportCSPViolations)
 
 		r.Get("/buildinfo", buildInfo)
-		r.Route("/config-ssh", func(r chi.Router) {
-			// Require auth for this route to prevent leaking the SSH config.
-			// to non-authenticated users. Also some config settings might
-			// be dependent on the user.
-			r.Use(apiKeyMiddleware)
-			r.Get("/", api.cliSSHConfig)
-		})
 		r.Route("/deployment", func(r chi.Router) {
 			r.Use(apiKeyMiddleware)
 			r.Get("/config", api.deploymentValues)
 			r.Get("/stats", api.deploymentStats)
+			r.Get("/ssh", api.cliSSHConfig)
 		})
 		r.Route("/experiments", func(r chi.Router) {
 			r.Use(apiKeyMiddleware)

diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -126,7 +126,7 @@ type Options struct {
 	Database database.Store
 	Pubsub   database.Pubsub
 
-	ConfigSSH codersdk.CLISSHConfigResponse
+	ConfigSSH codersdk.SSHConfigResponse
 
 	SwaggerEndpoint bool
 }
@@ -335,7 +335,7 @@ func NewOptions(t *testing.T, options *Options) (func(http.Handler), context.Can
 			UpdateCheckOptions:          options.UpdateCheckOptions,
 			SwaggerEndpoint:             options.SwaggerEndpoint,
 			AppSigningKey:               AppSigningKey,
-			ConfigSSH:                   options.ConfigSSH,
+			SSHConfig:                   options.ConfigSSH,
 		}
 }
 

diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -1318,13 +1318,13 @@ when required by your organization's security policy.`,
 			Default:     "coder.",
 		},
 		{
-			Name: "CLI SSH Config Options",
-			Description: "These cli config options will override the default ssh config options. " +
+			Name: "SSH Config Options",
+			Description: "These ssh config options will override the default ssh config options. " +
 				"Provide options in key=value format separated by commas." +
 				"Using this incorrectly can break ssh to your deployment. Use cautiously.",
-			Flag:   "cli-ssh-options",
-			Env:    "CLI_SSH_OPTIONS",
-			YAML:   "cliSSHOptions",
+			Flag:   "ssh-config-options",
+			Env:    "SSH_CONFIG_OPTIONS",
+			YAML:   "sshConfigOptions",
 			Group:  &deploymentGroupClient,
 			Value:  &c.CLISSH.SSHConfigOptions,
 			Hidden: false,
@@ -1645,24 +1645,24 @@ type DeploymentStats struct {
 	SessionCount SessionCountDeploymentStats `json:"session_count"`
 }
 
-type CLISSHConfigResponse struct {
+type SSHConfigResponse struct {
 	HostnamePrefix   string            `json:"hostname_prefix"`
 	SSHConfigOptions map[string]string `json:"ssh_config_options"`
 }
 
 // SSHConfiguration returns information about the SSH configuration for the
 // Coder instance.
-func (c *Client) SSHConfiguration(ctx context.Context) (CLISSHConfigResponse, error) {
-	res, err := c.Request(ctx, http.MethodGet, "/api/v2/config-ssh", nil)
+func (c *Client) SSHConfiguration(ctx context.Context) (SSHConfigResponse, error) {
+	res, err := c.Request(ctx, http.MethodGet, "/api/v2/deployment/ssh", nil)
 	if err != nil {
-		return CLISSHConfigResponse{}, err
+		return SSHConfigResponse{}, err
 	}
 	defer res.Body.Close()
 
 	if res.StatusCode != http.StatusOK {
-		return CLISSHConfigResponse{}, ReadBodyAsError(res)
+		return SSHConfigResponse{}, ReadBodyAsError(res)
 	}
 
-	var cliConfig CLISSHConfigResponse
+	var cliConfig SSHConfigResponse
 	return cliConfig, json.NewDecoder(res.Body).Decode(&cliConfig)
 }