Commit Graph

67177 Commits

Author SHA1 Message Date
David Karlsson d2ec0d8fb2 docs(sandboxes): document --name as primary sandbox identity key
--name now identifies a sandbox independently of the working directory.
Expanded the reconnecting and naming section to cover: re-attaching by
name from any directory, re-running a create command to reconnect without
error, and using distinct names to run multiple sandboxes against the
same workspace.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-16 15:59:22 +02:00
David Karlsson bd25cced99 docs(sandboxes): document multiple --host patterns for custom secrets
sbx secret set-custom --host is now repeatable, so one secret entry can
cover multiple domains. Added a second example showing the multi-host
form and updated the prose to reflect that the proxy matches any of the
configured hosts.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-16 15:59:22 +02:00
David Karlsson a5fd2021c7 docs(sandboxes): add agent field to audit log schema
Audit records now include an `agent` field identifying which AI agent
drove the sandbox (claude, codex, etc.), so multi-agent deployments can
attribute policy decisions per agent. Added to the example record and the
field reference table.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-16 15:59:22 +02:00
David Karlsson 568de235c9 docs(sandboxes): clarify DNS resolution is policy-gated in network isolation
Sandbox DNS lookups now go through the same policy engine as TCP
connections — a denied domain is refused at the resolver level, not just
the connection level. Updated the network isolation description to reflect
this guarantee rather than describing DNS as merely proxied.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-16 15:59:21 +02:00
David Karlsson 41c2d90e03 Merge pull request #25357 from dgageot/fix-openai-compatible-examples
Fix OpenAI-compatible provider examples in Docker Agent docs
2026-06-15 10:30:57 +02:00
David Gageot 3f9f3cd6f7 fix: correct OpenAI-compatible provider examples
The OpenAI-compatible provider examples nested model settings under a
`provider:` key directly on the agent, which is not a valid field and
fails with `unknown field "provider"`. Define a named model in the
`models` section instead and reference it from the agent.

Fixes docker/docker-agent#3121
2026-06-15 10:23:34 +02:00
David Karlsson 3fe911f318 Merge pull request #25339 from dvdksn/worktree-split-kits-reference
Split kit spec reference and update kit field renames
2026-06-15 10:07:07 +02:00
David Karlsson e593c74762 docs: add kit spec changelog and fix kits-memory directory name
Add a Changelog section at the top of the kit spec reference noting the
v0.32.0 field renames (memory -> agentContext, kind: agent -> kind:
sandbox, agent: block -> sandbox: block), which are deprecated aliases
that sbx kit validate warns on.

