|
| 1 | +# Using Organizations (Alpha) |
| 2 | + |
| 3 | +> Note: Organizations is still under active development and requires a |
| 4 | +> non-standard enterprise license to use. For more details, |
| 5 | +> [contact your account team](https://coder.com/contact). |
| 6 | +
|
| 7 | +Organizations allow you to run a Coder deployment with multiple platform teams, |
| 8 | +all with uniquely scoped templates, provisioners, users, groups, and workspaces. |
| 9 | + |
| 10 | +## Prerequisites |
| 11 | + |
| 12 | +- Coder deployment with non-standard license with Organizations enabled |
| 13 | + ([contact your account team](https://coder.com/contact)) |
| 14 | +- User with `Owner` role |
| 15 | +- Coder CLI installed on local machine |
| 16 | + |
| 17 | +## Enable the experiment |
| 18 | + |
| 19 | +Organizations is still under an |
| 20 | +[experimental flag](../cli/server.md#--experiments). To enable it, set the |
| 21 | +following environment variable for the Coder server: |
| 22 | + |
| 23 | +```sh |
| 24 | +CODER_EXPERIMENTS=multi-organization |
| 25 | +``` |
| 26 | + |
| 27 | +## The default organization |
| 28 | + |
| 29 | +All Coder deployments start with one organization called `Default`. |
| 30 | + |
| 31 | +To edit the organization details, navigate to `Deployment -> Organizations` in |
| 32 | +the top bar: |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | +From there, you can manage the name, icon, description, users, and groups: |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +## Guide: Your first organization |
| 41 | + |
| 42 | +### 1. Create the organization |
| 43 | + |
| 44 | +Within the sidebar, click `New organization` to create an organization. In this |
| 45 | +example, we'll create the `data-platform` org. |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | +From there, let's deploy a provisioner and template for this organization. |
| 50 | + |
| 51 | +### 2. Deploy a provisioner |
| 52 | + |
| 53 | +[Provisioners](../admin/provisioners.md) are organization-scoped and are |
| 54 | +responsible for executing Terraform/OpenTofu to provision the infrastructure for |
| 55 | +workspaces and testing templates. Before creating templates, we must deploy at |
| 56 | +least one provisioner: |
| 57 | + |
| 58 | +using Coder CLI, run the following command to create a key that will be used to |
| 59 | +authenticate the provisioner: |
| 60 | + |
| 61 | +```sh |
| 62 | +coder provisioner keys create data-cluster --org data-platform |
| 63 | +Successfully created provisioner key data-cluster! Save this authentication token, it will not be shown again. |
| 64 | + |
| 65 | +< key omitted >> |
| 66 | +``` |
| 67 | + |
| 68 | +Next, on your desired platform, start the provisioner with the key. See our |
| 69 | +[provisioner documentation](../admin/provisioners.md) for details on running on |
| 70 | +additional platforms (e.g. Kubernetes). In this example, we'll start it directly |
| 71 | +with the Coder CLI on a host with Docker: |
| 72 | + |
| 73 | +```sh |
| 74 | +coder provisionerd start --key=<key> |
| 75 | +``` |
| 76 | + |
| 77 | +### 3. Create a template |
| 78 | + |
| 79 | +WIP! |
| 80 | + |
| 81 | +### 4. Add members |
| 82 | + |
| 83 | +Navigate to the |
| 84 | + |
| 85 | +## Planned work |
| 86 | + |
| 87 | +Organizations is under active development. The following features are planned |
| 88 | +before organizations are generally available: |
| 89 | + |
| 90 | +- [ ] Sync OIDC claims to auto-assign users to organizations / roles |
| 91 | +- [ ] View provisioner health and manage PSKs in the Coder UI |
0 commit comments