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, provisioners, and premium license docs#14778

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
stirby merged 33 commits intomainfromorgs-licenses
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from1 commit
Commits
Show all changes
33 commits
Select commitHold shift + click to select a range
69d4f75
Add documentation for managing organizations
bpmctSep 24, 2024
4c8a165
Update icon path in organizations guide
bpmctSep 24, 2024
1595a72
Update RBAC documentation state in manifest
bpmctSep 24, 2024
6cf30a7
Add beta notice to organizations documentation
bpmctSep 24, 2024
5bc2c2e
Remove references to enterprise page
bpmctSep 25, 2024
abc156e
Update provisioners documentation for clarity
bpmctSep 25, 2024
0d76ed0
Update documentation to "premium" edition
bpmctSep 25, 2024
13f0a0e
Add documentation for licensing and group sync
bpmctSep 26, 2024
fe895cd
chore(docs): outline new feature stages (#14786)
EdwardAngertSep 26, 2024
d8de325
progress
bpmctSep 29, 2024
f48f21c
Merge branch 'main' into orgs-licenses
bpmctSep 29, 2024
67199d2
Add instructions for fetching role mappings
bpmctSep 29, 2024
941d9c2
Update role sync documentation for clarity
bpmctSep 29, 2024
ff7a8e2
Update organization sync troubleshooting links
bpmctSep 29, 2024
05369f6
Add org sync setup instructions to documentation
bpmctSep 29, 2024
f08be61
Fix sync link text order in organizations guide
bpmctSep 29, 2024
67ce5d4
Add section on custom roles to users guide
bpmctSep 29, 2024
841fa65
Update links to include premium in sync docs
bpmctSep 29, 2024
4473b2a
Update provisioners documentation for clarity
bpmctSep 29, 2024
2f0e14e
Update create organization page description
bpmctSep 29, 2024
10354d4
Remove subproject directories and update JSON format
bpmctSep 29, 2024
30e291f
fix(docs): correct license link path in org guide
bpmctSep 29, 2024
15efb35
Update organization documentation link paths
bpmctSep 30, 2024
6c2d6b2
Update paywall links to licensing doc
bpmctSep 30, 2024
e100b55
Update documentation for Premium license references
bpmctSep 30, 2024
821d9f2
Update licensing documentation for Premium plan
bpmctOct 1, 2024
5b41d99
fix(docs): improve clarity in licensing intro
bpmctOct 1, 2024
ee69767
Suppress link checker for licensing doc update
bpmctOct 1, 2024
6610084
Update manifest to improve readability and rename icon
bpmctOct 1, 2024
c26db48
Refactor manifest state to use consistent arrays
bpmctOct 1, 2024
f9c4202
fmt
bpmctOct 1, 2024
e3b34ff
Refactor route state field to support multiple states
bpmctOct 1, 2024
eb71bfa
fix: paywall doc link
jaaydenhOct 1, 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
PrevPrevious commit
NextNext commit
Update documentation for Premium license references
- Refine description to include "Premium" in feature availability.- Adjust terminology in auth and sync sections for consistency.- Modify organization documentation to reflect unified naming.
  • Loading branch information
@bpmct
bpmct committedSep 30, 2024
commite100b557dc69c90bbabb5e4c96e5c003f170bf77
4 changes: 2 additions & 2 deletionsdocs/admin/audit-logs.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,5 +122,5 @@ entry:

## Enabling this feature

This feature is only available withan
[enterprise license](https://coder.com/pricing).
This feature is only available witha
[Premium or Enterprise license](https://coder.com/pricing).
26 changes: 15 additions & 11 deletionsdocs/admin/auth.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -252,7 +252,7 @@ CODER_TLS_CLIENT_KEY_FILE=/path/to/key.pem
If your OpenID Connect provider supports group claims, you can configure Coder
to synchronize groups in your auth provider to groups within Coder. To enable
group sync, ensure that the `groups` claim is being sent by your OpenID
provider.This may involve requesting an additional
provider.You might need to request an additional
[scope](../reference/cli/server.md#--oidc-scopes) or additional configuration on
the OpenID provider side.

Expand All@@ -266,8 +266,8 @@ There are two ways you can configure group sync:

## Server Flags

First, confirm that your OIDC provider is sendinga groups claimby logging in
with OIDCand visiting the following URL:
First, confirm that your OIDC provider is sendingclaimsby logging in with OIDC
and visiting the following URL with an `Owner` account:

```text
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
Expand DownExpand Up@@ -437,14 +437,15 @@ Users who are not in a matching group will see the following error:
If your OpenID Connect provider supports roles claims, you can configure Coder
to synchronize roles in your auth provider to roles within Coder.

There are two ways you can configure group sync:
There are 2 ways to do role sync. Server Flags assign site wide roles, and
runtime org role sync assigns organization roles

<div class="tabs">

## Server Flags

First, confirm that your OIDC provider is sending a roles claim by logging in
with OIDC and visiting the following URL:
with OIDC and visiting the following URL with an `Owner` account:

```text
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
Expand DownExpand Up@@ -486,7 +487,7 @@ configure role sync at the organization level. In future Coder versions, you
will be able to configure this in the UI. For now, you must use CLI commands.

First, confirm that your OIDC provider is sending a roles claim by logging in
with OIDC and visiting the following URL:
with OIDC and visiting the following URL with an `Owner` account:

```text
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
Expand DownExpand Up@@ -532,8 +533,8 @@ role.
```

> Note: Be sure to use the `name` field for each role, not the display name. Use
> `organization-admin`, `organization-user-admin`, `organization-auditor`for
>the built in roles.
> `coderorganization roles show --org=<your-org>` to see rolesfor your
>organization.

To set these role sync settings, use the following command:

Expand All@@ -551,11 +552,14 @@ Visit the Coder UI to confirm these changes:

## Organization Sync (Premium)

> Note: In a future Coder release, this can be managed via the Coder UI instead
> of server flags.

If your OpenID Connect provider supports groups/role claims, you can configure
Coder to synchronizeroles in your auth provider to organizations within Coder.
Coder to synchronizeclaims in your auth provider to organizations within Coder.

First, confirm that your OIDC provider is sendinga groups claimby logging in
withOIDC and visiting the following URL:
First, confirm that your OIDC provider is sendingclainmsby logging in with
OIDC and visiting the following URL with an `Owner` account:

```text
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
Expand Down
4 changes: 2 additions & 2 deletionsdocs/admin/groups.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,5 +9,5 @@ access to specific templates. They can be defined via the Coder web UI,

## Enabling this feature

This feature is only available withan
[enterprise license](https://coder.com/pricing).
This feature is only available witha
[Premium or Enterprise license](https://coder.com/pricing).
4 changes: 2 additions & 2 deletionsdocs/admin/organizations.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
# Organizations (Enterprise) (Premium)
# Organizations (Premium)

> Note: Organizations requires a [Premium license](../licensing.md). For more
> details, [contact your account team](https://coder.com/contact).
Expand All@@ -15,7 +15,7 @@ with multiple platform teams, all with unique resources:

## The default organization

All Coder deployments start with one organization called `Default`.
All Coder deployments start with one organization called `Coder`.

To edit the organization details, navigate to `Deployment -> Organizations` in
the top bar:
Expand Down
2 changes: 1 addition & 1 deletiondocs/admin/rbac.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,4 +20,4 @@ You can set the following permissions:
## Enabling this feature

This feature is only available with an
[enterprise license](https://coder.com/pricing).
[Enterprise or Premium license](https://coder.com/pricing).
Binary file modifieddocs/images/admin/organizations/diagram.png
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.
2 changes: 1 addition & 1 deletiondocs/licensing.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ To try Premium features, you can [request a trial](https://coder.com/trial) or

## Adding your license key

There are two ways to addan enterprise license to a Coder deployment:
There are two ways to adda license to a Coder deployment:

<div class="tabs">

Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -313,7 +313,7 @@ const IdpMappingTable: FC<IdpMappingTableProps> = ({
startIcon={<LaunchOutlined />}
component="a"
href={docs(
`/admin/auth#${type.toLowerCase()}-sync-enterprise`,
`/admin/auth#${type.toLowerCase()}-sync-enterprise-premium`,
)}
target="_blank"
>
Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp