Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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
bpmct merged 13 commits intomainfromorgs-guide
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from1 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
NextNext commit
wip
  • Loading branch information
@bpmct
bpmct committedJul 25, 2024
commite4205391b1c15cb2f60714fdf61551046279139f
91 changes: 91 additions & 0 deletionsdocs/guides/using-organizations.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
# 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).

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:

![](../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)

## 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.

![](../images/guides/using-organizations/new-organization.png)

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
responsible for executing Terraform/OpenTofu to provision the infrastructure for
workspaces and testing templates. Before creating templates, we must deploy at
least one provisioner:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd mention the org name again.

"...must deploy at least one provisioner in thedata-platform 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 --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
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
View file
Open in desktop
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View file
Open in desktop
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View file
Open in desktop
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 9 additions & 1 deletiondocs/manifest.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
{
"versions": ["main"],
"versions": [
"main"
],
"routes": [
{
"title":"About",
Expand DownExpand Up@@ -1120,6 +1122,12 @@
"path":"./guides/index.md",
"icon_path":"./images/icons/notes.svg",
"children": [
{
"title":"Using Organizations",
"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",
Expand Down

[8]ページ先頭

©2009-2025 Movatter.jp