-
Notifications
You must be signed in to change notification settings - Fork 1k
feat(docs): add docs for external workspaces #19437
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.
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
Conversation
|
||
## 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.
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?
## 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.
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.
Co-authored-by: Atif Ali <atif@coder.com>
There was a problem hiding this 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.
There was a problem hiding this 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.
docs/manifest.json
Outdated
@@ -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", |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
Description
This PR introduces documentation for recently merged feature: external workspaces.
#19285
#19286
#19287
#19288