From 503e94a5c2996dfec61d72c54612ff843566ea65 Mon Sep 17 00:00:00 2001 From: Eric Paulsen Date: Mon, 8 May 2023 19:22:35 -0400 Subject: [PATCH] docs: fix proxy cmd ref (#7460) --- docs/admin/workspace-proxies.md | 14 +++++++------- helm/values.yaml | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/admin/workspace-proxies.md b/docs/admin/workspace-proxies.md index 527378cf4f..d04e868ac9 100644 --- a/docs/admin/workspace-proxies.md +++ b/docs/admin/workspace-proxies.md @@ -25,7 +25,7 @@ Workspace proxies can be used in the browser by navigating to the user `Account Create the workspace proxy and make sure to save the returned authentication token for said proxy. This is the token the workspace proxy will use to authenticate back to primary coderd. ```bash -$ coder proxy create --name=newyork --display-name="USA East" --icon="/emojis/2194.png" +$ coder wsproxy create --name=newyork --display-name="USA East" --icon="/emojis/2194.png" Workspace Proxy "newyork" created successfully. Save this token, it will not be shown again. Token: 2fb6500b-bb47-4783-a0db-dedde895b865:05271b4ef9432bac14c02b3c56b5a2d7f05453718a1f85ba7e772c0a096c7175 ``` @@ -33,17 +33,17 @@ Token: 2fb6500b-bb47-4783-a0db-dedde895b865:05271b4ef9432bac14c02b3c56b5a2d7f054 To verify it was created. ```bash -$ coder proxy ls +$ coder wsproxy ls NAME URL STATUS STATUS newyork unregistered ``` ## Step 2: Deploy the proxy -Deploying the workspace proxy will also register the proxy with coderd and make the workspace proxy usable. If the proxy deployment is successful, `coder proxy ls` will show an `ok` status code: +Deploying the workspace proxy will also register the proxy with coderd and make the workspace proxy usable. If the proxy deployment is successful, `coder wsproxy ls` will show an `ok` status code: ``` -$ coder proxy ls +$ coder wsproxy ls NAME URL STATUS STATUS brazil-saopaulo https://brazil.example.com ok europe-frankfurt https://europe.example.com ok @@ -54,12 +54,12 @@ Other Status codes: - `unregistered` : The workspace proxy was created, and not yet deployed - `unreachable` : The workspace proxy was registered, but is not responding. Likely the proxy went offline. -- `unhealthy` : The workspace proxy is reachable, but has some issue that is preventing the proxy from being used. `coder proxy ls` should show the error message. +- `unhealthy` : The workspace proxy is reachable, but has some issue that is preventing the proxy from being used. `coder wsproxy ls` should show the error message. - `ok` : The workspace proxy is healthy and working properly! ### Configuration -Workspace proxy configuration overlaps with a subset of the coderd configuration. To see the full list of configuration options: `coder proxy server --help` +Workspace proxy configuration overlaps with a subset of the coderd configuration. To see the full list of configuration options: `coder wsproxy server --help` ```bash # Proxy specific configuration. These are REQUIRED @@ -87,7 +87,7 @@ CODER_TLS_KEY_FILE="" ```bash # Set configuration options via environment variables, a config file, or cmd flags -coder proxy server +coder wsproxy server ``` ### Selecting a proxy diff --git a/helm/values.yaml b/helm/values.yaml index 7c39ba9318..191d7955a7 100644 --- a/helm/values.yaml +++ b/helm/values.yaml @@ -14,7 +14,7 @@ coder: # # Make sure you set CODER_PRIMARY_ACCESS_URL and CODER_PROXY_SESSION_TOKEN in # the environment below. You can get a proxy token using the CLI: - # coder proxy create \ + # coder wsproxy create \ # --name "proxy-name" \ # --display-name "Proxy Name" \ # --icon "/emojis/xyz.png"