Skip to content

Commit a6bb3b2

Browse files
authored
docs: add quotas (coder#4366)
1 parent db70307 commit a6bb3b2

File tree

5 files changed

+36
-4
lines changed

5 files changed

+36
-4
lines changed

docs/admin/enterprise.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Contact sales@coder.com to obtain a license.
55

66
Our Enterprise-only features include:
77

8-
- Audit Logging
8+
- [Audit Logging](./audit-logs.md)
99
- Browser Only Connections
1010
- Template RBAC
11-
- Quotas
11+
- [Quotas](./quotas.md)
1212
- High Availability
1313

1414
## Adding your license key

docs/admin/quotas.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Quotas
2+
3+
<blockquote class="info">
4+
Workspace Quotas are only available in the Enterprise Edition.
5+
</blockquote>
6+
7+
Coder Enterprise admins may define deployment-level quotas to protect against
8+
Denial-of-Service, control costs, and ensure equitable access to cloud resources.
9+
10+
The quota is enabled by either the `CODER_USER_WORKSPACE_QUOTA`
11+
environment variable or the `--user-workspace-quota` flag. For example,
12+
you may limit each user in a deployment to 5 workspaces like so:
13+
14+
```bash
15+
coder server --user-workspace-quota=5
16+
```
17+
18+
Then, when users create workspaces they would see:
19+
20+
<img src="../images/admin/quotas.png"/>
21+
22+
## Up next
23+
24+
- [Enterprise](./enterprise.md)
25+
- [Configuring](./configure.md)

docs/images/admin/quotas.png

791 KB
Loading

docs/images/icons/dollar.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/manifest.json

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
},
187187
{
188188
"title": "Configuration",
189-
"description": "Learn how to configure Coder",
189+
"description": "Learn how to configure Coder.",
190190
"path": "./admin/configure.md",
191191
"icon_path": "./images/icons/toggle_on.svg"
192192
},
@@ -202,6 +202,12 @@
202202
"icon_path": "./images/icons/radar.svg",
203203
"path": "./admin/audit-logs.md"
204204
},
205+
{
206+
"title": "Quotas",
207+
"description": "Learn how to use Workspace Quotas in Coder.",
208+
"icon_path": "./images/icons/dollar.svg",
209+
"path": "./admin/quotas.md"
210+
},
205211
{
206212
"title": "Enterprise",
207213
"description": "Learn how to enable Enterprise features.",
@@ -210,7 +216,7 @@
210216
},
211217
{
212218
"title": "Telemetry",
213-
"description": "Learn what usage telemetry Coder collects",
219+
"description": "Learn what usage telemetry Coder collects.",
214220
"icon_path": "./images/icons/science.svg",
215221
"path": "./admin/telemetry.md"
216222
}

0 commit comments

Comments
 (0)