Skip to content

docs(sandboxes): credential bindings, kit spec v2#25369

Draft
dvdksn wants to merge 2 commits into
docker:mainfrom
dvdksn:sandboxes-credentials-rework
Draft

docs(sandboxes): credential bindings, kit spec v2#25369
dvdksn wants to merge 2 commits into
docker:mainfrom
dvdksn:sandboxes-credentials-rework

Conversation

@dvdksn

@dvdksn dvdksn commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Reworks the Docker Sandboxes credential and kit-spec documentation for the kit
schemaVersion: "2" model: user-controlled credential bindings, the first-run
binding-approval flow, and the v2 kit-authoring schema.

What's in this PR

Credential model (security/credentials.md)

  • Credential bindings (~/.config/sbx/credentials.yaml) as the authorization
    mechanism: per-service discovery + allowedDomains.
  • First-run approval flow (terminal and TUI), covering both API-key and OAuth.
  • Fail-closed by default for schemaVersion: "2" agents; credentials.failClosed
    documented as the override that extends the rule to older-schema kits.
  • Environment variables documented as a binding discovery source — no implicit
    host-env fallback for built-in agents.

Kit-authoring schema (customize/kit-reference.md, kits.md, kit-examples.md)

  • Examples default to schemaVersion: "2".
  • New "Schema versions" section + a v1→v2 field mapping. v1 is still supported
    and auto-normalized, so migration is incremental.
  • Credentials rewritten to the credentials[] / apiKey / oauth shape
    (discovery moved to bindings); network → caps.network; proxyManaged removed.

Supporting pages

  • All built-in agent pages: env-var authentication now flows through a credential
    binding.
  • troubleshooting.md: the "no approved binding" failure (non-interactive run or
    declined prompt).

Status

Note

Draft — intentionally held. This documents the end state once built-in
agents move to schemaVersion: "2" and credential bindings become the default
(gated on the built-in v2 migration, docker/sandboxes#3684). Publishing before
that ships would describe behavior most users wouldn't yet hit.

The kit-authoring schema changes (kit-reference / kits / examples) describe a
schema that already exists and could publish sooner; the end-user
credential-model changes (credentials.md, agent pages, troubleshooting)
should publish when the migration lands.

Open TODOs before publishing

  • Confirm the upgrade path for users with a pre-existing stored secret — are
    they auto-bound on first run, or prompted to approve a binding? Tracked by an
    inline TODO in credentials.md.
  • customize/build-an-agent.md is still on the v1 schema — update in a
    separate follow-up PR.
  • Final pass on prompt / UX wording against the shipped build.

Generated by Claude Code

@netlify

netlify Bot commented Jun 16, 2026

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 5200f4f
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6a3416fe70e564000825117a
😎 Deploy Preview https://deploy-preview-25369--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@docker-agent docker-agent left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟡 NEEDS ATTENTION

The credentials page rework is well-structured and the new content (credential bindings, fail-closed mode, registry scope table) is accurate and useful. Three style violations in the newly-added content need attention before merge — all are bold misuse per the Docker style guide.

Comment thread content/manuals/ai/sandboxes/security/credentials.md
Comment thread content/manuals/ai/sandboxes/security/credentials.md
Comment thread content/manuals/ai/sandboxes/security/credentials.md
@dvdksn dvdksn force-pushed the sandboxes-credentials-rework branch from 3697c5b to 75b13e9 Compare June 16, 2026 14:19
dvdksn and others added 2 commits June 18, 2026 18:03
Add a "Credential bindings" section documenting ~/.config/sbx/credentials.yaml
— per-service discovery and allowedDomains scoping — and fail-closed mode
(credentials.failClosed), including the first-use approval flow. Add the
bindings form to the orientation table and cross-reference it from the kits
credential section.

Documents the intended fail-closed behavior; pending the daemon-routed create
path honoring bindings (docker/sandboxes#3629).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Reframe the credential and kit-authoring docs to the v2 launch state:

- credentials.md: credential bindings as the authorization mechanism,
  first-run approval (API key vs OAuth), fail-closed by default for
  schemaVersion 2 kits, environment variables sourced via a binding
- kit-reference.md: default examples to schemaVersion "2"; add a
  "Schema versions" section + v1->v2 mapping; rewrite credentials
  (credentials[] / apiKey / oauth), network (caps.network), drop proxyManaged
- kits.md, kit-examples.md: convert examples to v2
- agent pages: env-var auth now flows through a credential binding
- troubleshooting.md: add the "no approved binding" failure

Held as a draft until built-in agents move to schemaVersion 2.
build-an-agent.md remains on v1 (separate follow-up).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@dvdksn dvdksn force-pushed the sandboxes-credentials-rework branch from 5c7bd36 to 5200f4f Compare June 18, 2026 16:04
@dvdksn dvdksn changed the title docs(sandboxes): rework credentials page and document credential bindings docs(sandboxes): credential bindings, kit spec v2 Jun 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants