- Notifications
You must be signed in to change notification settings - Fork1.1k
docs: add organizations guide#14012
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes from1 commit
e420539d4bfbe76f2022c8adc7250a2954e7a2a3e68c66d3406909ab92173463f1320ff15cdf7a0e1d7d0d15426File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # Using Organizations (Alpha) | ||
bpmct marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| > Note: Organizations is still under active development and requires a | ||
| > non-standard enterprise license to use. For more details, | ||
| > [contact your account team](https://coder.com/contact). | ||
| Organizations allow you to run a Coder deployment with multiple platform teams, | ||
| all with uniquely scoped templates, provisioners, users, groups, and workspaces. | ||
| ## Prerequisites | ||
| - Coder deployment with non-standard license with Organizations enabled | ||
| ([contact your account team](https://coder.com/contact)) | ||
| - User with `Owner` role | ||
| - Coder CLI installed on local machine | ||
| ## Enable the experiment | ||
| Organizations is still under an | ||
| [experimental flag](../cli/server.md#--experiments). To enable it, set the | ||
| following environment variable for the Coder server: | ||
| ```sh | ||
| CODER_EXPERIMENTS=multi-organization | ||
| ``` | ||
| ## The default organization | ||
| All Coder deployments start with one organization called `Default`. | ||
| To edit the organization details, navigate to `Deployment -> Organizations` in | ||
| the top bar: | ||
|  | ||
| From there, you can manage the name, icon, description, users, and groups: | ||
|  | ||
| ## Guide: Your first organization | ||
| ### 1. Create the organization | ||
| Within the sidebar, click `New organization` to create an organization. In this | ||
| example, we'll create the `data-platform` org. | ||
|  | ||
| From there, let's deploy a provisioner and template for this organization. | ||
| ### 2. Deploy a provisioner | ||
| [Provisioners](../admin/provisioners.md) are organization-scoped and are | ||
bpmct marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| responsible for executing Terraform/OpenTofu to provision the infrastructure for | ||
| workspaces and testing templates. Before creating templates, we must deploy at | ||
| least one provisioner: | ||
| ||
| using Coder CLI, run the following command to create a key that will be used to | ||
| authenticate the provisioner: | ||
| ```sh | ||
| coder provisioner keys create data-cluster --org data-platform | ||
| Successfully created provisioner key data-cluster! Save this authentication token, it will not be shown again. | ||
| < key omitted >> | ||
| ``` | ||
| Next, on your desired platform, start the provisioner with the key. See our | ||
| [provisioner documentation](../admin/provisioners.md) for details on running on | ||
| additional platforms (e.g. Kubernetes). In this example, we'll start it directly | ||
bpmct marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| with the Coder CLI on a host with Docker: | ||
| ```sh | ||
| coder provisionerd start --key=<key> | ||
| ``` | ||
| ### 3. Create a template | ||
| WIP! | ||
| ### 4. Add members | ||
| Navigate to the | ||
| ## Planned work | ||
| Organizations is under active development. The following features are planned | ||
| before organizations are generally available: | ||
| - [ ] Sync OIDC claims to auto-assign users to organizations / roles | ||
| - [ ] View provisioner health and manage PSKs in the Coder UI | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| { | ||
| "versions": [ | ||
| "main" | ||
| ], | ||
| "routes": [ | ||
| { | ||
| "title":"About", | ||
| @@ -1120,6 +1122,12 @@ | ||
| "path":"./guides/index.md", | ||
| "icon_path":"./images/icons/notes.svg", | ||
| "children": [ | ||
| { | ||
| "title":"Using Organizations", | ||
bpmct marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| "description":"Learn how to onboard multiple platform teams with Organizations", | ||
| "path":"./guides/using-organizations.md", | ||
| "state":"alpha" | ||
| }, | ||
| { | ||
| "title":"Generate a Support Bundle", | ||
| "description":"Generate and upload a Support Bundle to Coder Support", | ||