Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
edits to docs
  • Loading branch information
bpmct committed Aug 16, 2024
commit 7a2a3e6fe464feedc656c97763589c786faabb52
62 changes: 45 additions & 17 deletions docs/guides/using-organizations.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Using Organizations (Alpha)

> 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).
> non-standard enterprise license to use. Do not use organizations on your
> production instance!
>
> 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.
Expand All @@ -14,14 +16,31 @@ all with uniquely scoped templates, provisioners, users, groups, and workspaces.
- User with `Owner` role
- Coder CLI installed on local machine

## Enable the experiment
## Switch to the preview image and 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:
To try the latest organizations features, switch to a preview image in your Helm
chart and enable the [experimental flag](../cli/server.md#--experiments).

For example, with Kubernetes, set the following in your `values.yaml`:

```yaml
coderd:
image:
repo: ghcr.io/coder/coder-preview
tag: orgs-preview-aug-16
env:
- name: CODER_EXPERIMENTS
value: multi-organization
```

> See all
> [preview images](https://github.com/coder/coder/pkgs/container/coder-preview)
> in GitHub. Preview images prefixed with `main-` expire after a week.

Then, upgrade your deployment:

```sh
CODER_EXPERIMENTS=multi-organization
helm upgrade coder coder-v2/coder -f values.yaml
```

## The default organization
Expand All @@ -31,11 +50,11 @@ All Coder deployments start with one organization called `Default`.
To edit the organization details, navigate to `Deployment -> Organizations` in
the top bar:

![](../images/guides/using-organizations/deployment-organizations.png)
![Organizations Menu](../images/guides/using-organizations/deployment-organizations.png)

From there, you can manage the name, icon, description, users, and groups:

![](../images/guides/using-organizations/default-organization.png)
![Organization Settings](../images/guides/using-organizations/default-organization.png)

## Guide: Your first organization

Expand Down Expand Up @@ -71,21 +90,24 @@ additional platforms (e.g. Kubernetes). In this example, we'll start it directly
with the Coder CLI on a host with Docker:

```sh
coder provisionerd start --org <org-id> --key=<key>
export CODER_URL=https://<your-coder-url>
export CODER_PROVISIONER_DAEMON_KEY=<key>
coder provisionerd start --org <org-name>
```

> To get the organization ID, run `coder orgs show me` using the Coder CLI.

### 3. Create a template

WIP!
Once you've started a provisioner, you can create a template. You'll notice the
"Create Template" screen now has an organization dropdown:

![Template Org Picker](../images/guides/using-organizations/template-org-picker.png)

### 4. Create a workspace

Navigate back to the `Templates` page. Templates are now separated by
Organization in the sidebar:
Now, users in the data platform organization will see the templates related to
their organization. Users can be in multiple organizations.

WIP
![Workspace List](../images/guides/using-organizations/workspace-list.png)

### 4. Add members

Expand All @@ -99,6 +121,12 @@ Once added, they will be able to see the organization-specific templates.
Organizations is under active development. The following features are planned
before organizations are generally available:

- [ ] Per-Organization Quotas
- [ ] Sync OIDC claims to auto-assign users to organizations / roles + SCIM
support
- [ ] View provisioner health and create provisioner keys via the Coder UI
- [ ] View provisioner health via the Coder UI

## Support & Feedback

[Contact your account team](https://coder.com/contact) if you have any questions
or feedback.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading