Repository navigation
docs: add how-to for rolling out a security update to every workspace - #31810
Closed
coder[bot] wants to merge 2 commits into
Closed
coder[bot] wants to merge 2 commits into
coder[bot] wants to merge 2 commits into
Conversation
Collaborator
|
Closing and reopening under a human author, as required for this repository. |
This branch was previously deployed
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adds an admin how-to that walks through getting a patched package (for example an updated
ca-certificatesafter a certificate authority is compromised) into every new and existing workspace. Until now the steps were spread across image management, template versioning, update policies, automatic updates, and bulk operations.The new page
docs/templates/managing-templates/roll-out-security-updates.mdcovers:coder list|coder updateloop. It warns that bulk Start keeps the current version and that dormant workspaces are skipped.outdated:truefilter and checking the package withcoder ssh.envbuildercaches, persistent home volumes, and persistent VM disks. It also covers prebuilt workspaces.It also adds the page to the sidebar (
docs/manifest/templates/managing-templates.yml, regenerateddocs/manifest.json) and links to it fromimage-management.mdand the Bulk operations section ofworkspace-management.md. The page links to existing pages instead of repeating them.The CLI commands and their output were run against a local dev deployment:
templates push, thecoder list --search ... outdated:truetable, the JSON/jq/xargs coder update -yloop, the empty result, andcoder ssh ... -- dpkg-query. Dashboard steps are checked against the UI code only.Verified against
site/src/pages/WorkspacesPage/WorkspacesPage.tsx,WorkspacesPageView.tsx,WorkspacesTable.tsx,BatchUpdateModalForm.tsx,batchActions.ts(Bulk actions labels, bulk Start uses the current version, bulk Update skips dormant and starts stopped workspaces, defaultuser:mefilter)site/src/api/api.ts(updateWorkspace,changeWorkspaceVersion,startWorkspace)site/src/pages/TemplatePage/TemplatePageHeader.tsx,TemplateLayout.tsx,TemplateVersionsPage/TemplateVersionsPage.tsx,VersionRow.tsx,TemplateVersionEditorPage/TemplateVersionEditor.tsx,PublishTemplateVersionDialog.tsx(Edit files, Build, Publish, Promote to active version, Promote…)site/src/pages/TemplateSettingsPage/TemplateGeneralSettingsPage/TemplateSettingsForm.tsx,Sidebar.tsx(Operations section, require-active-version label, Premium badge, Save)site/src/pages/WorkspaceSettingsPage/WorkspaceSettingsForm.tsx,Sidebar.tsx(Automatic Updates, Update Policy)site/src/modules/workspaces/actions.ts,site/src/utils/workspace.tsxcoderd/database/dbauthz/dbauthz.go(InsertWorkspaceBuildrequire-active-version check, exemption for users who can update the template)enterprise/coderd/coderd.go,enterprise/coderd/dbauthz/accesscontrol.go,codersdk/deployment.go(access_controlPremium gating; bulk actions not license-gated)coderd/autobuild/lifecycle_executor.go,coderd/workspaces.go(autostart uses the active version under the policy oralways)coderd/rbac/roles.go,docs/admin/users/groups-roles.md(Template Admin has workspace read only)cli/templatepush.go(--activatedefault true),cli/templateedit.go,cli/update.go,cli/start.go(dormant activation, active-version selection),cli/list.go,cli/cliui/filter.go(--allignores--search),cli/ssh.gocoderd/searchquery/search.go(outdatedfilter)examples/templates/docker/main.tf,examples/templates/kubernetes/main.tfdocs/templates/extending-templates/prebuilt-workspaces.md,docs/admin/integrations/devcontainers/envbuilder/envbuilder-security-caching.md,docs/workspaces/devcontainers/working-with-dev-containers.mdOpen questions for the reviewer
envbuildercaching:envbuilderisn't in this repo, so I couldn't confirm that changing the base image reference (for example to a new digest) always avoids a cached image. The page says to change the reference and links the upstream caching doc. Anenvbuilderexpert should confirm.workspace-management.mdBulk operations still says "top-right Actions dropdown", but the UI label is Bulk actions. I left it alone to avoid conflicting with docs(docs/user-guides): clarify who confirms bulk workspace actions #31137, which edits the same section. Should it be fixed there or here?--require-active-version.index.mdstill tells readers to enable "Template Update Policies", which doesn't match the UI. Not changed here.change-management.mdandindex.md#update-templates, which is outside this change's scope.Closes DOCS-1354