Files
coder/docs/tutorials/persistent-shared-workspaces.md
T
Nick Vigilante 16551fd67f feat: enable Coder.AbbreviationFirstUse (#30878)
Adds `Coder.AbbreviationFirstUse`, a Vale rule that requires each
abbreviation to be expanded on its first use on a page, in the form
"Expanded Form (ABBR)". It supports [WCAG 2.2 Level AAA Success
Criterion 3.1.4
(Abbreviations)](https://www.w3.org/TR/WCAG22/#abbreviations). Following
the "Adding a Vale rule" pattern in `docs/.style/README.md`, the PR has
two commits: the cleanup first, then the enable.

## Cleanup commit

431 first uses expanded across 167 pages, so the rule ships with zero
findings across `docs/`, excluding `docs/.style/style-guide/`. The
branch was rebuilt on current `main`, so pages added or moved since the
first draft are covered.

- Where the first use is a bold UI label (**CA Path**, **Add redirect
URI**, **Redirect URI**), the label stays as the UI shows it and the
expansion goes elsewhere in the same paragraph or list item.
- Reversed forms such as "PKCE (Proof Key for Code Exchange)" are
flipped to the expanded-first form.
- A few sentences took a small rewording to fit the expansion: list
steps that would pass the 20-word limit (`Coder.StepLength`), and spots
where the expansion would nest parentheses.
- MITM is expanded as "machine-in-the-middle" rather than
"man-in-the-middle". Every use describes the AI Gateway Proxy
intercepting traffic on purpose, so "on-path attacker" doesn't fit. The
inclusive-language table on `accessibility-and-inclusion.md` gains the
substitution: "on-path attacker" for the attack, "machine-in-the-middle"
for the feature.
- Unrelated fixes on lines already being edited: `DERP MAP` → `DERP
map`, and `ENV` → "environment variable" in `faqs.md`.

## Enable commit

**Rule design.** The rule is a `conditional`. `first` matches 2 to 6
capitals, each optionally followed by digits (`EC2`, `P2P`), and a
lookahead lets a plural `s` count as a use of the singular. `second`
captures the abbreviation in `word (ABBR)`, including `(CI/CD)` and
`(PCI DSS)` pairs. Vale collects the captures across the page's blocks
in document order, so a later expansion doesn't cover an earlier use.
Within a single paragraph, list item, or table cell, an expansion
anywhere in the block counts.

**Scope.** `scope: ~heading` skips headings, because a page title often
names an abbreviation that the first paragraph then expands. Vale
already skips front matter, code blocks, inline code, and link URLs.
`.vale.ini` turns the rule off for the pages generated from Go source
that `Coder.UnitSpacing` already skips: `docs/reference/{api,cli}/*.md`,
`configuration-reference.md`, and `prometheus.md`.

**Severity: `warning`.** Whether an abbreviation is familiar enough to
skip is a judgment call, so this is guidance with legitimate exceptions,
not hard policy.

**Exceptions**, each group commented in the rule file:

| Group | Entries | Reason |
| --- | --- | --- |
| Known to every reader | AI, API, AWS, CLI, CPU, DNS, GCP, HTTP(S), ID,
IDE, IP, JSON, OS, PR, RAM, SDK, SQL, SSH, TLS, UI, URL, VM, YAML |
Abbreviations every reader of the docs knows. Plurals such as VMs and
SDKs pass too |
| Units, clock times, file and package formats | GB, KB, MB, AM, PM,
CSV, GIF, JPEG, PDF, PNG, RPM, SVG, VSIX, ZIP | Readers know these by
the abbreviation, not the expansion |
| Not abbreviations | NOTE, TIP, OK, README, SKILL, ALL, AND, ANY,
ERROR, MUST, NOT, ON, OR, DELETE, GET, POST, PUT, ILIKE, VACUUM, LOGIN,
PLAIN, NUL, CRON, TERM, DOCS, `DOC\d+`, `RFC\d+`, TL, DR | Alert labels,
file names, emphasis in capitals, HTTP methods, SQL keywords, SMTP auth
mechanisms, rule labels in `docs/AGENTS.md`, RFC numbers, TL;DR |
| Names written in capitals | VS, IDEA, IU, NGINX, SUSE, GNU, XFCE, DX,
IBM, DCV, TRAMP, MSYS2, NET, VSX, ARM, AMD, GPT, AES, GCM, HMAC, HS256,
RSA, SHA, SHA256 | The capitals are the product, company, or algorithm
name (VS Code, IntelliJ IDEA, .NET, Open VSX, Amazon DCV, AMD) |

The "known to every reader" group is the list that needs judgment, and
it's the one to push back on. The other groups only stop the regex from
treating words and names as abbreviations.

**Documentation.** A new "Expand abbreviations on first use" section on
`accessibility-and-inclusion.md`, and the style guide README's checks
table, coverage table, and rule counts (90 → 91 rules, 22 → 23
tool-checked).

## Known limits

- The rule checks that an expansion exists, not that it's correct: any
word followed by `(ABBR)` satisfies it.
- An abbreviation in an image's alt text is checked before the paragraph
around it, so one alt text (`aws-marketplace.md`) carries its own
expansion.
- Some expansions read heavily in dense table cells and inline lists,
for example the four Kubernetes services in `docker-in-workspaces.md`.
They're correct, but a reviewer may prefer adding a specific
abbreviation to the exceptions instead.

## Testing

- `vale docs/` (Vale 3.7.1 through mise): zero
`Coder.AbbreviationFirstUse` findings. Findings from every other rule
match `main` file for file.
- `pnpm run format-docs`, `pnpm run lint-docs`,
`scripts/check_emdash.sh`, and `make lint/prose` run clean, and the
repository pre-commit hooks (including `lint/style-claims`) pass on both
commits.

Linear: DOCS-1311

Generated by Coder Agents on behalf of @nickvigilante.
2026-11-02 14:41:15 -05:00

237 lines
9.0 KiB
Markdown

---
title: Persistent shared workspaces with service accounts
---
> [!NOTE]
> This guide requires a [Premium license](https://coder.com/pricing#compare-plans) because service accounts are a Premium feature.
> For more details, [contact your account team](https://coder.com/contact).
This guide walks through setting up a long-lived workspace that is owned by a service account and shared with a rotating set of users.
Because no single person owns the workspace, it persists across team changes and every user authenticates as themselves.
This pattern is useful for any scenario where a workspace outlives the people who use it:
- **On-call rotations**:
Engineers share a workspace pre-loaded with runbooks, dashboards, and monitoring tools.
Access rotates with the shift schedule.
- **Shared staging or QA**:
A team workspace hosts a persistent staging environment.
Quality assurance (QA) testers and reviewers are added and removed as sprints change.
- **Pair programming**:
A service-account-owned workspace gives two or more developers a shared environment without either one owning (and accidentally deleting) it.
- **Contractor onboarding**:
An external team gets scoped access to a workspace for the duration of an engagement, then access is revoked.
The steps below use an on-call site reliability engineering (SRE) workspace as a running example, but the same commands apply to any of the scenarios above.
Substitute the usernames, group names, and template to match your use case.
## Prerequisites
- A running Coder deployment (v2.32+) with workspace sharing enabled.
Sharing is on by default for open source software (OSS).
Premium deployments may require [admin configuration](../user-guides/shared-workspaces.md#policies).
- The [Coder CLI](../install/index.md) installed and authenticated.
- An account with the `Owner` or `User Admin` role.
- [OpenID Connect (OIDC) authentication](../admin/users/oidc-auth/index.md) configured so shared users log in with their corporate single sign-on (SSO) identity.
Configure [refresh tokens](../admin/users/oidc-auth/refresh-tokens.md) to prevent session timeouts during long work sessions.
- A [wildcard access URL](../admin/networking/wildcard-access-url.md) configured (for example, `*.coder.example.com`) so that shared users can access workspace apps without a 404.
- (Recommended) [IdP Group Sync](../admin/users/idp-sync.md#group-sync) configured if your identity provider manages group membership for the teams that will share the workspace.
## 1. Create a service account
Create a dedicated service account that will own the shared workspace.
Service accounts are non-human accounts intended for automation and shared ownership.
Because no individual user owns the workspace, there are no personal credentials to expose and the shared environment is not affected when any user leaves the team or the organization.
```sh
# On-call example — substitute a name that fits your use case
coder users create \
--username oncall-sre \
--service-account
```
## 2. Generate an API token for the service account
Generate a long-lived API token so you can create and manage workspaces on behalf of the service account:
```sh
coder tokens create \
--user oncall-sre \
--name oncall-automation \
--lifetime 8760h
```
Store this token securely (for example, in a secrets manager like Vault or AWS Secrets Manager).
> [!IMPORTANT]
> Never distribute this token to end users.
> The token is for workspace administration only.
> Shared users authenticate as themselves and reach the workspace through sharing.
## 3. Create the workspace
Authenticate as the service account and create the workspace:
```sh
export CODER_SESSION_TOKEN="<token-from-step-2>"
coder create oncall-sre/oncall-workspace \
--template your-oncall-template \
--use-parameter-defaults \
--yes
```
> [!TIP]
> Design a dedicated template for the workspace with the tools your team needs pre-installed (for example, monitoring dashboards for on-call, test runners for QA).
> Set `subdomain = true` on workspace apps so that shared users can access web-based tools without a 404.
> See [Access workspace apps in shared workspaces](../user-guides/shared-workspaces.md#access-workspace-apps-in-shared-workspaces).
## 4. Share the workspace
Use `coder sharing share` to grant access to users who need the workspace:
```sh
coder sharing share oncall-sre/oncall-workspace --user alice
```
This gives `alice` the default `use` role, which allows connection via SSH and workspace apps, starting and stopping the workspace, and viewing logs and stats.
To grant `admin` permissions (which includes all `use` permissions as well as renaming, updating, and inviting others to join with the `use` role):
```sh
coder sharing share oncall-sre/oncall-workspace --user alice:admin
```
To share with multiple users at once:
```sh
coder sharing share oncall-sre/oncall-workspace --user alice:admin,bob
```
To share with an entire Coder group:
```sh
coder sharing share oncall-sre/oncall-workspace --group sre-oncall
```
> [!NOTE]
> Groups can be synced from your identity provider using [IdP Sync](../admin/users/idp-sync.md#group-sync).
> If your IdP already manages team membership, sharing with a group is the simplest approach.
## 5. Rotate access
When team membership changes, remove outgoing users and add incoming ones:
```sh
# Remove outgoing user
coder sharing remove oncall-sre/oncall-workspace --user alice
# Add incoming user
coder sharing share oncall-sre/oncall-workspace --user carol
```
> [!IMPORTANT]
> The workspace must be restarted for user removal to take effect.
Verify current sharing status at any time:
```sh
coder sharing status oncall-sre/oncall-workspace
```
For every subcommand and flag, see the [`coder sharing` reference](../reference/cli/sharing/index.md).
## 6. Automate access changes (optional)
For use cases with frequent rotation (such as on-call shifts), you can integrate the share/remove commands into external tooling like PagerDuty, Opsgenie, or a cron job.
### Rotation script
```sh
#!/bin/bash
# rotate-access.sh
# Usage: ./rotate-access.sh <outgoing-user> <incoming-user>
WORKSPACE="oncall-sre/oncall-workspace"
OUTGOING="$1"
INCOMING="$2"
if [ -n "$OUTGOING" ]; then
echo "Removing access for $OUTGOING..."
coder sharing remove "$WORKSPACE" --user "$OUTGOING"
fi
echo "Granting access to $INCOMING..."
coder sharing share "$WORKSPACE" --user "$INCOMING"
echo "Restarting workspace to apply changes..."
coder restart "$WORKSPACE" --yes
echo "Current sharing status:"
coder sharing status "$WORKSPACE"
```
### Group-based rotation with IdP Sync
If your identity provider manages group membership (for example, an `sre-oncall` group in Okta or Azure Active Directory (AD)), you can skip manual share/remove commands entirely:
1. Configure [Group Sync](../admin/users/idp-sync.md#group-sync) to synchronize the group from your IdP to Coder.
1. Share the workspace with the group once:
```sh
coder sharing share oncall-sre/oncall-workspace --group sre-oncall
```
1. When your IdP rotates group membership, Coder group membership updates on next login.
All current members have access.
Removed members lose access after a workspace restart.
<a id="finding-shared-workspaces"></a>
## Find shared workspaces
Shared users can find workspaces shared with them:
```sh
# List all shared workspaces you can access, including your own
coder list --search shared:true
# List workspaces shared with you
coder list --search shared_with_user:me
# List workspaces shared with a specific user
coder list --search shared_with_user:alice
# List workspaces shared with a specific group
coder list --search shared_with_group:sre-oncall
```
## Troubleshooting
### Shared user sees 404 on workspace apps
Workspace apps using path-based routing block non-owners by default.
Configure a [wildcard access URL](../admin/networking/wildcard-access-url.md) and set `subdomain = true` on the workspace app in your template.
### Removed user still has access
Access removal requires a workspace restart.
Run `coder restart <workspace>` after removing a user or group.
### Group sync not updating membership
Group membership changes in your IdP are not reflected until the user logs out and back in.
Group sync runs at login time, not on a polling schedule.
Check the logs from `coderd`, the process that runs the control plane, with `CODER_LOG_FILTER=".*userauth.*|.*groups returned.*"` for details.
See [Troubleshooting group sync](../admin/users/idp-sync.md#troubleshooting-grouproleorganization-sync) for more information.
## Next steps
- [Shared Workspaces](../user-guides/shared-workspaces.md): full reference for workspace sharing features and UI
- [IdP Sync](../admin/users/idp-sync.md): group, role, and organization sync configuration
- [Configuring Okta](./configuring-okta.md): Okta-specific OIDC setup with custom claims and scopes
- [Security Best Practices](./best-practices/security-best-practices.md): deployment-wide security hardening
- [Sessions and Tokens](../admin/users/sessions-tokens.md): API token management and scoping