feat(docs): add docs for external workspaces #19437
Draft
+138
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matifali
requested changes
Aug 22, 2025
|
|
||
| ## Prerequisites | ||
|
|
||
| - Access to external compute resources (VMs, bare-metal servers, Kubernetes nodes, etc.) that can run the Coder agent. |
There was a problem hiding this comment.
Should we define what can run a coder agent, or just drop this?
Comment on lines
26
to
31
| ## Use cases | ||
|
|
||
| - Connecting an existing on-premises GPU server for ML development. | ||
| - Bringing a manually provisioned VM in a restricted network under Coder’s workspace management. | ||
| - Gradually migrating workloads to Coder without refactoring current infrastructure. | ||
| - Running agents in CI pipelines to provision short-lived, externally managed workspaces for testing or build automation. |
There was a problem hiding this comment.
Let's merge benefits and use cases into a single section. They are overlapping.
Comment on lines
+122
to
+129
| ### UI workflow | ||
|
|
||
| 1. Import the external workspace template (see prerequisites). | ||
| 2. In the Coder UI, go to **Workspaces → New workspace** and select the imported template. | ||
| 3. Once the workspace is created, Coder will display **connection details** with the command users need to run on the external machine to start the agent. | ||
| 4. The workspace will appear in the dashboard, but with the following differences: | ||
| - **Start**, **Stop**, and **Restart** actions are disabled. | ||
| - Users are provided with instructions for launching the agent manually on the external machine. |
There was a problem hiding this comment.
Can we drop a screenshot here?
Co-authored-by: Atif Ali <atif@coder.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces documentation for recently merged feature: external workspaces.
#19285
#19286
#19287
#19288