Skip to content

docs: add quotas #4366

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.

Sign up for GitHub

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 2 commits into from
Oct 4, 2022
Merged

docs: add quotas #4366

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e666fc7
docs: add quotas
ammario Oct 4, 2022
368e4be
fixup! docs: add quotas
ammario Oct 4, 2022
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
4 changes: 2 additions & 2 deletions docs/admin/enterprise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
25 changes: 25 additions & 0 deletions docs/admin/quotas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Quotas

<blockquote class="info">
Workspace Quotas are an Enterprise Edition only feature.
</blockquote>

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:

<img src="../images/admin/quotas.png"/>

## Up next

- [Enterprise](./enterprise.md)
- [Configuring](./configure.md)
Binary file added docs/images/admin/quotas.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.
1 change: 1 addition & 0 deletions docs/images/icons/dollar.svg
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: 8 additions & 2 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand All @@ -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.",
Expand All @@ -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"
}
Expand Down