Boundary Docs: Add workers to the domain model - #3084
Open
stellarsquall wants to merge 3 commits into
Open
Conversation
Adds a workers resource page to the Boundary 1.0.x domain model docs, adding attributes, referenced by, service API docs, and reference-style links. - Global-scope-only placement, from the server_worker.scope_id foreign key to iam_scope_global and the scope validation in worker_service.go - Name constraints (lowercase, unique per scope, required for workers registered via KMS), from the server_worker table constraints and the uniqueness error path in repository_worker.go - Configurable and output-only attributes, from worker.proto, including the local_storage_state and remote_storage_state value sets - The pki/kms type values mapped to their registration methods, from CreateWorker and the KMS status upsert in repository_worker.go Also updates the domain model index page with a workers section and a summary entry, and adds the page to the docs navigation.
…, and 0.18 docs sets Backports the workers domain model page, the index page updates, and the navigation entry to the 0.21.x, 0.20.x, 0.19.x, and 0.18.x docs sets. The worker API resource is unchanged across these versions: worker.proto is identical from v0.18 through v1.0.0 apart from the action sets, global-scope validation, name constraints, and pki/kms type assignment. The 0.18 docs set predates the docs restructure and keeps the domain model under concepts/, so that copy uses concepts/domain-model paths and points at the worker docs that existed at the time: worker-configuration for registration, concepts/workers for multi-hop, and concepts/filtering/worker-tags for tags.
Contributor
Vercel Previews Deployed
|
Contributor
Broken Link CheckerThis PR contains broken links, but won't be blocked. Use this report to improve content quality: Quick Actions
Need Help?
Internal LinksExternal LinksSummary
Redirects per inputRedirects in content/boundary/v0.18.x/content/docs/concepts/domain-model/index.mdx
|
stellarsquall
changed the title
stellarsquall
marked this pull request as ready for review
August 11, 2026 15:58
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Description
Adds a workers page to the Boundary domain model documentation, and updates the
domain model overview and navigation to include it.
Workers were the only major Boundary resource without a domain model page, even
though the other pages reference them (targets have
egress_worker_filterandingress_worker_filter, storage buckets haveworker_filter). This fills thatgap and gives those references somewhere to point.
Engineers have previously requested that we add this page.
The new page workers domain model page includes:
private Vault, SSH protocol decryption)
nameanddescriptionare writable through the APIBoundary populates from the worker's config file or reported status
Page content is grounded in the source:
server_worker.scope_idFK toiam_scope_global; scope validation inworker_service.goname_must_be_lowercaseandworker_name_must_be_set_by_statustable constraints; uniqueness error path inrepository_worker.gointernal/proto/controller/api/resources/workers/v1/worker.protopki/kmstype mapped to registration methodCreateWorkersetsPkiWorkerType; KMS status upsert setsKmsWorkerTypeVersions
Added to v1.0.x and back ported to v0.21.x, v0.20.x, v0.19.x, and v0.18.x.
The worker API resource is unchanged across this range.
worker.protoisidentical from v0.18 through v1.0.0.
The 0.18.x copy differs because that docs set predates the docs restructure and
keeps the domain model under
concepts/. It usesconcepts/domain-modelpathsand links to the worker docs that existed at the time:
workers/registrationconfiguration/worker/worker-configurationworkers/multi-hopconcepts/workers#multi-hop-sessionsworkers/worker-tagsconcepts/filtering/worker-tagsPages to review
/boundary/docs/domain-model/workers(v1.0.x, v0.21.x, v0.20.x, v0.19.x)/boundary/docs/concepts/domain-model/workers(v0.18.x)/boundary/docs/domain-model— new Workers section and summary entryLinks
Jira ticket
Domain model overview preview
Domain model workers preview
Contributor checklists
Review urgency:
Pull request:
Content: