@@ -14,9 +14,14 @@ with multiple platform teams, all with unique resources:
14
14
15
15
![ Organizations Example] ( ../../images/admin/users/organizations/diagram.png )
16
16
17
+ For more information about how to use organizations, visit the
18
+ [ organizations best practices] ( ../../tutorials/best-practices/organizations.md )
19
+ guide.
20
+
17
21
## The default organization
18
22
19
- All Coder deployments start with one organization called ` Coder ` .
23
+ All Coder deployments start with one organization called ` Coder ` . All new users
24
+ are added to this organization by default.
20
25
21
26
To edit the organization details, navigate to ` Deployment -> Organizations ` in
22
27
the top bar:
@@ -30,29 +35,29 @@ From there, you can manage the name, icon, description, users, and groups:
30
35
## Additional organizations
31
36
32
37
Any additional organizations have unique admins, users, templates, provisioners,
33
- groups, and workspaces. Each organization must have at least one
34
- [ provisioner] ( ../provisioners.md ) as the built-in provisioner only applies to
38
+ groups, and workspaces. Each organization must have at least one dedicated
39
+ [ provisioner] ( ../provisioners.md ) since the built-in provisioner only applies to
35
40
the default organization.
36
41
37
42
You can configure [ organization/role/group sync] ( ./idp-sync.md ) from your
38
43
identity provider to avoid manually assigning users to organizations.
39
44
40
- ## Creating an organization
45
+ ## How to create an organization
41
46
42
47
### Prerequisites
43
48
44
- - Coder v2.16+ deployment with Premium license with Organizations enabled
49
+ - Coder v2.16+ deployment with Premium license and Organizations enabled
45
50
([ contact your account team] ( https://coder.com/contact ) ) for more details.
46
51
- User with ` Owner ` role
47
52
48
53
### 1. Create the organization
49
54
50
- Within the sidebar, click ` New organization ` to create an organization. In this
55
+ In the sidebar, select ** New organization** to create an organization. In this
51
56
example, we'll create the ` data-platform ` org.
52
57
53
58
![ New Organization] ( ../../images/admin/users/organizations/new-organization.png )
54
59
55
- From there, let's deploy a provisioner and template for this organization.
60
+ Next deploy a provisioner and template for this organization.
56
61
57
62
### 2. Deploy a provisioner
58
63
@@ -61,50 +66,50 @@ for executing Terraform/OpenTofu to provision the infrastructure for workspaces
61
66
and testing templates. Before creating templates, we must deploy at least one
62
67
provisioner as the built-in provisioners are scoped to the default organization.
63
68
64
- Using Coder CLI, run the following command to create a key that will be used to
65
- authenticate the provisioner:
69
+ 1 . Using Coder CLI, run the following command to create a key that will be used
70
+ to authenticate the provisioner:
71
+
72
+ ``` shell
73
+ coder provisioner keys create data-cluster-key --org data-platform
74
+ Successfully created provisioner key data-cluster! Save this authentication token, it will not be shown again.
66
75
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.
76
+ < key omitted >
77
+ ```
70
78
71
- < key omitted >
72
- ```
79
+ 1 . Start the provisioner with the key on your desired platform.
73
80
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] ( ../provisioners.md ) .
81
+ In this example, start the provisioner using the Coder CLI on a host with
82
+ Docker. For instructions on using other platforms like Kubernetes, see our
83
+ [ provisioner documentation] ( ../provisioners.md ) .
78
84
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
- ```
85
+ ``` sh
86
+ export CODER_URL=https://< your-coder-url>
87
+ export CODER_PROVISIONER_DAEMON_KEY=< key>
88
+ coder provisionerd start --org < org-name>
89
+ ```
84
90
85
91
### 3. Create a template
86
92
87
93
Once you've started a provisioner, you can create a template. You'll notice the
88
- " Create Template" screen now has an organization dropdown:
94
+ ** Create Template** screen now has an organization dropdown:
89
95
90
96
![ Template Org Picker] ( ../../images/admin/users/organizations/template-org-picker.png )
91
97
92
- ### 5 . Add members
98
+ ### 4 . Add members
93
99
94
- Navigate to ` Deployment->Organizations ` to add members to your organization.
95
- Once added, they will be able to see the organization-specific templates.
100
+ From ** Administration > Settings** , select ** Organizations** to add members to
101
+ your organization. Once added, they will be able to see the
102
+ organization-specific templates.
96
103
97
104
![ Add members] ( ../../images/admin/users/organizations/organization-members.png )
98
105
99
- ### 6 . Create a workspace
106
+ ### 5 . Create a workspace
100
107
101
108
Now, users in the data platform organization will see the templates related to
102
109
their organization. Users can be in multiple organizations.
103
110
104
111
![ Workspace List] ( ../../images/admin/users/organizations/workspace-list.png )
105
112
106
- ## Beta
113
+ ## Next steps
107
114
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.
115
+ - [ Organizations - best practices] ( ../../tutorials/best-practices/organizations.md )
0 commit comments