Skip to content

docs: copy edit the organizations doc and add link to best practices #15888

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.

Sign up for GitHub

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 2 commits into from
Dec 17, 2024
Merged

docs: copy edit the organizations doc and add link to best practices #15888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
acbc1f0
remove using-organizations doc
EdwardAngert Dec 16, 2024
c75d582
edit organizations doc
EdwardAngert Dec 16, 2024
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
69 changes: 37 additions & 32 deletions docs/admin/users/organizations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,14 @@ with multiple platform teams, all with unique resources:

![Organizations Example](../../images/admin/users/organizations/diagram.png)

For more information about how to use organizations, visit the
[organizations best practices](../../tutorials/best-practices/organizations.md)
guide.

## The default organization

All Coder deployments start with one organization called `Coder`.
All Coder deployments start with one organization called `Coder`. All new users
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
All Coder deployments start with one organization called `Coder`. All new users
All Coder deployments start with one organization called `coder`. All new users

I think it's small caps.

are added to this organization by default.

To edit the organization details, navigate to `Deployment -> Organizations` in
the top bar:
Expand All @@ -30,29 +35,29 @@ From there, you can manage the name, icon, description, users, and groups:
## Additional organizations

Any additional organizations have unique admins, users, templates, provisioners,
groups, and workspaces. Each organization must have at least one
[provisioner](../provisioners.md) as the built-in provisioner only applies to
groups, and workspaces. Each organization must have at least one dedicated
[provisioner](../provisioners.md) since the built-in provisioner only applies to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[provisioner](../provisioners.md) since the built-in provisioner only applies to
[provisioner](../provisioners.md) since the built-in provisioners only apply to

We can have multiple built-in provisioners. By default we run 3 of them.

the default organization.

You can configure [organization/role/group sync](./idp-sync.md) from your
identity provider to avoid manually assigning users to organizations.

## Creating an organization
## How to create an organization

### Prerequisites

- Coder v2.16+ deployment with Premium license with Organizations enabled
- Coder v2.16+ deployment with Premium license and Organizations enabled
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there cases where a customer has a premium license but organizations are not enabled.

([contact your account team](https://coder.com/contact)) for more details.
- User with `Owner` role

### 1. Create the organization

Within the sidebar, click `New organization` to create an organization. In this
In the sidebar, select **New organization** to create an organization. In this
example, we'll create the `data-platform` org.

![New Organization](../../images/admin/users/organizations/new-organization.png)

From there, let's deploy a provisioner and template for this organization.
Next deploy a provisioner and template for this organization.

### 2. Deploy a provisioner

Expand All @@ -61,50 +66,50 @@ 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:
1. Using Coder CLI, run the following command to create a key that will be used
to authenticate the provisioner:

```shell
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.

```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 >
```

< key omitted >
```
1. Start the provisioner with the key on your desired platform.

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](../provisioners.md).
In this example, start the provisioner using the Coder CLI on a host with
Docker. For instructions on using other platforms like Kubernetes, see our
[provisioner documentation](../provisioners.md).

```sh
export CODER_URL=https://<your-coder-url>
export CODER_PROVISIONER_DAEMON_KEY=<key>
coder provisionerd start --org <org-name>
```
```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:
**Create Template** screen now has an organization dropdown:

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

### 5. Add members
### 4. Add members

Navigate to `Deployment->Organizations` to add members to your organization.
Once added, they will be able to see the organization-specific templates.
From **Administration > Settings**, select **Organizations** to add members to
your organization. Once added, they will be able to see the
organization-specific templates.

![Add members](../../images/admin/users/organizations/organization-members.png)

### 6. Create a workspace
### 5. Create a workspace

Now, users in the data platform organization will see the templates related to
their organization. Users can be in multiple organizations.

![Workspace List](../../images/admin/users/organizations/workspace-list.png)

## Beta
## Next steps

As of v2.16.0, Organizations is in beta. If you encounter any issues, please
[file an issue](https://github.com/coder/coder/issues/new) or contact your
account team.
- [Organizations - best practices](../../tutorials/best-practices/organizations.md)
135 changes: 0 additions & 135 deletions docs/tutorials/using-organizations.md
View file
Open in desktop

This file was deleted.

Loading