chore: rename tunnel-host to wgtunnel-host

coder · deansheather · Mar 22, 2023 · Mar 7, 2023 · Mar 9, 2023 · Mar 9, 2023
commit c90142937e23ef5e573e498a78a16e1c3d7a5317
diff --git a/cli/server.go b/cli/server.go
@@ -547,7 +547,7 @@ flags, and YAML configuration. The precedence is as follows:
 			)
 			if cfg.AccessURL.String() == "" {
 				cmd.Printf("Opening tunnel so workspaces can connect to your deployment. For production scenarios, specify an external access URL\n")
-				tunnel, err = devtunnel.New(ctx, logger.Named("devtunnel"), cfg.TunnelHost.String())
+				tunnel, err = devtunnel.New(ctx, logger.Named("devtunnel"), cfg.WgtunnelHost.String())
 				if err != nil {
 					return xerrors.Errorf("create tunnel: %w", err)
 				}

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -161,7 +161,7 @@ type DeploymentValues struct {
 	Support                         SupportConfig                   `json:"support,omitempty" typescript:",notnull"`
 	GitAuthProviders                clibase.Struct[[]GitAuthConfig] `json:"git_auth,omitempty" typescript:",notnull"`
 	SSHConfig                       SSHConfig                       `json:"config_ssh,omitempty" typescript:",notnull"`
-	TunnelHost                      clibase.String                  `json:"tunnel_host,omitempty" typescript:",notnull"`
+	WgtunnelHost                    clibase.String                  `json:"wgtunnel_host,omitempty" typescript:",notnull"`
 
 	Config      clibase.String `js
8000
on:"config,omitempty" typescript:",notnull"`
 	WriteConfig clibase.Bool   `json:"write_config,omitempty" typescript:",notnull"`
@@ -1354,12 +1354,12 @@ Write out the current server configuration to the path specified by --config.`,
 			Hidden:      true,
 		},
 		{
-			Name:        "Custom Tunnel Host",
+			Name:        "Custom wgtunnel Host",
 			Description: `Hostname of HTTPS server that runs https://github.com/coder/wgtunnel. By default, this will pick the best available wgtunnel server hosted by Coder. e.g. "tunnel.example.com".`,
-			Flag:        "tunnel-host",
-			Env:         "TUNNEL_HOST",
-			YAML:        "tunnelHost",
-			Value:       &c.TunnelHost,
+			Flag:        "wg-tunnel-host",
+			Env:         "WGTUNNEL_HOST",
+			YAML:        "wgtunnelHost",
+			Value:       &c.WgtunnelHost,
 			Default:     "", // empty string means pick best server
 			Hidden:      true,
 		},

diff --git a/docs/api/general.md b/docs/api/general.md
@@ -338,9 +338,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
       "enable": true,
       "honeycomb_api_key": "string"
     },
-    "tunnel_host": "string",
     "update_check": true,
     "verbose": true,
+    "wgtunnel_host": "string",
     "wildcard_access_url": {
       "forceQuery": true,
       "fragment": "string",

diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -1870,9 +1870,9 @@ CreateParameterRequest is a structure used to create a new parameter value for a
       "enable": true,
       "honeycomb_api_key": "string"
     },
-    "tunnel_host": "string",
     "update_check": true,
     "verb
8000
ose": true,
+    "wgtunnel_host": "string",
     "wildcard_access_url": {
       "forceQuery": true,
       "fragment": "string",
@@ -2215,9 +2215,9 @@ CreateParameterRequest is a structure used to create a new parameter value for a
     "enable": true,
     "honeycomb_api_key": "string"
   },
-  "tunnel_host": "string",
   "update_check": true,
   "verbose": true,
+  "wgtunnel_host": "string",
   "wildcard_access_url": {
     "forceQuery": true,
     "fragment": "string",
@@ -2282,9 +2282,9 @@ CreateParameterRequest is a structure used to create a new parameter value for a
 | `telemetry`                          | [codersdk.TelemetryConfig](#codersdktelemetryconfig)                                       | false    |              |                                                                    |
 | `tls`                                | [codersdk.TLSConfig](#codersdktlsconfig)                                                   | false    |              |                                                                    |
 | `trace`                              | [codersdk.TraceConfig](#codersdktraceconfig)                                               | false    |              |                                                                    |
-| `tunnel_host`                        | string                                                                                     | false    |              |                                                                    |
 | `update_check`                       | boolean                                                                                    | false    |              |                                                                    |
 | `verbose`                            | boolean                                                                                    | false    |              |                                                                    |
+| `wgtunnel_host`                      | string                                                                                     | false    |              |                                                                    |
 | `wildcard_access_url`                | [clibase.URL](#clibaseurl)                                                                 | false    |              |                                                                    |
 | `write_config`                       | boolean                                                                                    | false    |              |                                                                    |
 

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -362,6 +362,7 @@ export interface DeploymentValues {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any -- External type
   readonly git_auth?: any
   readonly config_ssh?: SSHConfig
+  readonly wgtunnel_host?: string
   readonly config?: string
   readonly write_config?: boolean
   // Named type "github.com/coder/coder/cli/clibase.HostPort" unknown, using "any"