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

Show file tree
Hide file tree
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
Rename file, address comments
  • Loading branch information
@Emyrk
Emyrk committed May 3, 2023
commit c700a7324e400bd7f9c80475f33e8c1746b2d4f0
4 changes: 2 additions & 2 deletions docs/admin/workspaceproxies.md → docs/admin/workspace-proxies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Workspace proxies are in an [experimental state](../contributing/feature-stages.md#experimental-features) and the behavior is subject to change. Use [GitHub issues](https://github.com/coder/coder) to leave feedback. This experiment must be specifically enabled with the `--experiments="moons"` option on both coderd and the workspace proxy.

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

Coder's networking does a best effort to make direct connections to a workspace. In situations 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.

Expand All @@ -14,7 +14,7 @@ A workspace proxy is a relay connection a developer can choose to use when conne

# 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. They only require port 443 to be open and are expected to have network connectivity to the coderd dashboard. Workspace proxies **do not** make any database connections.

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

Expand Down
6 changes: 4 additions & 2 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"versions": ["main"],
"versions": [
"main"
],
"routes": [
{
"title": "About",
Expand Down Expand Up @@ -310,7 +312,7 @@
{
"title": "External Workspace Proxies",
"description": "Run geo distributed workspace proxies",
"path": "./admin/workspaceproxies.md",
"path": "./admin/workspace-proxies.md",
"icon_path": "./images/icons/networking.svg",
"state": "enterprise"
},
Expand Down