Skip to content

feat: Add documentation for workspace proxy creation #7377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
May 4, 2023
Merged

feat: Add documentation for workspace proxy creation #7377

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a875b56
feat: Add documentation for workspace proxy creation
Emyrk May 2, 2023
b4fa98f
Update diagram
Emyrk May 2, 2023
027110b
Update manifest
Emyrk May 2, 2023
be540aa
Add vm deployment and status codes
Emyrk May 2, 2023
953ed4f
Add some comments
Emyrk May 2, 2023
72d87f7
Add experimental disclaimer
Emyrk May 2, 2023
e863b30
Add settings note
Emyrk May 2, 2023
c641d63
Format
Emyrk May 2, 2023
2e863ae
Fix spelling mistakes
Emyrk May 3, 2023
273c6aa
Say to use experiment on proxy and coderd
Emyrk May 3, 2023
c700a73
Rename file, address comments
Emyrk May 3, 2023
64f5f06
Drop derp config values
Emyrk May 4, 2023
35151ba
Fmt manifest.json
Emyrk May 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Format
  • Loading branch information
@Emyrk
Emyrk committed May 2, 2023
commit c641d639970c46cca5cb39b3c89069b94e8b68e3
16 changes: 9 additions & 7 deletions docs/admin/workspaceproxies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,17 @@

Workspace Proxies are a feature to provide low latency experiences for geo-distributed teams.

Coder's networking does a best effort to make direct connections to a workspace. In situtions where this is not possible, such as [dashboard connections](../networking/README.md#dashboard-connections), workspace proxies are able to reduce the amount of distance the network traffic needs to travel.
Coder's networking does a best effort to make direct connections to a workspace. In situtions where this is not possible, such as [dashboard connections](../networking/README.md#dashboard-connections), workspace proxies are able to reduce the amount of distance the network traffic needs to travel.

A workspace proxy is a relay connection a developer can choose to use when connecting with their workspace over ssh, a workspace app, port forwarding, etc.

<!-- TODO: Might want to modify this diagram? -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I modified next.config.js in my coder.com codebase to allow other origins (e.g. imgur) to preview this temporarily. Not bad! I don't think we need to modify this, but will defer to you and Dean.

Screenshot 2023-05-03 at 1 49 39 PM

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙏

I figure someone can make a better graphic. I just wanted something since it's way easier to understand when illustrated.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this really helps convey how it works


![ProxyDiagram](../images/workspaceproxy/proxydiagram.png)

# Deploy a workspace proxy

Each workspace proxy should be a unique instance. At no point should 2 workspace proxy instances share the same authentication token.
Each workspace proxy should be a unique instance. At no point should 2 workspace proxy instances share the same authentication token.

Workspace proxies can be used in the browser by navigating to the user `Account -> Workspace Proxy`

Expand All @@ -35,7 +36,7 @@ To verify it was created.

```bash
$ coder proxy ls
NAME URL STATUS STATUS
NAME URL STATUS STATUS
newyork unregistered
```

Expand All @@ -45,13 +46,14 @@ Deploying the workspace proxy will also register the proxy with coderd and make

```
$ coder proxy lsPM
NAME URL STATUS STATUS
brazil-saopaulo https://brazil.example.com ok
europe-frankfurt https://europe.example.com ok
NAME URL STATUS STATUS
brazil-saopaulo https://brazil.example.com ok
europe-frankfurt https://europe.example.com ok
sydney https://sydney.example.com ok
```

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.
Expand All @@ -63,6 +65,7 @@ Other Status codes:
I am not sure the best way to present this.
Ideally in the future we can auto sync some of the settings with coderd.
-->

Workspace proxy configuration overlaps with a subset of the coderd configuration. To see the full list of configuration options: `coder proxy server --help`

```bash
Expand Down Expand Up @@ -97,4 +100,3 @@ coder proxy server
```

<!-- Additional run options? -->