Skip to content

Commit 69d4f75

Browse files
committed
Add documentation for managing organizations
Introduce a new guide for managing organizations under a Coder deployment. This document provides step-by-step instructions for setting up and utilizing organizations to segment and isolate resources for different user groups or projects. Changes: - Added `organizations.md` guide in `docs/admin` - Renamed and relocated relevant images to `docs/images/admin/organizations` - Updated `manifest.json` to include the new organizations guide - Removed the obsolete "Using Organizations" guide This change facilitates better organization of the admin documentation and aligns with the introduction of enterprise features requiring a premium license.
1 parent b4f54f3 commit 69d4f75

File tree

10 files changed

+116
-8
lines changed

10 files changed

+116
-8
lines changed

docs/admin/organizations.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Organizations (Enterprise)
2+
3+
> Note: Organizations requires a [Premium license](./licensing.md). For more
4+
> details, [contact your account team](https://coder.com/contact).
5+
6+
Organizations can be used to segment and isolate resources inside a Coder
7+
deployment for different user groups or projects.
8+
9+
## Example
10+
11+
Here is an example of how one could use organizations to run a Coder deployment
12+
with multiple platform teams, all with unique resources:
13+
14+
![Organizations Example](../images/admin/organizations/diagram.png)
15+
16+
## The default organization
17+
18+
All Coder deployments start with one organization called `Default`.
19+
20+
To edit the organization details, navigate to `Deployment -> Organizations` in
21+
the top bar:
22+
23+
![Organizations Menu](../images/admin/organizations/deployment-organizations.png)
24+
25+
From there, you can manage the name, icon, description, users, and groups:
26+
27+
![Organization Settings](../images/admin/organizations/default-organization.png)
28+
29+
## Additional organizations
30+
31+
Any additional organizations have unique admins, users, templates, provisioners,
32+
groups, and workspaces. Each organization must have at least one
33+
[provisioner](./provisioners.md) as the built-in provisioner only applies to the
34+
default organization.
35+
36+
## Creating an organization
37+
38+
### Prerequisites
39+
40+
- Coder v2.16+ deployment with Premium license with Organizations enabled
41+
([contact your account team](https://coder.com/contact)) for more details.
42+
- User with `Owner` role
43+
44+
### 1. Create the organization
45+
46+
Within the sidebar, click `New organization` to create an organization. In this
47+
example, we'll create the `data-platform` org.
48+
49+
![New Organization](../images/admin/organizations/new-organization.png)
50+
51+
From there, let's deploy a provisioner and template for this organization.
52+
53+
### 2. Deploy a provisioner
54+
55+
[Provisioners](../admin/provisioners.md) are organization-scoped and are
56+
responsible for executing Terraform/OpenTofu to provision the infrastructure for
57+
workspaces and testing templates. Before creating templates, we must deploy at
58+
least one provisioner as the built-in provisioners are scoped to the default
59+
organization.
60+
61+
Using Coder CLI, run the following command to create a key that will be used to
62+
authenticate the provisioner:
63+
64+
```sh
65+
coder provisioner keys create data-cluster-key --org data-platform
66+
Successfully created provisioner key data-cluster! Save this authentication token, it will not be shown again.
67+
68+
< key omitted >
69+
```
70+
71+
Next, start the provisioner with the key on your desired platform. In this
72+
example, we'll start it using the Coder CLI on a host with Docker. For
73+
instructions on using other platforms like Kubernetes, see our
74+
[provisioner documentation](../admin/provisioners.md).
75+
76+
```sh
77+
export CODER_URL=https://<your-coder-url>
78+
export CODER_PROVISIONER_DAEMON_KEY=<key>
79+
coder provisionerd start --org <org-name>
80+
```
81+
82+
### 3. Create a template
83+
84+
Once you've started a provisioner, you can create a template. You'll notice the
85+
"Create Template" screen now has an organization dropdown:
86+
87+
![Template Org Picker](../images/admin/organizations/template-org-picker.png)
88+
89+
### 5. Add members
90+
91+
Navigate to `Deployment->Organizations` to add members to your organization.
92+
Once added, they will be able to see the organization-specific templates.
93+
94+
![Add members](../images/admin/organizations/organization-members.png)
95+
96+
### 6. Create a workspace
97+
98+
Now, users in the data platform organization will see the templates related to
99+
their organization. Users can be in multiple organizations.
100+
101+
![Workspace List](../images/admin/organizations/workspace-list.png)
227 KB
Loading

docs/images/icons/orgs.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/manifest.json

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
2-
"versions": ["main"],
2+
"versions": [
3+
"main"
4+
],
35
"routes": [
46
{
57
"title": "About",
@@ -397,8 +399,15 @@
397399
"state": "enterprise"
398400
},
399401
{
400-
"title": "RBAC",
401-
"description": "Learn how to use the role based access control",
402+
"title": "Organizations",
403+
"description": "Learn how to manage organizations",
404+
"path": "./admin/organizations.md",
405+
"icon_path": "./images/icons/group.svg",
406+
"state": "enterprise"
407+
},
408+
{
409+
"title": "Template RBAC",
410+
"description": "Learn how to use the role based access control against templates",
402411
"path": "./admin/rbac.md",
403412
"icon_path": "./images/icons/rbac.svg",
404413
"state": "enterprise"
@@ -1324,11 +1333,6 @@
13241333
"title": "Cloning Git Repositories",
13251334
"description": "Automatically clone Git repositories into your workspace",
13261335
"path": "./guides/cloning-git-repositories.md"
1327-
},
1328-
{
1329-
"title": "Using Organizations",
1330-
"description": "Learn how to use our (early access) Organizations functionality",
1331-
"path": "./guides/using-organizations.md"
13321336
}
13331337
]
13341338
}

0 commit comments

Comments
 (0)