Skip to content

Conversation

kacpersaw
Copy link
Contributor

Description

This PR introduces documentation for recently merged feature: external workspaces.

#19285
#19286
#19287
#19288


## Prerequisites

- Access to external compute resources (VMs, bare-metal servers, Kubernetes nodes, etc.) that can run the Coder agent.
Copy link
Member

Choose a reason for hiding this comment

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

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.
Copy link
Member

Choose a reason for hiding this comment

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

Let's merge benefits and use cases into a single section. They are overlapping.

kacpersaw and others added 2 commits August 22, 2025 08:23
@kacpersaw kacpersaw requested a review from matifali August 22, 2025 07:50
@matifali matifali requested review from bpmct and Copilot August 23, 2025 06:41
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@kacpersaw kacpersaw marked this pull request as ready for review August 26, 2025 07:12
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

Looks good to me. Let's add Tabs to the split UI and CLI usage, and we can merge.

@@ -519,6 +519,12 @@
"title": "Workspace Scheduling",
"description": "Learn how to control how workspaces are started and stopped",
"path": "./admin/templates/managing-templates/schedule.md"
},
{
"title": "Early Access External Workspaces",
Copy link
Member

Choose a reason for hiding this comment

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

We don't need to put "early access" in the title if we have it as state

Copy link
Member

Choose a reason for hiding this comment

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

Good catch. I was getting confused where it is coming from.

@matifali matifali added the cherry-pick/v2.26 Needs to be cherry-picked to the 2.26 release branch label Aug 27, 2025
@kacpersaw kacpersaw merged commit 33509f2 into main Aug 28, 2025
33 checks passed
@kacpersaw kacpersaw deleted the kacpersaw/external-workspaces-docs branch August 28, 2025 08:12
@github-actions github-actions bot locked and limited conversation to collaborators Aug 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cherry-pick/v2.26 Needs to be cherry-picked to the 2.26 release branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants