- Notifications
You must be signed in to change notification settings - Fork924
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
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
13 commits Select commitHold shift + click to select a range
e420539
wip
bpmctd4bfbe7
add workspace & members screenshot
bpmct6f2022c
add audit logs
bpmct8adc725
org id and provisioner key
bpmct0a2954e
Update docs/guides/using-organizations.md
bpmct7a2a3e6
edits to docs
bpmct8c66d34
fixup
bpmct06909ab
Merge branch 'main' into orgs-guide
bpmct9217346
fmt
bpmct3f1320f
changes based on kirby feedback
bpmctf15cdf7
fix link
bpmcta0e1d7d
fix manifest
bpmct0d15426
fmt
bpmctFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
135 changes: 135 additions & 0 deletionsdocs/guides/using-organizations.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
# Using Organizations | ||
> Note: Organizations is still under active development and requires a | ||
> 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. | ||
## 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 | ||
## Switch to the preview image and enable the experiment | ||
To try the latest organizations features, switch to a preview image in your Helm | ||
chart and enable the | ||
[experimental flag](../reference/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 | ||
helm upgrade coder coder-v2/coder -f values.yaml | ||
``` | ||
## 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 as the built-in provisioners are scoped to the default | ||
organization. | ||
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-key --org data-platform | ||
Successfully created provisioner key data-cluster! Save this authentication token, it will not be shown again. | ||
< key omitted > | ||
``` | ||
Next, start the provisioner with the key on your desired platform. In this | ||
example, we'll start it using the Coder CLI on a host with Docker. For | ||
instructions on using other platforms like Kubernetes, see our | ||
[provisioner documentation](../admin/provisioners.md). | ||
```sh | ||
export CODER_URL=https://<your-coder-url> | ||
export CODER_PROVISIONER_DAEMON_KEY=<key> | ||
coder provisionerd start --org <org-name> | ||
``` | ||
### 3. Create a template | ||
Once you've started a provisioner, you can create a template. You'll notice the | ||
"Create Template" screen now has an organization dropdown: | ||
 | ||
### 5. Add members | ||
Navigate to `Deployment->Organizations` to add members to your organization. | ||
Once added, they will be able to see the organization-specific templates. | ||
 | ||
### 6. Create a workspace | ||
Now, users in the data platform organization will see the templates related to | ||
their organization. Users can be in multiple organizations. | ||
 | ||
## Planned work | ||
Organizations is under active development. The work is planned before | ||
organizations is generally available: | ||
stirby marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
- View provisioner health via the Coder UI | ||
- Custom Role support in Coder UI | ||
- Per-organization quotas | ||
- Improved visibility of organization-specific resources throughout the UI | ||
- Sync OIDC claims to auto-assign users to organizations / roles + SCIM support | ||
## Support & Feedback | ||
[Contact your account team](https://coder.com/contact) if you have any questions | ||
or feedback. |
Binary file addeddocs/images/guides/using-organizations/default-organization.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/images/guides/using-organizations/deployment-organizations.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/images/guides/using-organizations/new-organization.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/images/guides/using-organizations/organization-members.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/images/guides/using-organizations/template-org-picker.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/images/guides/using-organizations/workspace-list.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletionsdocs/manifest.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.