mirror of
https://github.com/coder/coder.git
synced 2026-11-03 05:55:24 +08:00
Nick Vigilante
c84aa564ba
Normalizes non-standard code-fence language tags across `docs/**` so a strict highlighter (Shiki, used by Fumadocs) won't fail the build on an unrecognized language, and unifies redundant synonym tags onto one canonical form per language. The current renderer (Speed-Highlight) detects the language from the code content, not the fence label, so this drift wasn't visible until now. ## Changes - `hcl` -> `tf` (199 fences, including indented ones nested in numbered/bulleted lists). Shiki ships `hcl` and `terraform` as two distinct grammars (not aliases); every `hcl`-tagged fence in `docs/**` is actually Terraform resource/data/provider syntax, so the more specific `terraform` grammar is correct for all of them. `tf` is Shiki's own alias for that grammar, and it's also what GitHub's own markdown renderer resolves to the same HCL/Terraform highlighting. - `pwsh`/`powershell` -> `ps1`. Both `ps` and `ps1` are registered PowerShell aliases in Shiki, but on GitHub's renderer only `.ps1` is a registered file extension (`.ps` isn't), so `ps1` renders identically to `powershell` there today while bare `ps` would silently lose highlighting. - `env` -> `dotenv` (a dedicated Shiki grammar for `KEY=VALUE` files) - `text`/`output`/`none`/`url` -> `txt`. Same built-in plain-text fallback either way, just shorter. - `Dockerfile` -> `dockerfile` (lowercase) - `bash`/`shell` -> `sh` (732 fences). Shiki and GitHub both alias all three to a single shell grammar; this was already the style guide's stated preference, just not enforced across the existing corpus until now. - `markdown` -> `md` (4 fences). Alias of the same grammar in both Shiki and GitHub. - `jsonc` -> `json` (1 fence). The block has no comments or trailing commas, so it doesn't need the comments-capable grammar. - `ts` -> `tsx` (2 fences, `docs/about/contributing/frontend.md`). Verified the actual content tokenizes identically under both grammars, and a sibling block in the same file already needs `tsx` for real JSX, so unifying to one tag is safe for this file. Documented a caveat: `tsx` mis-tokenizes the legacy angle-bracket type-assertion syntax (`<Type>value`), which is invalid in real `.tsx` files anyway, so use `value as Type` instead. - `yml` -> `yaml` (1 fence) - Updated `docs/.style/style-guide/formatting.md` to document all canonical tags `promql` (2 fences) and `caddyfile` (2 fences) are left as-is. Shiki doesn't bundle a grammar for either, so they need a custom grammar registration when the site adopts Shiki, rather than degrading to `txt`. Tracked as follow-up work under DOCS-118 and [DOCS-544](https://linear.app/codercom/issue/DOCS-544/vendor-a-local-promql-grammar-for-shiki-syntax-highlighting) (promql). Does not touch `offlinedocs/`. Linear: [DOCS-476](https://linear.app/codercom/issue/DOCS-476/normalize-docs-code-fence-languages-de-risk-shikifumadocs) <details> <summary>How the fence tags were verified</summary> Each tag was tested against a real `shiki@latest` highlighter instance (`codeToHtml`/`codeToTokens`) and cross-checked against GitHub's `@wooorm/starry-night` grammar sources (the renderer that actually displays these `.md` files today, in repo browsing and PR diffs), since that's what determines whether brevity is safe before Shiki adoption: ```text FAIL env -- Language `env` is not included in this bundle. FAIL Dockerfile -- Language `Dockerfile` is not included in this bundle. FAIL promql -- Language `promql` is not included in this bundle. FAIL caddyfile -- Language `caddyfile` is not included in this bundle. FAIL pwsh -- Language `pwsh` is not included in this bundle. FAIL output -- Language `output` is not included in this bundle. ``` `hcl` doesn't error in Shiki, since it's a real grammar, but that's exactly the trap: it was silently rendering every fence with the generic HCL grammar instead of the Terraform-specific one. Every `hcl`-tagged fence in `docs/**` was manually checked against `origin/main` and is genuinely Terraform content. For `ts`/`tsx`, tokenizing the actual doc content confirmed identical output under both grammars; a synthetic test with the legacy angle-bracket cast syntax confirmed `tsx` degrades on that specific construct, which the style guide now calls out. The first normalization pass only matched fence tags at column 0 (`^```tag$`), missing tags indented inside numbered/bulleted lists. A follow-up pass caught the remaining occurrences at any indentation level. </details> --- *This PR description and the underlying changes were prepared with Coder Agents assistance.*
108 lines
3.6 KiB
Markdown
108 lines
3.6 KiB
Markdown
# Quotas
|
|
|
|
Quotas are a mechanism for controlling spend by associating costs with workspace
|
|
templates and assigning budgets to users. Users that exceed their budget will be
|
|
blocked from launching more workspaces until they either delete their other
|
|
workspaces or get their budget extended.
|
|
|
|
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.
|
|
|
|
## Definitions
|
|
|
|
- **Credits** is the fundamental unit representing cost in the quota system.
|
|
This integer can be arbitrary, or it can map to your preferred currency.
|
|
- **Budget** is the per-user, enforced, upper limit to credit spend.
|
|
- **Allowance** is a grant of credits to the budget.
|
|
|
|
## Establishing Costs
|
|
|
|
Templates describe their cost through the `daily_cost` attribute in
|
|
[`resource_metadata`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/metadata).
|
|
Since costs are associated with resources, an offline workspace may consume less
|
|
quota than an online workspace.
|
|
|
|
A common use case is separating costs for a persistent volume and ephemeral
|
|
compute:
|
|
|
|
```tf
|
|
resource "docker_volume" "home_volume" {
|
|
name = "coder-${data.coder_workspace_owner.me.name}-${data.coder_workspace.me.name}-root"
|
|
}
|
|
|
|
resource "coder_metadata" "home_volume" {
|
|
resource_id = docker_volume.home_volume.id
|
|
daily_cost = 10
|
|
}
|
|
|
|
resource "docker_container" "workspace" {
|
|
count = data.coder_workspace.me.start_count
|
|
image = "codercom/code-server:latest"
|
|
...
|
|
volumes {
|
|
container_path = "/home/coder/"
|
|
volume_name = docker_volume.home_volume.name
|
|
read_only = false
|
|
}
|
|
}
|
|
|
|
resource "coder_metadata" "workspace" {
|
|
count = data.coder_workspace.me.start_count
|
|
resource_id = docker_container.workspace.id
|
|
daily_cost = 20
|
|
}
|
|
```
|
|
|
|
When the workspace above is shut down, the `docker_container` and
|
|
`coder_metadata` both get deleted. This reduces the cost from 30 credits to 10
|
|
credits.
|
|
|
|
Resources without a `daily_cost` value are considered to cost 0. If the cost was
|
|
removed on the `docker_volume` above, the template would consume 0 credits when
|
|
it's offline. This technique is good for incentivizing users to shut down their
|
|
unused workspaces and freeing up compute in the cluster.
|
|
|
|
## Establishing Budgets
|
|
|
|
Each group has a configurable Quota Allowance. A user's budget is calculated as
|
|
the sum of their allowances.
|
|
|
|
|
|
|
|
For example:
|
|
|
|
| Group Name | Quota Allowance |
|
|
|------------|-----------------|
|
|
| Frontend | 10 |
|
|
| Backend | 20 |
|
|
| Data | 30 |
|
|
|
|
<br/>
|
|
|
|
| Username | Groups | Effective Budget |
|
|
|----------|-------------------|------------------|
|
|
| jill | Frontend, Backend | 30 |
|
|
| jack | Backend, Data | 50 |
|
|
| sam | Data | 30 |
|
|
| alex | Frontend | 10 |
|
|
|
|
By default, groups are assumed to have a default allowance of 0.
|
|
|
|
## Quota Enforcement
|
|
|
|
Coder enforces Quota on workspace start and stop operations. The workspace build
|
|
process dynamically calculates costs, so quota violation fails builds as opposed
|
|
to failing the build-triggering operation. For example, the Workspace Create
|
|
Form will never get held up by quota enforcement.
|
|
|
|
|
|
|
|
## Up next
|
|
|
|
- [Group Sync](./idp-sync.md)
|
|
- [Control plane configuration](../setup/index.md)
|