Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit f5fd31d

Browse files
committed
copied organizations from main
1 parent 64cf961 commit f5fd31d

File tree

1 file changed

+105
-8
lines changed

1 file changed

+105
-8
lines changed

docs/admin/users/organizations.md

Lines changed: 105 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,110 @@
11
# Organizations (Premium)
22

3-
> **Note**: This feature is in alpha and only available under the Coder Premium
4-
> enterprise license, launched in August 2024.
5-
> [Contact your account team](https://coder.com/contact/sales) for more
6-
> information.
3+
> Note: Organizations requires a [Premium license](../licensing.md). For more
4+
> details, [contact your account team](https://coder.com/contact).
75
8-
Organizations are a logical bucket of users with unique administrators,
9-
templates, provisioners, and workspaces into the Coder platform.
6+
Organizations can be used to segment and isolate resources inside a Coder
7+
deployment for different user groups or projects.
108

11-
## Organizations vs Groups
9+
## Example
1210

13-
TODO
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 `Coder`.
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+
You can configure [organization/role/group sync](./auth.md) from your identity
37+
provider to avoid manually assigning users to organizations.
38+
39+
## Creating an organization
40+
41+
### Prerequisites
42+
43+
- Coder v2.16+ deployment with Premium license with Organizations enabled
44+
([contact your account team](https://coder.com/contact)) for more details.
45+
- User with `Owner` role
46+
47+
### 1. Create the organization
48+
49+
Within the sidebar, click `New organization` to create an organization. In this
50+
example, we'll create the `data-platform` org.
51+
52+
![New Organization](../images/admin/organizations/new-organization.png)
53+
54+
From there, let's deploy a provisioner and template for this organization.
55+
56+
### 2. Deploy a provisioner
57+
58+
[Provisioners](../admin/provisioners.md) are organization-scoped and are
59+
responsible for executing Terraform/OpenTofu to provision the infrastructure for
60+
workspaces and testing templates. Before creating templates, we must deploy at
61+
least one provisioner as the built-in provisioners are scoped to the default
62+
organization.
63+
64+
Using Coder CLI, run the following command to create a key that will be used to
65+
authenticate the provisioner:
66+
67+
```sh
68+
coder provisioner keys create data-cluster-key --org data-platform
69+
Successfully created provisioner key data-cluster! Save this authentication token, it will not be shown again.
70+
71+
< key omitted >
72+
```
73+
74+
Next, start the provisioner with the key on your desired platform. In this
75+
example, we'll start it using the Coder CLI on a host with Docker. For
76+
instructions on using other platforms like Kubernetes, see our
77+
[provisioner documentation](../admin/provisioners.md).
78+
79+
```sh
80+
export CODER_URL=https://<your-coder-url>
81+
export CODER_PROVISIONER_DAEMON_KEY=<key>
82+
coder provisionerd start --org <org-name>
83+
```
84+
85+
### 3. Create a template
86+
87+
Once you've started a provisioner, you can create a template. You'll notice the
88+
"Create Template" screen now has an organization dropdown:
89+
90+
![Template Org Picker](../images/admin/organizations/template-org-picker.png)
91+
92+
### 5. Add members
93+
94+
Navigate to `Deployment->Organizations` to add members to your organization.
95+
Once added, they will be able to see the organization-specific templates.
96+
97+
![Add members](../images/admin/organizations/organization-members.png)
98+
99+
### 6. Create a workspace
100+
101+
Now, users in the data platform organization will see the templates related to
102+
their organization. Users can be in multiple organizations.
103+
104+
![Workspace List](../images/admin/organizations/workspace-list.png)
105+
106+
## Beta
107+
108+
As of v2.16.0, Organizations is in beta. If you encounter any issues, please
109+
[file an issue](https://github.com/coder/coder/issues/new) or contact your
110+
account team.

0 commit comments

Comments
 (0)