Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Commit 5aaaaec

Browse files
author
Katie Horne
authored
chore: update orgs docs (#620)
1 parent fbaafd0 commit 5aaaaec

File tree

8 files changed

+163
-122
lines changed

8 files changed

+163
-122
lines changed

admin/organizations.md

Lines changed: 0 additions & 92 deletions
This file was deleted.

admin/organizations/index.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Organizations
3+
description: Learn about Coder organizations.
4+
---
5+
6+
Organizations are groups that tie together users, workspaces, and images. You
7+
must assign all of your images and workspaces to a specific organization. An
8+
end-user can only access images that are assigned to the same organization they
9+
are.
10+
11+
> Be sure to familiarize yourself with the
12+
> [types of roles](../access-control/organizations.md) you can assign users
13+
> within an organization.
14+
15+
## The default organization
16+
17+
Coder automatically creates a default organization for you during the deployment
18+
process. You can then assign users and their workspaces to that organization.
19+
20+
If you have multiple organizations, you can set one or more as the default; you
21+
can also change which organizations are defaults at any time.
22+
23+
## Namespaces
24+
25+
> **Deprecation notice**: The `namespaceWhitelist` field has been deprecated in
26+
> [Coder version 1.17](../../changelog/1.17.0.md).
27+
28+
Coder's Helm chart previously included a `namespaceWhitelist` field that
29+
accepted a list of cluster namespaces and made them available to Coder. The
30+
[workspace provider feature](../workspace-providers/index.md) supersedes this
31+
field.
32+
33+
You will not be able to make any changes _unless_ you are removing namespaces
34+
that no longer contain workspaces with Coder deployments v1.17.0 or later (if
35+
you remove namespaces from the `namespaceWhitelist` field, the workspaces in the
36+
namespaces are no longer accessible).
37+
38+
For older Coder deployments, you can continue using existing workspaces in
39+
whitelisted namespaces, though you cannot create new workspaces in those
40+
namespaces.
41+
42+
If you want to separate Coder workspaces by namespaces in a Kubernetes cluster,
43+
you can do so by
44+
[deploying a new workspace provider](../workspace-providers/deployment.md) to
45+
each additional namespace in the cluster. The workspace provider provisions
46+
workspaces to the namespace it has been deployed to, and you can control access
47+
to each workspace provider via an organization allowlist to replace the previous
48+
organization namespace behaviors.

admin/organizations/manage.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: Org management
3+
description: Learn about managing organizations.
4+
---
5+
6+
This article shows how you can create, view, edit, or delete an organization.
7+
8+
## Create a new organization
9+
10+
[Site admins and site managers](../access-control/user-roles.md) can create new
11+
organizations by going to **Manage** > **Organizations** > **New Organization**.
12+
13+
![Create a new organization dialog](../../assets/admin/create-an-org.png)
14+
15+
Provide a **name** and (optionally) a **description** for this organization. If
16+
you want this to become a **Default organization**, make sure to check the box
17+
for this.
18+
19+
You can also control how Coder manages resources for workspaces in this
20+
organization. You can set the:
21+
22+
- **CPU Provisioning Rate**: sets the ratio of virtual CPUs to physical CPUs; if
23+
you set a higher ratio, you can schedule a larger number of workspaces per
24+
node, though it will also lead to greater CPU contention
25+
- **Workspace Shutdown Behavior**: The number of hours a workspace may be idle
26+
before Coder stops it automatically to help free up resources
27+
28+
Finally, you can set **Resource Quotas**. These are limits on the number of
29+
**CPUs** and **GPUs**, as well as the amount of **memory** and **disk space**,
30+
each developer can request concurrently for running workspaces in this
31+
organization. The limits for what you can set are as follows:
32+
33+
- **CPUs**: 128 CPU cores
34+
- **Memory**: 256 GBs
35+
- **Disk**: 8192 GB
36+
- **GPUs**: 20 GPUs
37+
38+
When you've set your parameters, click **Create** to proceed.
39+
40+
## Viewing an organization
41+
42+
You can view information about an organization at any time by going to
43+
**Manage** > **Organizations** and selecting the org of interest.
44+
45+
The **Members** tab displays users that belong to the org. The **Workspaces**
46+
tab displays the workspaces that belong to the org, as well as the resources
47+
they consume.
48+
49+
![Org resources](../../assets/admin/org-resources.png)
50+
51+
## Editing an organization
52+
53+
You can edit an organization at any time by going to **Manage** >
54+
**Organizations**.
55+
56+
![Edit an organization dialog](../../assets/admin/edit-an-org.png)
57+
58+
Find the organization you want to edit, and click to open. In the top-right,
59+
click **Edit** to launch the **Edit Organizations** dialog.
60+
61+
When you're finished making your changes, click **Update** to save.
62+
63+
## Deleting an organization
64+
65+
You can edit an organization at any time by going to **Manage** >
66+
**Organizations**. Find the organization that you want to delete, and click to
67+
open. In the top right, click **Delete**. Confirm that you would like to delete
68+
the org.
69+
70+
> Deleting an organization does not delete users or workspaces. Coder reassigns
71+
> existing users and workspaces to a default org.

assets/admin/org-resources.png

97.3 KB
Loading

getting-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ the application (you can get a trial license for free
3434
[here](https://coder.com/trial)). Once logged in, you’ll be able to access the
3535
[administration management](./admin/index.md) menu to set up things such as
3636
[access controls](./admin/access-control/index.md) with OpenID Connect (OIDC),
37-
[create organizations](./admin/organizations.md), and create an OAuth app for
38-
your users to [connect to your Git provider](./admin/git.md).
37+
[create organizations](./admin/organizations/index.md), and create an OAuth app
38+
for your users to [connect to your Git provider](./admin/git.md).
3939

4040
At a minimum, you’ll want to ensure you
4141
[add a container registry](./admin/registries/index.md) for your development
@@ -52,8 +52,8 @@ Connect (OIDC) with [Azure AD](./guides/admin/oidc-azuread.md) or
5252
[Okta](./guides/admin/oidc-okta.md). If you are using another Identity Provider
5353
(IdP), the process should be very similar. With OIDC configured, Coder will
5454
automatically create a user and add them to the
55-
[default organization](./admin/organizations.md) when a developer logs in for
56-
the first time.
55+
[default organization](./admin/organizations/index.md) when a developer logs in
56+
for the first time.
5757

5858
## Automate
5959

manifest.json

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,36 @@
190190
}
191191
]
192192
},
193+
{
194+
"path": "./admin/organizations/index.md",
195+
"children": [
196+
{
197+
"path": "./admin/organizations/manage.md"
198+
}
199+
]
200+
},
201+
{
202+
"path": "./admin/registries/index.md",
203+
"children": [
204+
{
205+
"path": "./admin/registries/default-registry.md"
206+
},
207+
{
208+
"path": "./admin/registries/gcr.md"
209+
}
210+
]
211+
},
212+
{
213+
"path": "./admin/satellites/index.md",
214+
"children": [
215+
{
216+
"path": "./admin/satellites/management.md"
217+
},
218+
{
219+
"path": "./admin/satellites/migration.md"
220+
}
221+
]
222+
},
193223
{
194224
"path": "./admin/workspace-management/index.md",
195225
"children": [
@@ -219,28 +249,6 @@
219249
}
220250
]
221251
},
222-
{
223-
"path": "./admin/registries/index.md",
224-
"children": [
225-
{
226-
"path": "./admin/registries/default-registry.md"
227-
},
228-
{
229-
"path": "./admin/registries/gcr.md"
230-
}
231-
]
232-
},
233-
{
234-
"path": "./admin/satellites/index.md",
235-
"children": [
236-
{
237-
"path": "./admin/satellites/management.md"
238-
},
239-
{
240-
"path": "./admin/satellites/migration.md"
241-
}
242-
]
243-
},
244252
{
245253
"path": "./admin/workspace-providers/index.md",
246254
"children": [
@@ -273,9 +281,6 @@
273281
{
274282
"path": "./admin/git.md"
275283
},
276-
{
277-
"path": "./admin/organizations.md"
278-
},
279284
{
280285
"path": "./admin/stun.md"
281286
},

setup/installation.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@ Install the following dependencies if you haven't already:
1717
[PostgreSQL](https://www.postgresql.org/docs/12/admin.html) instance to store
1818
data, including workspace information and session tokens.
1919

20+
## Doctor
21+
22+
Before proceeding, we strongly recommend running
23+
[Doctor](https://github.com/cdr/coder-doctor), which is Coder-supplied
24+
command-line tool that evaluates whether your environment is ready to install
25+
Coder. If there are issues with your cluster that may impact the installation
26+
process, Doctor will return information on what the issue is and suggestions on
27+
how you can fix it.
28+
2029
## Creating the Coder namespace (optional)
2130

2231
We recommend running Coder in a separate

workspaces/workspace-params.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ By default, Coder allocates resources (CPU cores, memory, and disk space) based
9797
on the parent image. You can modify these starting values, though the maximum
9898
number of CPU cores, amount of memory, and allocation of disk space you can
9999
request for your workspace are determined by the Coder
100-
[site manager on an organization level](../admin/organizations.md#create-a-new-organization).
100+
[site manager on an organization level](../admin/organizations/index.md#create-a-new-organization).
101101

102102
Coder displays a warning if you choose your resource settings and they're less
103103
than the image-recommended default, but you can still create the workspace.

0 commit comments

Comments
 (0)