docs: document prebuilds quota group behavior (#28015)

Documents the behavior of the prebuilds quota group so admins can find
it and understand why the `prebuilds` user doesn't appear in its member
list.

Clarifies that prebuilt workspaces are attributed to a group named
`coderprebuiltworkspaces` (often referred to as the **Prebuilt
Workspaces** group), which defaults to a quota allowance of 0 and should
be adjusted to match the desired prebuild pool size. Adds a note that
the `prebuilds` user is a system user and is hidden from group member
listings in the dashboard and API.

> 🤖 This change was generated by Coder Agents (https://coder.com).
This commit is contained in:
Cian Johnston
2026-08-11 17:01:34 +01:00
committed by GitHub
parent 160964fc66
commit e5629126b7
@@ -265,11 +265,15 @@ Because unclaimed prebuilt workspaces are owned by the `prebuilds` user, you can
1. Configure quotas for any group that includes this user.
1. Set appropriate limits to balance prebuilt workspace availability with resource constraints.
When prebuilt workspaces are configured for an organization, Coder creates a "prebuilds" group in that organization and adds the prebuilds user to it. This group has a default quota allowance of 0, which you should adjust based on your needs:
When prebuilt workspaces are configured for an organization, Coder creates a group named `coderprebuiltworkspaces` (the **Prebuilt Workspaces** group) in that organization and adds the `prebuilds` user to it.
This group has a default quota allowance of 0, which you should adjust based on your needs:
- **Set a quota allowance** on the "prebuilds" group to control how many prebuilt workspaces can be provisioned
- **Monitor usage** to ensure the quota is appropriate for your desired number of prebuilt instances
- **Adjust as needed** based on your template costs and desired prebuilt workspace pool size
- **Set a Quota Allowance** on the `coderprebuiltworkspaces` group to control how many prebuilt workspaces can be provisioned.
- **Monitor usage** to ensure the quota is appropriate for your desired number of prebuilt instances.
- **Adjust as needed** based on your template costs and desired prebuilt workspace pool size.
> [!NOTE]
> The `prebuilds` user is a system user, so it does not appear in the group's member list in the Coder dashboard or API, even though it is a member.
If a quota is exceeded, the prebuilt workspace will fail provisioning the same way other workspaces do.