Skip to content

Commit d6f2a8c

Browse files
stirbymatifali
authored andcommitted
moved resource definition outside of user guides
1 parent dd73049 commit d6f2a8c

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

docs/admin/workspaces/lifecycle.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Workspaces are flexible, reproducible, and isolated units of compute. Workspaces
55

66
This page covers how workspaces move through this lifecycle. To learn about automating workspace schedules for cost control, read the [workspace scheduling docs](./schedule.md).
77

8-
## Resource persistence
8+
## Resources and persistence
99

10-
In Coder, your workspaces are composed of ephemeral and persistent resources. Persistent resources stay provisioned when the workspace is stopped, where as ephemeral resources are destroyed and recreated on restart. All resources are destroyed when a workspace is deleted.
10+
In Coder, your workspaces are composed of resources which may be _ephemeral_ or _persistent_. Persistent resources stay provisioned when the workspace is stopped, where as ephemeral resources are destroyed and recreated on restart. All resources are destroyed when a workspace is deleted.
1111

1212

1313
Ephemeral resources reduce the cost of stopped workspaces and ensure reproducibility of your environments.
@@ -37,23 +37,29 @@ By default, there is no limit on the number of workspaces a user may create, reg
3737

3838
When a user creates a workspace, they're sending a build request to the control plane. Coder takes this and uses [Terraform](https://www.terraform.io/) to provision a workspace defined by your [template](../templates/README.md). Generally, templates define the resources and environment of a workspace.
3939

40-
Once the workspace is provisioned, the agent process starts and opens connections to your workspace via SSH, the terminal, and IDES like [JetBrains](../../user-guides/workspace-access/jetbrains.md) or [VSCode](../../user-guides/workspace-access/vscode.md).
4140

42-
The agent is responsible for running your workspace startup scripts. These may configure tools, service connections, or personalization like [dotfiles](../../user-guides/workspace-dotfiles.md).
41+
The resources that run the agent are described as _computational resources_,
42+
while those that don't are called _peripheral resources_. A workspace must contain some computational resource to run the Coder agent process.
43+
44+
The provisioned workspace's computational resources start the agent process, which opens connections to your workspace via SSH, the terminal, and IDES like [JetBrains](../../user-guides/workspace-access/jetbrains.md) or [VSCode](../../user-guides/workspace-access/vscode.md).
45+
46+
Once started, the Coder agent is responsible for running your workspace startup scripts. These may configure tools, service connections, or personalization like [dotfiles](../../user-guides/workspace-dotfiles.md).
47+
48+
49+
50+
Once these steps have completed, your workspace will now be in the `Running` state. You can access it via any of the [supported methods](../../user-guides/workspace-access/README.md), stop it when you're away, or delete it once it's no longer in use.
4351

4452
## Stopping workspaces
4553

4654
Workspaces may be stopped manually by users and admins in the dashboard, CLI, or API. Workspaces may be automatically stopped by scheduling configuration to reduce the uptime of costly resources.
4755

4856

4957

50-
## Workspace deletion
51-
58+
## Deleting workspaces
5259

53-
## Ephemeral workspaces
5460

61+
## Unhealthy and Failed workspaces
5562

56-
### Dormant workspaces
5763

5864

5965

docs/user-guides/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@ At the highest level, a workspace is a set of cloud resources. These resources
66
can be VMs, Kubernetes clusters, storage buckets, or whatever else [Terraform](https://developer.hashicorp.com/terraform/docs)
77
lets you dream up.
88

9-
The resources that run the agent are described as _computational resources_,
10-
while those that don't are called _peripheral resources_.
119

12-
Each resource may also be _persistent_ or _ephemeral_ depending on whether
13-
they're destroyed on workspace stop.
1410

1511
Coder Workspaces are managed by the workspace agent, which facilitates [connections](./workspace-access.md).
1612

0 commit comments

Comments
 (0)