diff --git a/docs/admin/enterprise.md b/docs/admin/enterprise.md index 09e3e3c86c853..287be62a95010 100644 --- a/docs/admin/enterprise.md +++ b/docs/admin/enterprise.md @@ -5,10 +5,10 @@ Contact sales@coder.com to obtain a license. Our Enterprise-only features include: -- Audit Logging +- [Audit Logging](./audit-logs.md) - Browser Only Connections - Template RBAC -- Quotas +- [Quotas](./quotas.md) - High Availability ## Adding your license key diff --git a/docs/admin/quotas.md b/docs/admin/quotas.md new file mode 100644 index 0000000000000..e06567fe2b109 --- /dev/null +++ b/docs/admin/quotas.md @@ -0,0 +1,25 @@ +# Quotas + +
+Workspace Quotas are only available in the Enterprise Edition. +
+ +Coder Enterprise admins may define deployment-level quotas to protect against +Denial-of-Service, control costs, and ensure equitable access to cloud resources. + +The quota is enabled by either the `CODER_USER_WORKSPACE_QUOTA` +environment variable or the `--user-workspace-quota` flag. For example, +you may limit each user in a deployment to 5 workspaces like so: + +```bash +coder server --user-workspace-quota=5 +``` + +Then, when users create workspaces they would see: + + + +## Up next + +- [Enterprise](./enterprise.md) +- [Configuring](./configure.md) diff --git a/docs/images/admin/quotas.png b/docs/images/admin/quotas.png new file mode 100644 index 0000000000000..5149c9125b2ed Binary files /dev/null and b/docs/images/admin/quotas.png differ diff --git a/docs/images/icons/dollar.svg b/docs/images/icons/dollar.svg new file mode 100644 index 0000000000000..43cd6630651e6 --- /dev/null +++ b/docs/images/icons/dollar.svg @@ -0,0 +1 @@ + diff --git a/docs/manifest.json b/docs/manifest.json index d5f2c68c8ccb8..e9b3b332fcc45 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -186,7 +186,7 @@ }, { "title": "Configuration", - "description": "Learn how to configure Coder", + "description": "Learn how to configure Coder.", "path": "./admin/configure.md", "icon_path": "./images/icons/toggle_on.svg" }, @@ -202,6 +202,12 @@ "icon_path": "./images/icons/radar.svg", "path": "./admin/audit-logs.md" }, + { + "title": "Quotas", + "description": "Learn how to use Workspace Quotas in Coder.", + "icon_path": "./images/icons/dollar.svg", + "path": "./admin/quotas.md" + }, { "title": "Enterprise", "description": "Learn how to enable Enterprise features.", @@ -210,7 +216,7 @@ }, { "title": "Telemetry", - "description": "Learn what usage telemetry Coder collects", + "description": "Learn what usage telemetry Coder collects.", "icon_path": "./images/icons/science.svg", "path": "./admin/telemetry.md" }