Also fix the per-kit directory name: v0.32.0 renamed kits-memory/ to
kits-agent-context/ (with automatic migration), which the docs had not
been updated to reflect.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-12 11:31:47 +02:00
David Karlsson 2167dc4e22 docs: rename the agent kit block to sandbox
Rename the spec.yaml agent: block to sandbox: and its field paths
(agent.image, agent.aiFilename, agent.entrypoint) to sandbox.*. Update
the "Agent block" reference heading and its #agent-block anchor to
"Sandbox block"/#sandbox-block, repoint cross-links, and rename the
tutorial's "Write the agent block" section.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-12 10:45:02 +02:00
David Karlsson dd55b6601d docs: rename the agent kit kind to sandbox
Rename the spec.yaml kind: agent value to kind: sandbox and the "agent
kit" concept to "sandbox kit" across the overview, spec reference,
examples, index, and FAQ. Update the "Agent kits" heading and its
#agent-kits anchor to "Sandbox kits"/#sandbox-kits, and repoint inbound
links. The agent: block and the build-an-agent.md tutorial keep their
existing names.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-12 10:40:44 +02:00
David Karlsson 87168bd2c2 docs: rename the memory kit field to agentContext
Rename the spec.yaml memory: field to agentContext: across the spec
reference, overview, and tutorial, and update the section heading,
anchor, and cross-links. The memory file artifact and kits-memory/
directory keep their names.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-12 10:33:59 +02:00
David Karlsson 393c83854e docs: remove the agent.persistence field
The agent.persistence field was removed from kits, so drop it from the
spec reference, the agent block examples, and the build-an-agent tutorial.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-12 10:28:15 +02:00
David Karlsson adcb2a26ee docs: fix broken anchor to the Define an agent section
The links pointed to #defining-an-agent, but the heading "Define an
agent" slugifies to #define-an-agent.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-12 10:25:55 +02:00
David Karlsson d5799d8e59 docs: split kits spec reference into its own page
Move the spec.yaml field reference out of the Kits overview page into a
new Kit spec reference page, keeping the overview focused on concepts and
usage. Rewire cross-page links accordingly.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-12 10:25:23 +02:00
Craig Osterhout 19fc52edf1 dhi: update helm topic (#25334)
<!--Delete sections as needed -->

## Description

Updated intro and the section for find.

The Helm docs link is removed as users on this page are expected to know
what a Helm chart is, and "Docker-provided" immediately before it makes
the link misleading. The Find section is no longer needed as the catalog
can be linked directly and viewed without signing in.

Preview:
https://deploy-preview-25334--docsdocker.netlify.app/dhi/how-to/helm/

## Related issues or tickets

https://docker.slack.com/archives/C04300R4G5U/p1781196686143879

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Editorial review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-06-12 09:42:21 +02:00
Craig Osterhout 8f225794d6 guides: refresh nodejs (#25319)
<!--Delete sections as needed -->

## Description

Refreshed Node.js guide

- Updated all examples to DHI. DHI Community is now free so the DOI
fallback is no longer needed.
- Replaced the git clone pattern with the file scaffolding component.
- Simplified the sample app to a Node.js backend API. Added links at the
start of the guide to dedicated frontend framework guides.
- Added "Secure your Node.js image supply chain" topic to showcase DHI.
- Refreshed topic intros and related links.

https://deploy-preview-25319--docsdocker.netlify.app/guides/nodejs/


## Related issues or tickets

ENGDOCS-3319
Closes #25280

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-06-11 08:41:08 -07:00
Alexa Kristensen f9c884674f fix goofy link styling (#25326)
goofy link
2026-06-11 10:11:30 -05:00
Paweł Gronowski c385b5665c Merge pull request #25332 from vvoland/update-distros
engine: Drop EOL Fedora 42
2026-06-11 16:51:16 +02:00
Paweł Gronowski 39adf04805 engine: Drop EOL Fedora 42
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-06-11 16:43:39 +02:00
Kimaswa Emmanuel Yusufu caa2754dfe docs: fix LocalStack port, Compose configs key, and a doubled link slash (#25309)
Three small fixes in the guides.

- `guides/localstack`: the prose says `S3_ENDPOINT_URL` is
`http://localhost:4556`, but LocalStack's edge port is `4566`, and the
guide's own `.env` block later uses `4566`.
- `guides/pgadmin`: the top-level Compose key for the pgpass file is
`configs`, not `config`. As written the compose file is invalid.
- `guides/bun/deploy`: the "Turn on Kubernetes" link has a doubled slash
(`/manuals//desktop/...`).

Signed-off-by: Emmanuel Yusufu Kimaswa <kimaswaemma36@gmail.com>
2026-06-10 14:54:51 -07:00
Rohan Santhosh Kumar 1d205b4bf6 docs: fix container name reuse wording (#24817)
## Summary
- fix reuse wording in the engine links documentation

## Related issue
- N/A (trivial docs wording fix)

## Guideline alignment
- reviewed `CONTRIBUTING.md`
- kept the change to one content file with no behavior impact

## Validation
- `git diff --check`

Co-authored-by: Codex <codex@openai.com>
2026-06-10 14:49:24 -07:00
Louis-Arnaud 45feb518d4 guides/localstack: update init directory to /etc/localstack/init/ready.d (#24816)
The `/docker-entrypoint-initaws.d` directory was removed in LocalStack
2.0. Updates the Compose snippet to mount the current `ready.d` init
hook directory and adds a short tip pointing to the LocalStack init
hooks reference. Also drops a stray trailing quote that made the
previous mount path invalid.

Closes #22640
2026-06-10 14:44:14 -07:00
Mohammad-Ali A'RÂBI 2c03c2dcd1 Add Docker and Kubernetes Security resource (#25177)
Added a new resource for Docker and Kubernetes security with a discount
code.
2026-06-10 14:15:55 -07:00
Jasdeep Singh Bhalla 0391eabaef Fix broken prerequisite in account deactivation docs (#25297)
## Description

The prerequisites section for deactivating a Docker account contained a
broken bullet:

> Unlink your [GitHub and account](...)

\"GitHub and account\" is not grammatical. The linked page covers
unlinking both GitHub and Bitbucket accounts (for the deprecated
automated builds feature), but only GitHub was mentioned.

This fix:
- Rewrites the bullet to be grammatically correct
- Clarifies it only applies to users who linked accounts for automated
builds
- Adds a link for Bitbucket alongside GitHub

## Related issues or tickets

Fixes #25128

## Reviews

- [ ] Technical review
- [ ] Editorial review
2026-06-10 14:06:11 -07:00
Craig Osterhout c5bc2ddef6 dhi: env vars in customizations (#25285)
<!--Delete sections as needed -->

## Description

Documented how environment variables from OCI artifacts are
automatically merged into customized DHI images.

Preview:
https://deploy-preview-25285--docsdocker.netlify.app/dhi/how-to/customize/

## Related issues or tickets

DXT-775

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-06-10 09:21:31 -07:00
Craig Osterhout 140b37a933 dhi: add release notes (#25245)
<!--Delete sections as needed -->

## Description

- Added CLI and platform release notes for DHI.
- Modified sbx release note script to also fetch dhictl and fix some
formatting issues introduced by the DHI CLI release notes.


https://deploy-preview-25245--docsdocker.netlify.app/dhi/release-notes/platform/

https://deploy-preview-25245--docsdocker.netlify.app/dhi/release-notes/cli/

## Related issues or tickets


## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Editorial review
- [ ] Product review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-06-10 08:36:47 -07:00
David Karlsson c5fea43c1f Merge pull request #25322 from dvdksn/worktree-sbx-content-audit-fixes
Content quality fixes for AI Sandboxes docs
2026-06-10 14:54:50 +02:00
David Karlsson 7cea2802c1 Merge pull request #25323 from dvdksn/worktree-sbx-registry-dockerhub-lead
Lead with Docker Hub fact in sandbox registry section
2026-06-10 14:54:26 +02:00
David Karlsson bfb37fee27 Merge pull request #25279 from dvdksn/worktree-sbx-experimental-badges
sbx-cli: render experimental indicators for commands and flags
2026-06-10 14:47:29 +02:00
David Karlsson c43b2b9886 cli: use violet for experimental flag badges
Align the experimental flag badges in the Docker CLI layout with the
violet color used by the sbx-cli layout, so experimental indicators are
consistent across both reference templates.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 14:39:48 +02:00
David Karlsson 59a9547a27 sbx-cli: render experimental indicators for commands and flags
The sbx-cli layout had no handling for the experimental: true field
present in many data/sbx_cli/*.yaml files. Add visual indicators
matching the Docker CLI layout:

- Command-level (experimental: true at YAML root): magenta callout
  block below the summary table
- Flag-level (experimental: true on an option): violet badge before
  the flag description in Options and Global options tables
- Subcommands table: violet badge alongside the synopsis for
  experimental child commands

The title heading stays plain, consistent with cli.html, which signals
experimental status only through the command-level callout.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 14:39:32 +02:00
David Karlsson cb5ca4470a docs: lead with Docker Hub fact in sandbox registry section
Reorder the Docker registry section so it opens with the fact that
Docker Hub needs no registry credentials (sbx reuses your sbx login
session), then covers configuring credentials for other registries.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 12:52:49 +02:00
David Karlsson fc160bc793 Merge pull request #25321 from joe0BAB/feat/pass-v3
feat(docker-pass): update docs
2026-06-10 10:30:52 +02:00
David Karlsson 1630e85f72 Merge pull request #25317 from dvdksn/sbx/sync-governance-api-script
sbx: add governance API sync script and re-vendor spec
2026-06-10 10:23:43 +02:00
Johannes Großmann 15928d9f8b feat(docker-pass): update docs 2026-06-10 10:14:44 +02:00
Sebastiaan van Stijn cd1f28ac54 Merge pull request #25318 from thaJeztah/bump_cli
vendor: github.com/docker/cli v29.5.3
2026-06-09 18:23:25 +02:00
Sebastiaan van Stijn 4168f0b101 vendor: github.com/docker/cli v29.5.3
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-06-09 17:27:09 +02:00
David Karlsson 3ed5acc026 sbx: fix heading level for shell startup command
The Shell page had "Default startup command" as an h3 with no parent h2,
skipping a heading level. Promote it to h2 so it sits alongside "Base
image", consistent with the other agent pages.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 16:59:37 +02:00
David Karlsson 82a4a3114c sbx: fix subject-verb agreement in kits tip
"The templates ... already includes uv" -> "include"; spell out "etc"
as "and so on".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 16:59:12 +02:00
David Karlsson 6167cf64d4 sbx: replace "seamless" hedge word in FAQ
"seamless" is on the repo's banned hedge-word list. State plainly that a
Docker account authenticates the requests.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 16:58:48 +02:00
David Karlsson 387e54da63 sbx: clarify virtiofs caching applies to direct mode
Clone-mode sandboxes enable virtiofs caching automatically as of v0.32.0,
so note that the DOCKER_SANDBOXES_ENABLE_VIRTIOFS_CACHE tuning is only
relevant for direct-mode workspaces.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 16:58:24 +02:00
David Karlsson df1ebca223 sbx: use relative links for internal docs references
Compose, Engine, Desktop, and Docker Agent pages live on docs.docker.com,
so link to them with source-relative /manuals/ paths instead of absolute
https://docs.docker.com URLs. This matches the dominant convention in the
repo and lets Hugo resolve and link-check the references.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 16:58:01 +02:00
David Karlsson 9f92c50d85 sbx: document background: true for kit startup services
commands.startup[].background now keeps a service alive and replays on
every container start (sbx-releases #2842, shipped in v0.30.0), so the
nohup/& shell workaround is no longer required. Lead the background
service example with background: true, drop the stale claim that the
field alone leaves the service attached to an exiting shell, and remove
the resolved follow-up TODO comment. Update the generic startup example
in the kits reference to match.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 16:57:29 +02:00
David Karlsson 0a8df2cb5c sbx: remove stale --branch references
The --branch flag was removed in sbx v0.31.0 in favor of --clone. Drop
the troubleshooting section about stale host worktrees (clone mode keeps
no host-side worktree, so the scenario can no longer occur) and update
the architecture lifecycle note to describe clone-mode cleanup, which
removes the sandbox-<name> Git remote on sbx rm.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 16:55:48 +02:00
David Karlsson 82cf8bcc1e sbx: fix broken commit-signing anchor links
Two pages linked to usage.md#signed-commits, an anchor that does not
exist. The commit-signing content lives in workflows.md under the
"Commit signing" heading. Point both links there.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 16:55:05 +02:00
David Karlsson 9740ff1294 docs: mark ai governance api spec as vendored for agents and review bot
Note in AGENTS.md and the PR review workflow that
content/reference/api/ai-governance/api.yaml is a verbatim copy of the
upstream OpenAPI spec, vendored from the private docker/governor-services
repo via hack/sync-governance-api.sh, and should not be hand-edited.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-06-09 16:49:38 +02:00
David Karlsson e50562a9c7 sbx: vendor latest ai governance openapi spec
Sync the AI Governance Policy API reference with the upstream spec from
docker/governor-services. Renames the shared 403 response component from
PermissionDenied to Forbidden across the policy/rule endpoints, and adds a
limit_exceeded error code covering org policy and per-policy rule maximums.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-06-09 16:45:20 +02:00
David Karlsson 356489df54 hack: add script to sync AI governance OpenAPI spec
Add hack/sync-governance-api.sh to re-vendor the AI Governance Policy API
spec from the private docker/governor-services repo. The vendored copy at
content/reference/api/ai-governance/api.yaml is a verbatim copy of upstream,
so the script fetches it via gh (using the caller's own auth, no repo
secrets) and prints a diff summary for review. Mirrors the existing
hack/sync-cli-docs.sh convention.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-06-09 16:45:12 +02:00
David Karlsson 6e99480aef Merge pull request #25314 from dvdksn/sbx/v0.32.0-releasenotes
sbx: regenerate release notes (v0.32.0)
2026-06-09 15:57:57 +02:00
David Karlsson f530aa343e sbx: document codex auth prompt before sandbox launch (#25315)
## Summary

`sbx` now prompts you to authenticate to Codex on the host before
launching the sandbox when no OpenAI credential is stored. Updated the
Codex agent page and the credentials best practices to describe this
flow, and reordered the Codex auth methods so OAuth (the host-side
prompted flow) leads.

Generated by Claude Code

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 15:57:45 +02:00