opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-10-16 14:48:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: replace references to the retired Enterprise license tier (#30853)

Browse Source 
## Summary

Coder has only Community and Premium license tiers, but several docs
pages, CLI help strings, and SDK field comments still called features
"Enterprise" or "enterprise-only".
This PR changes them to say Premium and regenerates the reference docs
built from those strings.

Resolves
[DOCS-1298](https://linear.app/codercom/issue/DOCS-1298/remove-references-to-the-retired-enterprise-license-tier).

## Changes

- `docs/admin/users/quotas.md`: Replace "scoped to Groups in Enterprise
and organizations in Premium" with a correct sentence. Quotas are
Premium, allowances are set on groups, and each user's budget is
calculated separately in each organization (per
`GetQuotaAllowanceForUser`).
- `docs/user-guides/workspace-lifecycle.md`: Replace "Enterprise" with
Premium, and correct the quotas sentence to match the quotas page.
- `docs/ai-coder/agents/platform-controls/mcp-servers.md`: Replace
"enterprise entitlement" with Premium license.
- `cli/templatecreate.go`, `cli/templateedit.go`: Update
`--require-active-version`, `--allow-user-autostart`, and
`--allow-user-autostop` help text. Point the `--require-active-version`
help at the renamed `#template-update-policies` section, because the old
`#require-automatic-updates-enterprise` anchor is broken. Make the
errors for these flags tier-neutral.
- `enterprise/cli/features.go`: `coder features` now says "List license
features and entitlements", and its AGPL error no longer names a tier.
- `codersdk/templates.go`, `codersdk/organizations.go`: Update field
comments that feed the API reference and TypeScript types.
- `docs/reference/glossary.md`: The Premium entry now says "paid license
tier" instead of "paid enterprise tier".
- `docs/.style/style-guide/voice-and-tone.md`: The example sentence now
says "Premium licensing".
- Regenerated: CLI golden files, `docs/reference/cli/`,
`docs/manifest.json`, `docs/manifest/generated/cli.json`,
`docs/reference/api/`, `coderd/apidoc/`, and
`site/src/api/typesGenerated.ts`.

## Testing

- `go test ./cli -run 'TestCommandHelp|TestCliTemplateCreate'` and `go
test ./enterprise/cli -run
'TestEnterpriseCommandHelp|TestTemplateCreate|TestTemplateEdit|TestFeaturesList'`
pass.
- The pre-commit hook passed, including `make gen`, `fmt`, `lint/go`,
`lint/ts`, `lint/markdown`, and a slim build.

<details>
<summary>Decisions and out-of-scope items</summary>

### Decisions

- **Premium wording and legacy Enterprise licenses:** Coder still
accepts existing Enterprise licenses, and `FeatureSetEnterprise`
includes the features labeled Premium here. Docs and help text say
"Premium" because that is the tier sold today, and about 25 other docs
pages already use "Premium feature". Error strings are tier-neutral, so
they're accurate for every license holder.
- **Glossary and style guide:** The issue marked these as borderline.
Both were one-word changes, so I made them.

### Not changed

- `docs/reference/api/enterprise.md` keeps the "Enterprise" sidebar
title. It comes from the swagger tag on the `enterprise/` Go package, so
renaming it is a larger change.
- Other "Enterprise" references the review flagged as out of scope: the
`coder server --help` option group, quiet hours SDK comments, internal
`coderd` comments, and the dashboard's "Enterprise" badge on the
require-active-version option.
- No docs page says that legacy Enterprise licenses are still valid.
- Uses that don't refer to the license tier: GitHub Enterprise, Red Hat
Enterprise Linux, "enterprise environments", and `enterprise/` package
paths.

</details>

---

_This PR was generated by Coder Agents on behalf of @nickvigilante._
This commit is contained in:
Nick Vigilante
2026-10-15 17:46:05 +00:00
committed by GitHub
parent 4ae1b7bd28
commit c6a47c4428
28 changed files with 88 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cli/templatecreate.go
+3 -3
View File
@@ -52,7 +52,7 @@ func (r *RootCmd) templateCreate() *serpent.Command {
if isTemplateSchedulingOptionsSet || requireActiveVersion {
entitlements, err := client.Entitlements(inv.Context())
if cerr, ok := codersdk.AsError(err); ok && cerr.StatusCode() == http.StatusNotFound {
return xerrors.Errorf("your deployment appears to be an AGPL deployment, so you cannot set enterprise-only flags")
return xerrors.Errorf("your deployment appears to be an AGPL deployment, so you cannot set flags that require a license")
} else if err != nil {
return xerrors.Errorf("get entitlements: %w", err)
}
@@ -65,7 +65,7 @@ func (r *RootCmd) templateCreate() *serpent.Command {
if requireActiveVersion {
if !entitlements.Features[codersdk.FeatureAccessControl].Enabled {
return xerrors.Errorf("your license is not entitled to use enterprise access control, so you cannot set --require-active-version")
return xerrors.Errorf("your license is not entitled to use access control, so you cannot set --require-active-version")
}
}
}
@@ -245,7 +245,7 @@ func (r *RootCmd) templateCreate() *serpent.Command {
},
{
Flag: "require-active-version",
Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details.",
Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is a Premium feature. See https://coder.com/docs/admin/templates/managing-templates#template-update-policies for more details.",
Value: serpent.BoolOf(&requireActiveVersion),
Default: "false",
},
cli/templatecreate_test.go
+1 -1
View File
@@ -367,6 +367,6 @@ func TestCliTemplateCreate(t *testing.T) {
err := inv.Run()
require.Error(t, err)
require.Contains(t, err.Error(), "your deployment appears to be an AGPL deployment, so you cannot set enterprise-only flags")
require.Contains(t, err.Error(), "your deployment appears to be an AGPL deployment, so you cannot set flags that require a license")
})
}
cli/templateedit.go
+5 -5
View File
@@ -64,7 +64,7 @@ func (r *RootCmd) templateEdit() *serpent.Command {
if requiresEntitlement {
entitlements, err := client.Entitlements(inv.Context())
if cerr, ok := codersdk.AsError(err); ok && cerr.StatusCode() == http.StatusNotFound {
return xerrors.Errorf("your deployment appears to be an AGPL deployment, so you cannot set enterprise-only flags")
return xerrors.Errorf("your deployment appears to be an AGPL deployment, so you cannot set flags that require a license")
} else if err != nil {
return xerrors.Errorf("get entitlements: %w", err)
}
@@ -75,7 +75,7 @@ func (r *RootCmd) templateEdit() *serpent.Command {
if requireActiveVersion {
if !entitlements.Features[codersdk.FeatureAccessControl].Enabled {
return xerrors.Errorf("your license is not entitled to use enterprise access control, so you cannot set --require-active-version")
return xerrors.Errorf("your license is not entitled to use access control, so you cannot set --require-active-version")
}
}
}
@@ -311,19 +311,19 @@ func (r *RootCmd) templateEdit() *serpent.Command {
},
{
Flag: "allow-user-autostart",
Description: "Allow users to configure autostart for workspaces on this template. This can only be disabled in enterprise.",
Description: "Allow users to configure autostart for workspaces on this template. This can only be disabled with a Premium license.",
Default: "true",
Value: serpent.BoolOf(&allowUserAutostart),
},
{
Flag: "allow-user-autostop",
Description: "Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled in enterprise.",
Description: "Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled with a Premium license.",
Default: "true",
Value: serpent.BoolOf(&allowUserAutostop),
},
{
Flag: "require-active-version",
Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details.",
Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is a Premium feature. See https://coder.com/docs/admin/templates/managing-templates#template-update-policies for more details.",
Value: serpent.BoolOf(&requireActiveVersion),
Default: "false",
},
cli/testdata/coder_templates_create_--help.golden
Vendored
+3 -3
View File
@@ -56,9 +56,9 @@ OPTIONS:
--require-active-version bool (default: false)
Requires workspace builds to use the active template version. This
setting does not apply to template admins. This is an enterprise-only
feature. See
https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise
setting does not apply to template admins. This is a Premium feature.
See
https://coder.com/docs/admin/templates/managing-templates#template-update-policies
for more details.
--var string-array
cli/testdata/coder_templates_edit_--help.golden
Vendored
+5 -5
View File
@@ -19,11 +19,11 @@ OPTIONS:
--allow-user-autostart bool (default: true)
Allow users to configure autostart for workspaces on this template.
This can only be disabled in enterprise.
This can only be disabled with a Premium license.
--allow-user-autostop bool (default: true)
Allow users to customize the autostop TTL for workspaces on this
template. This can only be disabled in enterprise.
template. This can only be disabled with a Premium license.
--allow-user-cancel-workspace-jobs bool (default: true)
Allow users to cancel in-progress workspace jobs.
@@ -93,9 +93,9 @@ OPTIONS:
--require-active-version bool (default: false)
Requires workspace builds to use the active template version. This
setting does not apply to template admins. This is an enterprise-only
feature. See
https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise
setting does not apply to template admins. This is a Premium feature.
See
https://coder.com/docs/admin/templates/managing-templates#template-update-policies
for more details.
-y, --yes bool
coderd/apidoc/docs.go
Generated
+7 -7
View File
@@ -23889,11 +23889,11 @@ const docTemplate = `{
"type": "boolean"
},
"allow_user_autostart": {
"description": "AllowUserAutostart allows users to set a schedule for autostarting their\nworkspace. By default this is true. This can only be disabled when using\nan enterprise license.",
"description": "AllowUserAutostart allows users to set a schedule for autostarting their\nworkspace. By default this is true. This can only be disabled with a\nPremium license.",
"type": "boolean"
},
"allow_user_autostop": {
"description": "AllowUserAutostop allows users to set a custom workspace TTL to use in\nplace of the template's DefaultTTL field. By default this is true. If\nfalse, the DefaultTTL will always be used. This can only be disabled when\nusing an enterprise license.",
"description": "AllowUserAutostop allows users to set a custom workspace TTL to use in\nplace of the template's DefaultTTL field. By default this is true. If\nfalse, the DefaultTTL will always be used. This can only be disabled with a\nPremium license.",
"type": "boolean"
},
"allow_user_cancel_workspace_jobs": {
@@ -23905,7 +23905,7 @@ const docTemplate = `{
"type": "boolean"
},
"autostart_requirement": {
"description": "AutostartRequirement allows optionally specifying the autostart allowed days\nfor workspaces created from this template. This is an enterprise feature.",
"description": "AutostartRequirement allows optionally specifying the autostart allowed days\nfor workspaces created from this template. This is a Premium feature.",
"allOf": [
{
"$ref": "#/definitions/codersdk.TemplateAutostartRequirement"
@@ -23913,7 +23913,7 @@ const docTemplate = `{
]
},
"autostop_requirement": {
"description": "AutostopRequirement allows optionally specifying the autostop requirement\nfor workspaces created from this template. This is an enterprise feature.",
"description": "AutostopRequirement allows optionally specifying the autostop requirement\nfor workspaces created from this template. This is a Premium feature.",
"allOf": [
{
"$ref": "#/definitions/codersdk.TemplateAutostopRequirement"
@@ -30393,7 +30393,7 @@ const docTemplate = `{
"type": "boolean"
},
"allow_user_autostart": {
"description": "AllowUserAutostart and AllowUserAutostop are enterprise-only. Their\nvalues are only used if your license is entitled to use the advanced\ntemplate scheduling feature.",
"description": "AllowUserAutostart and AllowUserAutostop are Premium features. Their\nvalues are only used if your license is entitled to use the advanced\ntemplate scheduling feature.",
"type": "boolean"
},
"allow_user_autostop": {
@@ -30410,7 +30410,7 @@ const docTemplate = `{
"$ref": "#/definitions/codersdk.TemplateAutostartRequirement"
},
"autostop_requirement": {
"description": "AutostopRequirement and AutostartRequirement are enterprise features. Its\nvalue is only used if your license is entitled to use the advanced template\nscheduling feature.",
"description": "AutostopRequirement and AutostartRequirement are Premium features. Their\nvalues are only used if your license is entitled to use the advanced template\nscheduling feature.",
"allOf": [
{
"$ref": "#/definitions/codersdk.TemplateAutostopRequirement"
@@ -30457,7 +30457,7 @@ const docTemplate = `{
"type": "string"
},
"failure_ttl_ms": {
"description": "FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their\nvalues are used if your license is entitled to use the advanced\ntemplate scheduling feature.",
"description": "FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are Premium features. Their\nvalues are used if your license is entitled to use the advanced\ntemplate scheduling feature.",
"type": "integer"
},
"icon": {
coderd/apidoc/swagger.json
Generated
+7 -7
View File
@@ -21699,11 +21699,11 @@
"type": "boolean"
},
"allow_user_autostart": {
"description": "AllowUserAutostart allows users to set a schedule for autostarting their\nworkspace. By default this is true. This can only be disabled when using\nan enterprise license.",
"description": "AllowUserAutostart allows users to set a schedule for autostarting their\nworkspace. By default this is true. This can only be disabled with a\nPremium license.",
"type": "boolean"
},
"allow_user_autostop": {
"description": "AllowUserAutostop allows users to set a custom workspace TTL to use in\nplace of the template's DefaultTTL field. By default this is true. If\nfalse, the DefaultTTL will always be used. This can only be disabled when\nusing an enterprise license.",
"description": "AllowUserAutostop allows users to set a custom workspace TTL to use in\nplace of the template's DefaultTTL field. By default this is true. If\nfalse, the DefaultTTL will always be used. This can only be disabled with a\nPremium license.",
"type": "boolean"
},
"allow_user_cancel_workspace_jobs": {
@@ -21715,7 +21715,7 @@
"type": "boolean"
},
"autostart_requirement": {
"description": "AutostartRequirement allows optionally specifying the autostart allowed days\nfor workspaces created from this template. This is an enterprise feature.",
"description": "AutostartRequirement allows optionally specifying the autostart allowed days\nfor workspaces created from this template. This is a Premium feature.",
"allOf": [
{
"$ref": "#/definitions/codersdk.TemplateAutostartRequirement"
@@ -21723,7 +21723,7 @@
]
},
"autostop_requirement": {
"description": "AutostopRequirement allows optionally specifying the autostop requirement\nfor workspaces created from this template. This is an enterprise feature.",
"description": "AutostopRequirement allows optionally specifying the autostop requirement\nfor workspaces created from this template. This is a Premium feature.",
"allOf": [
{
"$ref": "#/definitions/codersdk.TemplateAutostopRequirement"
@@ -27963,7 +27963,7 @@
"type": "boolean"
},
"allow_user_autostart": {
"description": "AllowUserAutostart and AllowUserAutostop are enterprise-only. Their\nvalues are only used if your license is entitled to use the advanced\ntemplate scheduling feature.",
"description": "AllowUserAutostart and AllowUserAutostop are Premium features. Their\nvalues are only used if your license is entitled to use the advanced\ntemplate scheduling feature.",
"type": "boolean"
},
"allow_user_autostop": {
@@ -27980,7 +27980,7 @@
"$ref": "#/definitions/codersdk.TemplateAutostartRequirement"
},
"autostop_requirement": {
"description": "AutostopRequirement and AutostartRequirement are enterprise features. Its\nvalue is only used if your license is entitled to use the advanced template\nscheduling feature.",
"description": "AutostopRequirement and AutostartRequirement are Premium features. Their\nvalues are only used if your license is entitled to use the advanced template\nscheduling feature.",
"allOf": [
{
"$ref": "#/definitions/codersdk.TemplateAutostopRequirement"
@@ -28027,7 +28027,7 @@
"type": "string"
},
"failure_ttl_ms": {
"description": "FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their\nvalues are used if your license is entitled to use the advanced\ntemplate scheduling feature.",
"description": "FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are Premium features. Their\nvalues are used if your license is entitled to use the advanced\ntemplate scheduling feature.",
"type": "integer"
},
"icon": {
codersdk/organizations.go
+6 -6
View File
@@ -175,10 +175,10 @@ type CreateTemplateRequest struct {
// workspaces created from this template. Defaults to 0 (disabled).
TimeTilAutostopNotifyMillis *int64 `json:"time_til_autostop_notify_ms,omitempty"`
// AutostopRequirement allows optionally specifying the autostop requirement
// for workspaces created from this template. This is an enterprise feature.
// for workspaces created from this template. This is a Premium feature.
AutostopRequirement *TemplateAutostopRequirement `json:"autostop_requirement,omitempty"`
// AutostartRequirement allows optionally specifying the autostart allowed days
// for workspaces created from this template. This is an enterprise feature.
// for workspaces created from this template. This is a Premium feature.
AutostartRequirement *TemplateAutostartRequirement `json:"autostart_requirement,omitempty"`
// Allow users to cancel in-progress workspace jobs.
@@ -186,14 +186,14 @@ type CreateTemplateRequest struct {
AllowUserCancelWorkspaceJobs *bool `json:"allow_user_cancel_workspace_jobs"`
// AllowUserAutostart allows users to set a schedule for autostarting their
// workspace. By default this is true. This can only be disabled when using
// an enterprise license.
// workspace. By default this is true. This can only be disabled with a
// Premium license.
AllowUserAutostart *bool `json:"allow_user_autostart,omitempty"`
// AllowUserAutostop allows users to set a custom workspace TTL to use in
// place of the template's DefaultTTL field. By default this is true. If
// false, the DefaultTTL will always be used. This can only be disabled when
// using an enterprise license.
// false, the DefaultTTL will always be used. This can only be disabled with a
// Premium license.
AllowUserAutostop *bool `json:"allow_user_autostop,omitempty"`
// FailureTTLMillis allows optionally specifying the max lifetime before Coder
codersdk/templates.go
+4 -4
View File
@@ -39,22 +39,22 @@ type Template struct {
// autostop deadline at which a reminder notification is sent. 0 disables
// the notification.
TimeTilAutostopNotifyMillis int64 `json:"time_til_autostop_notify_ms"`
// AutostopRequirement and AutostartRequirement are enterprise features. Its
// value is only used if your license is entitled to use the advanced template
// AutostopRequirement and AutostartRequirement are Premium features. Their
// values are only used if your license is entitled to use the advanced template
// scheduling feature.
AutostopRequirement TemplateAutostopRequirement `json:"autostop_requirement"`
AutostartRequirement TemplateAutostartRequirement `json:"autostart_requirement"`
CreatedByID uuid.UUID `json:"created_by_id" format:"uuid"`
CreatedByName string `json:"created_by_name"`
// AllowUserAutostart and AllowUserAutostop are enterprise-only. Their
// AllowUserAutostart and AllowUserAutostop are Premium features. Their
// values are only used if your license is entitled to use the advanced
// template scheduling feature.
AllowUserAutostart bool `json:"allow_user_autostart"`
AllowUserAutostop bool `json:"allow_user_autostop"`
AllowUserCancelWorkspaceJobs bool `json:"allow_user_cancel_workspace_jobs"`
// FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their
// FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are Premium features. Their
// values are used if your license is entitled to use the advanced
// template scheduling feature.
FailureTTLMillis int64 `json:"failure_ttl_ms"`
docs/.style/style-guide/voice-and-tone.md
+1 -1
View File
@@ -52,7 +52,7 @@ Do not use first-person plural for:
**Do**:
> For more information about enterprise licensing, [contact us](https://coder.com/contact/sales).
> For more information about Premium licensing, [contact us](https://coder.com/contact/sales).
>
> Coder Technologies, Inc. publishes a new agent binary in each release.
>
docs/admin/users/quotas.md
+3 -2
View File
@@ -11,8 +11,9 @@ For example: A template is configured with a cost of 5 credits per day, and the
user is granted 15 credits, which can be consumed by both started and stopped
workspaces. This budget limits the user to 3 concurrent workspaces.
Quotas are scoped to [Groups](./groups-roles.md) in Enterprise and
[organizations](./organizations.md) in Premium.
Quotas are a Premium feature.
You grant quota allowances to [groups](./groups-roles.md), and Coder calculates
each user's budget separately in each [organization](./organizations.md).
## Definitions
docs/ai-coder/agents/platform-controls/mcp-servers.md
+2 -2
View File
@@ -257,8 +257,8 @@ can open **Server actions** > **Manage permissions** to remove the Everyone
entry and grant specific groups or users instead. They can also manage the ACL
through the API
(`GET`/`PATCH /api/v2/organizations/{organization}/mcp-servers/{id}/acl`).
ACL management is available in all editions and does not require an enterprise
entitlement. ACL changes are recorded in the audit log.
ACL management is available in all editions and does not require a Premium
license. ACL changes are recorded in the audit log.
Revoking access stops a member from newly selecting the server in any chat,
but chats that already have the server selected keep using it, the same way
docs/manifest.json
Generated
+1 -1
View File
@@ -1811,7 +1811,7 @@
},
{
"title": "`features`",
"description": "List Enterprise features",
"description": "List license features and entitlements",
"path": "reference/cli/features/index.md",
"children": [
{
docs/manifest/generated/cli.json
Generated
+1 -1
View File
@@ -109,7 +109,7 @@
},
{
"title": "`features`",
"description": "List Enterprise features",
"description": "List license features and entitlements",
"path": "reference/cli/features/index.md",
"children": [
{
docs/reference/api/schemas.md
Generated
+7 -7
View File
@@ -7089,12 +7089,12 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|---------------------------------------|--------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `activity_bump_ms` | integer | false | | Activity bump ms allows optionally specifying the activity bump duration for all workspaces created from this template. Defaults to 1h but can be set to 0 to disable activity bumping. |
| `agents_allowed` | boolean | false | | Agents allowed controls whether Coder Agents can create workspaces using this template. Defaults to true. |
| `allow_user_autostart` | boolean | false | | Allow user autostart allows users to set a schedule for autostarting their workspace. By default this is true. This can only be disabled when using an enterprise license. |
| `allow_user_autostop` | boolean | false | | Allow user autostop allows users to set a custom workspace TTL to use in place of the template's DefaultTTL field. By default this is true. If false, the DefaultTTL will always be used. This can only be disabled when using an enterprise license. |
| `allow_user_autostart` | boolean | false | | Allow user autostart allows users to set a schedule for autostarting their workspace. By default this is true. This can only be disabled with a Premium license. |
| `allow_user_autostop` | boolean | false | | Allow user autostop allows users to set a custom workspace TTL to use in place of the template's DefaultTTL field. By default this is true. If false, the DefaultTTL will always be used. This can only be disabled with a Premium license. |
| `allow_user_cancel_workspace_jobs` | boolean | false | | Allow users to cancel in-progress workspace jobs. *bool as the default value is "true". |
| `allow_workspace_renames` | boolean | false | | Allow workspace renames permits users to rename workspaces built from this template. Renaming can be destructive for templates whose Terraform references the workspace name, so this defaults to false. |
| `autostart_requirement` | [codersdk.TemplateAutostartRequirement](#codersdktemplateautostartrequirement) | false | | Autostart requirement allows optionally specifying the autostart allowed days for workspaces created from this template. This is an enterprise feature. |
| `autostop_requirement` | [codersdk.TemplateAutostopRequirement](#codersdktemplateautostoprequirement) | false | | Autostop requirement allows optionally specifying the autostop requirement for workspaces created from this template. This is an enterprise feature. |
| `autostart_requirement` | [codersdk.TemplateAutostartRequirement](#codersdktemplateautostartrequirement) | false | | Autostart requirement allows optionally specifying the autostart allowed days for workspaces created from this template. This is a Premium feature. |
| `autostop_requirement` | [codersdk.TemplateAutostopRequirement](#codersdktemplateautostoprequirement) | false | | Autostop requirement allows optionally specifying the autostop requirement for workspaces created from this template. This is a Premium feature. |
| `cors_behavior` | [codersdk.CORSBehavior](#codersdkcorsbehavior) | false | | Cors behavior allows optionally specifying the CORS behavior for all shared ports. |
| `default_ttl_ms` | integer | false | | Default ttl ms allows optionally specifying the default TTL for all workspaces created from this template. |
| `delete_ttl_ms` | integer | false | | Delete ttl ms allows optionally specifying the max lifetime before Coder permanently deletes dormant workspaces created from this template. |
@@ -14975,12 +14975,12 @@ Git clone makes use of this by parsing the URL from: 'Username for "https://gith
| `active_version_id` | string | false | | |
| `activity_bump_ms` | integer | false | | |
| `agents_allowed` | boolean | false | | |
| `allow_user_autostart` | boolean | false | | Allow user autostart and AllowUserAutostop are enterprise-only. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
| `allow_user_autostart` | boolean | false | | Allow user autostart and AllowUserAutostop are Premium features. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
| `allow_user_autostop` | boolean | false | | |
| `allow_user_cancel_workspace_jobs` | boolean | false | | |
| `allow_workspace_renames` | boolean | false | | Allow workspace renames permits users to rename workspaces built from this template. Renaming can be destructive for templates whose Terraform references the workspace name. |
| `autostart_requirement` | [codersdk.TemplateAutostartRequirement](#codersdktemplateautostartrequirement) | false | | |
| `autostop_requirement` | [codersdk.TemplateAutostopRequirement](#codersdktemplateautostoprequirement) | false | | Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature. |
| `autostop_requirement` | [codersdk.TemplateAutostopRequirement](#codersdktemplateautostoprequirement) | false | | Autostop requirement and AutostartRequirement are Premium features. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
| `build_time_stats` | [codersdk.TemplateBuildTimeStats](#codersdktemplatebuildtimestats) | false | | |
| `cors_behavior` | [codersdk.CORSBehavior](#codersdkcorsbehavior) | false | | |
| `created_at` | string | false | | |
@@ -14993,7 +14993,7 @@ Git clone makes use of this by parsing the URL from: 'Username for "https://gith
| `description` | string | false | | |
| `disable_module_cache` | boolean | false | | Disable module cache disables the use of cached Terraform modules during provisioning for this template. It is read-only while ModuleCacheDisabledByDeployment is true. |
| `display_name` | string | false | | |
| `failure_ttl_ms` | integer | false | | Failure ttl ms TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their values are used if your license is entitled to use the advanced template scheduling feature. |
| `failure_ttl_ms` | integer | false | | Failure ttl ms TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are Premium features. Their values are used if your license is entitled to use the advanced template scheduling feature. |
| `icon` | string | false | | |
| `id` | string | false | | |
| `max_port_share_level` | [codersdk.WorkspaceAgentPortShareLevel](#codersdkworkspaceagentportsharelevel) | false | | |
docs/reference/api/templates.md
Generated
+6 -6
View File
@@ -113,13 +113,13 @@ Status Code **200**
| `» active_version_id` | string(uuid) | false | | |
| `» activity_bump_ms` | integer | false | | |
| `» agents_allowed` | boolean | false | | |
| `» allow_user_autostart` | boolean | false | | Allow user autostart and AllowUserAutostop are enterprise-only. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
| `» allow_user_autostart` | boolean | false | | Allow user autostart and AllowUserAutostop are Premium features. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
| `» allow_user_autostop` | boolean | false | | |
| `» allow_user_cancel_workspace_jobs` | boolean | false | | |
| `» allow_workspace_renames` | boolean | false | | Allow workspace renames permits users to rename workspaces built from this template. Renaming can be destructive for templates whose Terraform references the workspace name. |
| `» autostart_requirement` | [codersdk.TemplateAutostartRequirement](schemas.md#codersdktemplateautostartrequirement) | false | | |
| `»» days_of_week` | array | false | | Days of week is a list of days of the week in which autostart is allowed to happen. If no days are specified, autostart is not allowed. |
| `» autostop_requirement` | [codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement) | false | | Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature. |
| `» autostop_requirement` | [codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement) | false | | Autostop requirement and AutostartRequirement are Premium features. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
|`»» days_of_week`|array|false||Days of week is a list of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required. Weekdays cannot be specified twice.
Restarts will only happen on weekdays in this list on weeks which line up with Weeks.|
|`»» weeks`|integer|false||Weeks is the number of weeks between required restarts. Weeks are synced across all workspaces (and Coder deployments) using modulo math on a hardcoded epoch week of January 2nd, 2023 (the first Monday of 2023). Values of 0 or 1 indicate weekly restarts. Values of 2 indicate fortnightly restarts, etc.|
@@ -138,7 +138,7 @@ Restarts will only happen on weekdays in this list on weeks which line up with W
|`» description`|string|false|||
|`» disable_module_cache`|boolean|false||Disable module cache disables the use of cached Terraform modules during provisioning for this template. It is read-only while ModuleCacheDisabledByDeployment is true.|
|`» display_name`|string|false|||
|`» failure_ttl_ms`|integer|false||Failure ttl ms TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their values are used if your license is entitled to use the advanced template scheduling feature.|
|`» failure_ttl_ms`|integer|false||Failure ttl ms TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are Premium features. Their values are used if your license is entitled to use the advanced template scheduling feature.|
|`» icon`|string|false|||
|`» id`|string(uuid)|false|||
|`» max_port_share_level`|[codersdk.WorkspaceAgentPortShareLevel](schemas.md#codersdkworkspaceagentportsharelevel)|false|||
@@ -892,13 +892,13 @@ Status Code **200**
| `» active_version_id` | string(uuid) | false | | |
| `» activity_bump_ms` | integer | false | | |
| `» agents_allowed` | boolean | false | | |
| `» allow_user_autostart` | boolean | false | | Allow user autostart and AllowUserAutostop are enterprise-only. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
| `» allow_user_autostart` | boolean | false | | Allow user autostart and AllowUserAutostop are Premium features. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
| `» allow_user_autostop` | boolean | false | | |
| `» allow_user_cancel_workspace_jobs` | boolean | false | | |
| `» allow_workspace_renames` | boolean | false | | Allow workspace renames permits users to rename workspaces built from this template. Renaming can be destructive for templates whose Terraform references the workspace name. |
| `» autostart_requirement` | [codersdk.TemplateAutostartRequirement](schemas.md#codersdktemplateautostartrequirement) | false | | |
| `»» days_of_week` | array | false | | Days of week is a list of days of the week in which autostart is allowed to happen. If no days are specified, autostart is not allowed. |
| `» autostop_requirement` | [codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement) | false | | Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature. |
| `» autostop_requirement` | [codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement) | false | | Autostop requirement and AutostartRequirement are Premium features. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
|`»» days_of_week`|array|false||Days of week is a list of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required. Weekdays cannot be specified twice.
Restarts will only happen on weekdays in this list on weeks which line up with Weeks.|
|`»» weeks`|integer|false||Weeks is the number of weeks between required restarts. Weeks are synced across all workspaces (and Coder deployments) using modulo math on a hardcoded epoch week of January 2nd, 2023 (the first Monday of 2023). Values of 0 or 1 indicate weekly restarts. Values of 2 indicate fortnightly restarts, etc.|
@@ -917,7 +917,7 @@ Restarts will only happen on weekdays in this list on weeks which line up with W
|`» description`|string|false|||
|`» disable_module_cache`|boolean|false||Disable module cache disables the use of cached Terraform modules during provisioning for this template. It is read-only while ModuleCacheDisabledByDeployment is true.|
|`» display_name`|string|false|||
|`» failure_ttl_ms`|integer|false||Failure ttl ms TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their values are used if your license is entitled to use the advanced template scheduling feature.|
|`» failure_ttl_ms`|integer|false||Failure ttl ms TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are Premium features. Their values are used if your license is entitled to use the advanced template scheduling feature.|
|`» icon`|string|false|||
|`» id`|string(uuid)|false|||
|`» max_port_share_level`|[codersdk.WorkspaceAgentPortShareLevel](schemas.md#codersdkworkspaceagentportsharelevel)|false|||
docs/reference/cli/features/index.md
Generated
+2 -2
View File
@@ -1,12 +1,12 @@
---
# Code generated by make gen. DO NOT EDIT.
title: "`coder features`"
description: List Enterprise features
description: List license features and entitlements
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
List Enterprise features
List license features and entitlements
Aliases:
docs/reference/cli/index.md
Generated
+1 -1
View File
@@ -76,7 +76,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
| [<code>ai-gateway</code>](./ai-gateway/index.md) | Manage AI Gateway |
| [<code>agent-firewall</code>](./agent-firewall.md) | Network isolation tool for monitoring and restricting HTTP/HTTPS requests |
| [<code>workspace-proxy</code>](./workspace-proxy/index.md) | Workspace proxies provide low-latency experiences for geo-distributed teams. |
| [<code>features</code>](./features/index.md) | List Enterprise features |
| [<code>features</code>](./features/index.md) | List license features and entitlements |
| [<code>licenses</code>](./licenses/index.md) | Add, delete, and list licenses |
| [<code>groups</code>](./groups/index.md) | Manage groups |
| [<code>prebuilds</code>](./prebuilds/index.md) | Manage Coder prebuilds |
docs/reference/cli/templates/create.md
Generated
+1 -1
View File
@@ -108,7 +108,7 @@ Specify a duration workspaces may be in the dormant state prior to being deleted
| Type | <code>bool</code> |
| Default | <code>false</code> |
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details.
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is a Premium feature. See https://coder.com/docs/admin/templates/managing-templates#template-update-policies for more details.
### -y, --yes
docs/reference/cli/templates/edit.md
Generated
+3 -3
View File
@@ -156,7 +156,7 @@ Allow users to cancel in-progress workspace jobs.
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow users to configure autostart for workspaces on this template. This can only be disabled in enterprise.
Allow users to configure autostart for workspaces on this template. This can only be disabled with a Premium license.
### --allow-user-autostop
@@ -165,7 +165,7 @@ Allow users to configure autostart for workspaces on this template. This can onl
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled in enterprise.
Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled with a Premium license.
### --require-active-version
@@ -174,7 +174,7 @@ Allow users to customize the autostop TTL for workspaces on this template. This
| Type | <code>bool</code> |
| Default | <code>false</code> |
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details.
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is a Premium feature. See https://coder.com/docs/admin/templates/managing-templates#template-update-policies for more details.
### --private
docs/reference/glossary.md
+1 -1
View File
@@ -418,7 +418,7 @@ Refer to [Prebuilt workspaces](../admin/templates/extending-templates/prebuilt-w
### Premium
The paid enterprise tier, which unlocks features such as multi-organization support, high availability, workspace proxies, audit logs, quotas, custom roles, SCIM, and IdP sync.
The paid license tier, which unlocks features such as multi-organization support, high availability, workspace proxies, audit logs, quotas, custom roles, SCIM, and IdP sync.
Visit [Pricing](https://coder.com/pricing).
### Prometheus metrics
docs/user-guides/workspace-lifecycle.md
+2 -2
View File
@@ -34,7 +34,7 @@ If some error occurs during the above, a workspace may fall into one of the foll
Workspaces are created from [templates](../admin/templates/index.md) via the CLI, API, or dashboard.
By default, there is no limit on the number of workspaces a user may create, regardless of the template's resource demands.
Enterprise administrators may limit the number of workspaces per template, group, and organization using [quotas](../admin/users/quotas.md) to prevent over provisioning and control costs.
On Premium deployments, administrators can use [quotas](../admin/users/quotas.md) to limit each user's workspace spend in each organization, which prevents over provisioning and controls costs.
When a user creates a workspace, they're sending a build request to the control plane.
Coder takes this and uses [Terraform](https://www.terraform.io/) to provision a workspace defined by your [template](../admin/templates/index.md).
@@ -70,7 +70,7 @@ Similarly to stopping, workspaces may be deleted manually or automatically by Co
A delete workspace build runs `terraform destroy`, destroying both persistent and ephemeral resources.
This action can not be reverted.
When enabled on enterprise deployments, workspaces will become dormant after a specified duration of inactivity.
When enabled on Premium deployments, workspaces will become dormant after a specified duration of inactivity.
Then, if left dormant, the workspaces will be queued for deletion.
Learn about configuring workspace dormancy in the template scheduling docs.
enterprise/cli/features.go
+2 -2
View File
@@ -17,7 +17,7 @@ import (
func (r *RootCmd) features() *serpent.Command {
cmd := &serpent.Command{
Short: "List Enterprise features",
Short: "List license features and entitlements",
Use: "features",
Aliases: []string{"feature"},
Handler: func(inv *serpent.Invocation) error {
@@ -49,7 +49,7 @@ func (r *RootCmd) featuresList() *serpent.Command {
entitlements, err := client.Entitlements(inv.Context())
var apiError *codersdk.Error
if errors.As(err, &apiError) && apiError.StatusCode() == http.StatusNotFound {
return xerrors.New("You are on the AGPL licensed version of Coder that does not have Enterprise functionality!")
return xerrors.New("You are on the AGPL licensed version of Coder, which does not support licensed features.")
}
if err != nil {
return err
enterprise/cli/templatecreate_test.go
+1 -1
View File
@@ -132,7 +132,7 @@ func TestTemplateCreate(t *testing.T) {
err := inv.Run()
require.Error(t, err)
require.Contains(t, err.Error(), "your license is not entitled to use enterprise access control, so you cannot set --require-active-version")
require.Contains(t, err.Error(), "your license is not entitled to use access control, so you cannot set --require-active-version")
})
// Create a template in a second organization via custom role
enterprise/cli/templateedit_test.go
+1 -1
View File
@@ -86,7 +86,7 @@ func TestTemplateEdit(t *testing.T) {
err := inv.Run()
require.Error(t, err)
require.Contains(t, err.Error(), "your license is not entitled to use enterprise access control, so you cannot set --require-active-version")
require.Contains(t, err.Error(), "your license is not entitled to use access control, so you cannot set --require-active-version")
})
t.Run("WorkspaceCleanup", func(t *testing.T) {
enterprise/cli/testdata/coder_--help.golden
Vendored
+1 -1
View File
@@ -18,7 +18,7 @@ SUBCOMMANDS:
HTTP/HTTPS requests
ai-gateway Manage AI Gateway
external-workspaces Create or manage external workspaces
features List Enterprise features
features List license features and entitlements
groups Manage groups
licenses Add, delete, and list licenses
prebuilds Manage Coder prebuilds
enterprise/cli/testdata/coder_features_--help.golden
Vendored
+1 -1
View File
@@ -3,7 +3,7 @@ coder v0.0.0-devel
USAGE:
coder features
List Enterprise features
List license features and entitlements
Aliases: feature
site/src/api/typesGenerated.ts
Generated
+10 -10
View File
@@ -4504,12 +4504,12 @@ export interface CreateTemplateRequest {
readonly time_til_autostop_notify_ms?: number;
/**
* AutostopRequirement allows optionally specifying the autostop requirement
* for workspaces created from this template. This is an enterprise feature.
* for workspaces created from this template. This is a Premium feature.
*/
readonly autostop_requirement?: TemplateAutostopRequirement;
/**
* AutostartRequirement allows optionally specifying the autostart allowed days
* for workspaces created from this template. This is an enterprise feature.
* for workspaces created from this template. This is a Premium feature.
*/
readonly autostart_requirement?: TemplateAutostartRequirement;
/**
@@ -4519,15 +4519,15 @@ export interface CreateTemplateRequest {
readonly allow_user_cancel_workspace_jobs: boolean | null;
/**
* AllowUserAutostart allows users to set a schedule for autostarting their
* workspace. By default this is true. This can only be disabled when using
* an enterprise license.
* workspace. By default this is true. This can only be disabled with a
* Premium license.
*/
readonly allow_user_autostart?: boolean;
/**
* AllowUserAutostop allows users to set a custom workspace TTL to use in
* place of the template's DefaultTTL field. By default this is true. If
* false, the DefaultTTL will always be used. This can only be disabled when
* using an enterprise license.
* false, the DefaultTTL will always be used. This can only be disabled with a
* Premium license.
*/
readonly allow_user_autostop?: boolean;
/**
@@ -9957,8 +9957,8 @@ export interface Template {
*/
readonly time_til_autostop_notify_ms: number;
/**
* AutostopRequirement and AutostartRequirement are enterprise features. Its
* value is only used if your license is entitled to use the advanced template
* AutostopRequirement and AutostartRequirement are Premium features. Their
* values are only used if your license is entitled to use the advanced template
* scheduling feature.
*/
readonly autostop_requirement: TemplateAutostopRequirement;
@@ -9966,7 +9966,7 @@ export interface Template {
readonly created_by_id: string;
readonly created_by_name: string;
/**
* AllowUserAutostart and AllowUserAutostop are enterprise-only. Their
* AllowUserAutostart and AllowUserAutostop are Premium features. Their
* values are only used if your license is entitled to use the advanced
* template scheduling feature.
*/
@@ -9974,7 +9974,7 @@ export interface Template {
readonly allow_user_autostop: boolean;
readonly allow_user_cancel_workspace_jobs: boolean;
/**
* FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their
* FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are Premium features. Their
* values are used if your license is entitled to use the advanced
* template scheduling feature.
*/