Skip to content

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 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 33 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
69d4f75
Add documentation for managing organizations
bpmct Sep 24, 2024
4c8a165
Update icon path in organizations guide
bpmct Sep 24, 2024
1595a72
Update RBAC documentation state in manifest
bpmct Sep 24, 2024
6cf30a7
Add beta notice to organizations documentation
bpmct Sep 24, 2024
5bc2c2e
Remove references to enterprise page
bpmct Sep 25, 2024
abc156e
Update provisioners documentation for clarity
bpmct Sep 25, 2024
0d76ed0
Update documentation to "premium" edition
bpmct Sep 25, 2024
13f0a0e
Add documentation for licensing and group sync
bpmct Sep 26, 2024
fe895cd
chore(docs): outline new feature stages (#14786)
EdwardAngert Sep 26, 2024
d8de325
progress
bpmct Sep 29, 2024
f48f21c
Merge branch 'main' into orgs-licenses
bpmct Sep 29, 2024
67199d2
Add instructions for fetching role mappings
bpmct Sep 29, 2024
941d9c2
Update role sync documentation for clarity
bpmct Sep 29, 2024
ff7a8e2
Update organization sync troubleshooting links
bpmct Sep 29, 2024
05369f6
Add org sync setup instructions to documentation
bpmct Sep 29, 2024
f08be61
Fix sync link text order in organizations guide
bpmct Sep 29, 2024
67ce5d4
Add section on custom roles to users guide
bpmct Sep 29, 2024
841fa65
Update links to include premium in sync docs
bpmct Sep 29, 2024
4473b2a
Update provisioners documentation for clarity
bpmct Sep 29, 2024
2f0e14e
Update create organization page description
bpmct Sep 29, 2024
10354d4
Remove subproject directories and update JSON format
bpmct Sep 29, 2024
30e291f
fix(docs): correct license link path in org guide
bpmct Sep 29, 2024
15efb35
Update organization documentation link paths
bpmct Sep 30, 2024
6c2d6b2
Update paywall links to licensing doc
bpmct Sep 30, 2024
e100b55
Update documentation for Premium license references
bpmct Sep 30, 2024
821d9f2
Update licensing documentation for Premium plan
bpmct Oct 1, 2024
5b41d99
fix(docs): improve clarity in licensing intro
bpmct Oct 1, 2024
ee69767
Suppress link checker for licensing doc update
bpmct Oct 1, 2024
6610084
Update manifest to improve readability and rename icon
bpmct Oct 1, 2024
c26db48
Refactor manifest state to use consistent arrays
bpmct Oct 1, 2024
f9c4202
fmt
bpmct Oct 1, 2024
e3b34ff
Refactor route state field to support multiple states
bpmct Oct 1, 2024
eb71bfa
fix: paywall doc link
jaaydenh Oct 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
Prev Previous commit
Next Next commit
Update documentation to "premium" edition
- Change "enterprise" references to "premium" to reflect the new branding.
- Ensure consistency across various documentation sections.
- Update relevant links and terms for clarity.

### Changes:

- Appearance section title updated to include premium.
- SCIM, Group Sync, Role Sync, and multiple other sections retitled for premium.
- FAQs and guides updated to reflect new premium terminology.
- Manifest JSON entries updated to list "premium" alongside "enterprise".
- Networking and port forwarding documentation updated to include premium.
- Added user quiet hours and autostop requirement sections updated to indicate premium.
- Ensure all references in various docs are consistent with the new premium branding.
  • Loading branch information
bpmct committed Sep 25, 2024
commit 0d76ed0f646eaae1aa0bcacadbea8820ec4c5dd4
2 changes: 1 addition & 1 deletion docs/admin/appearance.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Appearance (enterprise)
# Appearance (enterprise) (premium)

Customize the look of your Coder deployment to meet your enterprise
requirements.
Expand Down
6 changes: 3 additions & 3 deletions docs/admin/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ your Coder deployment:
CODER_DISABLE_PASSWORD_AUTH=true
```

## SCIM (enterprise)
## SCIM (enterprise) (premium)

Coder supports user provisioning and deprovisioning via SCIM 2.0 with header
authentication. Upon deactivation, users are
Expand All @@ -249,7 +249,7 @@ CODER_TLS_CLIENT_CERT_FILE=/path/to/cert.pem
CODER_TLS_CLIENT_KEY_FILE=/path/to/key.pem
```

## Group Sync (enterprise)
## Group Sync (enterprise) (premium)

If your OpenID Connect provider supports group claims, you can configure Coder
to synchronize groups in your auth provider to groups within Coder.
Expand Down Expand Up @@ -326,7 +326,7 @@ Users who are not in a matching group will see the following error:

![Unauthorized group error](../images/admin/group-allowlist.png)

## Role sync (enterprise)
## Role sync (enterprise) (premium)

If your OpenID Connect provider supports roles claims, you can configure Coder
to synchronize roles in your auth provider to deployment-wide roles within
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/external-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Optionally, you can request custom scopes:
CODER_EXTERNAL_AUTH_0_SCOPES="repo:read repo:write write:gpg_key"
```

### Multiple External Providers (enterprise)
### Multiple External Providers (enterprise) (premium)

Multiple providers are an [Enterprise feature](https://coder.com/pricing). Below
is an example configuration with multiple providers.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ notification is indicated on the right hand side of this table.

![User Notification Preferences](../images/user-notification-preferences.png)

## Delivery Preferences (enterprise)
## Delivery Preferences (enterprise) (premium)

Administrators can configure which delivery methods are used for each different
[event type](#event-types).
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/organizations.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Organizations (Enterprise)
# Organizations (Enterprise) (Premium)

> Note: Organizations requires a [Premium license](./licensing.md). For more
> details, [contact your account team](https://coder.com/contact).
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Coder offers these user roles in the community edition:
| | Auditor | User Admin | Template Admin | Owner |
| ----------------------------------------------------- | ------- | ---------- | -------------- | ----- |
| Add and remove Users | | ✅ | | ✅ |
| Manage groups (enterprise) | | ✅ | | ✅ |
| Manage groups (premium ) | | ✅ | | ✅ |
| Change User roles | | | | ✅ |
| Manage **ALL** Templates | | | ✅ | ✅ |
| View **ALL** Workspaces | | | ✅ | ✅ |
Expand Down
9 changes: 4 additions & 5 deletions docs/faqs.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# FAQs

Frequently asked questions on Coder OSS and Enterprise deployments. These FAQs
come from our community and enterprise customers, feel free to
Frequently asked questions on Coder OSS and Premium deployments. These FAQs come
from our community and enterprise customers, feel free to
[contribute to this page](https://github.com/coder/coder/edit/main/docs/faqs.md).

### How do I add an enterprise license?
### How do I add a Premium trial license?

Visit https://coder.com/trial or contact
[sales@coder.com](mailto:sales@coder.com?subject=License) to get a v2 enterprise
trial key.
[sales@coder.com](mailto:sales@coder.com?subject=License) to get a trial key.

You can add a license through the UI or CLI.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Guides and Tutorials

Here you can find a list of employee-written guides on Coder for OSS and
Enterprise. These tutorials are hosted on our
Premium. These tutorials are hosted on our
[Github](https://github.com/coder/coder/) where you can leave feedback or
request new topics to be covered.

Expand Down
50 changes: 40 additions & 10 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,10 @@
"title": "Process Logging",
"description": "Audit commands in workspaces with exectrace",
"path": "./templates/process-logging.md",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "Icons",
Expand Down Expand Up @@ -396,14 +399,20 @@
"description": "Learn how to manage user groups",
"path": "./admin/groups.md",
"icon_path": "./images/icons/group.svg",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "Organizations",
"description": "Learn how to manage organizations",
"path": "./admin/organizations.md",
"icon_path": "./images/icons/orgs.svg",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "Template RBAC",
Expand Down Expand Up @@ -456,14 +465,20 @@
"description": "Run provisioners isolated from the Coder server",
"path": "./admin/provisioners.md",
"icon_path": "./images/icons/queue.svg",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "Workspace Proxies",
"description": "Run geo distributed workspace proxies",
"path": "./admin/workspace-proxies.md",
"icon_path": "./images/icons/networking.svg",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "Application Logs",
Expand All @@ -476,21 +491,30 @@
"description": "Learn how to use Audit Logs in your Coder deployment",
"path": "./admin/audit-logs.md",
"icon_path": "./images/icons/radar.svg",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "Quotas",
"description": "Learn how to use Workspace Quotas in Coder",
"path": "./admin/quotas.md",
"icon_path": "./images/icons/dollar.svg",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "High Availability",
"description": "Learn how to configure Coder for High Availability",
"path": "./admin/high-availability.md",
"icon_path": "./images/icons/hydra.svg",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "Prometheus",
Expand All @@ -503,7 +527,10 @@
"description": "Learn how to configure the appearance of Coder",
"path": "./admin/appearance.md",
"icon_path": "./images/icons/info.svg",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "Telemetry",
Expand All @@ -516,7 +543,10 @@
"description": "Learn how to encrypt sensitive data at rest in Coder",
"path": "./admin/encryption.md",
"icon_path": "./images/icons/lock.svg",
"state": "enterprise"
"state": [
"enterprise",
"premium"
]
},
{
"title": "Deployment Health",
Expand Down
6 changes: 3 additions & 3 deletions docs/networking/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,10 @@ $ coder server --derp-config-path derpmap.json

The dashboard (and web apps opened through the dashboard) are served from the
coder server, so they can only be geo-distributed with High Availability mode in
our Enterprise Edition. [Reach out to Sales](https://coder.com/contact) to learn
more.
our Enterprise and Premium Editions.
[Reach out to Sales](https://coder.com/contact) to learn more.

## Browser-only connections (enterprise)
## Browser-only connections (enterprise) (premium)

Some Coder deployments require that all access is through the browser to comply
with security policies. In these cases, pass the `--browser-only` flag to
Expand Down
2 changes: 1 addition & 1 deletion docs/networking/port-forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ resource uses a different method of authentication and **is not impacted by the
template's maximum sharing level**, nor the level of a shared port that points
to the app.

### Configure maximum port sharing level (enterprise)
### Configure maximum port sharing level (enterprise) (premium)

Enterprise-licensed template admins can control the maximum port sharing level
for workspaces under a given template in the template settings. By default, the
Expand Down
4 changes: 2 additions & 2 deletions docs/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ coder_app.

![Autostop UI](./images/autostop.png)

### Autostop requirement (enterprise)
### Autostop requirement (enterprise) (premium)

Autostop requirement is a template setting that determines how often workspaces
using the template must automatically stop. Autostop requirement ignores any
Expand Down Expand Up @@ -113,7 +113,7 @@ Autostop requirement is disabled when the template is using the deprecated max
lifetime feature. Templates can choose to use a max lifetime or an autostop
requirement during the deprecation period, but only one can be used at a time.

### User quiet hours (enterprise)
### User quiet hours (enterprise) (premium)

User quiet hours can be configured in the user's schedule settings page.
Workspaces on templates with an autostop requirement will only be forcibly
Expand Down
Loading