Commit Graph
5356 Commits
Author SHA1 Message Date
David Karlsson e0406c3cdd docs: remove explicit IDs from cloud sandbox guide headings
The workflow headings retain unnecessary IDs from their numbered versions. Remove the explicit IDs so Hugo generates anchors from the heading text.
2026-10-30 14:33:14 +00:00
David Karlsson 7d94a56ee5 docs: fix cloud sandbox guide headings and remove review checklist
Numbered headings triggered heading punctuation warnings in CI. Remove the visible numbers while preserving heading anchors, and remove the repository review checklist as requested.
2026-10-30 14:29:19 +00:00
David Karlsson f4f44b4282 docs: Continue cloud handoff work in the Console
The handoff guide kept cloud work in the CLI and required saving a template ID during the move. Continue the agent task in the Console, explain the terminal redraw workaround, and identify the backing template during cleanup. Update the live verification checklist to match.
2026-10-30 13:34:58 +00:00
David Karlsson e56d61ad17 docs: Refine cloud sandbox workflow instructions
Remove redundant setup and inspection steps, recommend Open for remote editor downloads, and clarify local-to-cloud authentication and architecture. Document the transferred template and remove it during cleanup, with matching live verification checks.
2026-10-30 09:29:05 +00:00
David Karlsson 901a5a356a docs: keep DAP onboarding focused on browser workflows
The quickstart mixed follow-up workflows into lifecycle guidance and included an optional editor section. Remove that section and collect workflow links under a closing Next steps heading.
2026-10-29 15:38:19 +00:00
David Karlsson b218ab6485 docs: reconcile DAP onboarding with workflow guides
The quickstart repeated editor setup and launch configuration covered elsewhere. Keep both browser workflows, link to the detailed guides and references, and clarify how to continue with an existing sandbox.
2026-10-29 15:28:05 +00:00
David Karlsson a9b7f739f4 docs: add cloud sandbox workflow guides
Add targeted workflows for sharing an app, developing over SSH, and handing a local task to the cloud. Link them from onboarding and cloud documentation so readers can apply the platform to a concrete task.
2026-10-29 14:57:52 +00:00
CrazyMax a2cc501182 Merge pull request #26479 from crazy-max/docs/buildx-3415-git-query-compatibility
build: explain Git query compatibility resolution
2026-10-29 12:56:08 +01:00
Greg MondelloandClaude Opus 4.8 ae41294ec4 Auto-generate custom role permissions reference from IAM metadata (#26336)
## Summary

Replaces the manual edits we make to this page whenever a custom-role
permission is added or renamed with a **synced data file + Hugo
shortcode**. The source of truth is `custom-role-metadata.yaml` in
`docker/iam-services`.

## What's in this PR

- **`data/custom_role_permissions.yaml`**: the upstream YAML, vendored
verbatim from iam-services `main`.
- **`layouts/_shortcodes/custom-role-permissions.html` and
`.markdown.md`**: render one section per group, with a
Permission/Description table, for both HTML and Markdown output. Cells
escape `|`. The build fails with the group and permission name if a
group, name or description is missing. The page calls it as `{{%
custom-role-permissions %}}` so the headings stay in the page table of
contents.
- **`permissions-reference.md`**: the generated region is replaced by
the shortcode call. Intro and "Next steps" stay hand-maintained.
- **`.github/workflows/sync-custom-role-permissions.yml`**:
`workflow_dispatch` (with a `ref` input) that fetches the YAML at that
ref, writes it to `data/`, and opens a PR via
`peter-evans/create-pull-request`. Site builds never need access to the
private upstream repo.
- **`.prettierignore`**: excludes the shortcode, because it emits
Markdown and Prettier's go-template plugin reflows the table.

The Node generator, hand-rolled YAML parser and generation markers are
removed.

## How the automation fires

A companion workflow in `docker/iam-services` ([PR
#1175](https://github.com/docker/iam-services/pull/1175)) triggers this
one whenever `custom-role-metadata.yaml` changes on `main`. The result
is always a **PR for review**, so nothing publishes automatically.

**Opt out of any given change:** close the generated PR; it re-opens on
the next source change.

## Testing

Built the full site with Hugo 0.163.0. HTML and Markdown output both
contain the same 32 permissions in 8 tables, the section anchors and
table of contents are intact, and removing a description fails the build
with a clear error. Prettier passes on the YAML and the workflow. The
workflow itself has not run.

## ⚠️ Provisioning needed before this runs (docs maintainers)

1. `HUB_PLATFORM_APP_ID` / `HUB_PLATFORM_APP_PRIVATE_KEY` secrets
present in this repo, with the GitHub App installed here (PR-write) and
granted contents-read on `docker/iam-services`. (Same app already used
by iam-services ↔ frontends sync.)
2. A workflow file added via a fork PR won't auto-run, so a maintainer
needs to land/enable it.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-10-29 12:50:31 +01:00
David Karlsson b55fd4373b Mention documentation answers alongside other Docker Skills examples (#26379)
## Description

Mention answering questions using official Docker documentation
alongside the existing Dockerfile and Compose examples in the Docker
Skills introduction. Keep the repository catalog as the place to find
individual skills and their descriptions.

## Related issues or tickets

Complements https://github.com/docker/docs/pull/26378, which advertises
Docker Skills in generated `llms.txt`.

## Reviews

Scoped rumdl and Vale checks pass with no errors, warnings, or
suggestions. `git diff --check` passes.

- [ ] Technical review
- [ ] Editorial review

---------

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-10-29 09:42:35 +01:00
David Karlsson 7b0deb68d9 Fold Bake guide workflows into the manual (#26477)
Retire the two Bake guides and preserve their useful workflows in the
existing manual: Compose release overrides, grouped tests and lint
checks, artifact exports, and release/debug matrices. Redirect the guide
URLs and update inbound links.

Validation: resolved Bake configurations, runtime examples (including an
expected test failure), amd64/arm64 exports, Hugo rendering, redirects,
headings, and navigation checked. Markdown formatting passed. Scoped
lint reports pre-existing Vale findings only; full validation failed
during vendor extraction because the build ran out of disk space.
Whole-site link checks remain for CI.
2026-10-29 08:09:31 +01:00
CrazyMax 6f65764ebf build: explain Git query compatibility resolution
The guides omit the opt-in for Git queries with older frontends.
Document client-side query resolution and its provenance representation
caveat, and link it from the Git context guide.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-28 15:55:33 +01:00
CrazyMax f90928eb20 Merge pull request #26473 from crazy-max/docs/buildx-3595-bake-env-lookup
build: describe disabling Bake environment lookups
2026-10-28 15:53:29 +01:00
CrazyMax f017187c19 build: describe disabling Bake environment lookups
The variable reference omits the Bake environment lookup control.
Explain its HCL and Compose behavior, explicit value overrides, and the
continued use of Compose .env files and Buildx configuration variables.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-28 10:15:37 +01:00
CrazyMax b20f7f4673 build: explain provenance material policy checks
The policy guides omit metadata from dependencies recorded in provenance.
Describe nested material inputs and depth, and show how to check the Git
repository and commit used to build a base image.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-28 10:12:54 +01:00
CrazyMax e4807a58c8 Merge pull request #26471 from crazy-max/docs/buildx-3935-bake-file-relative-paths
build: explain file-relative Bake context paths
2026-10-28 10:12:06 +01:00
CrazyMax de0afcb734 Merge pull request #26470 from crazy-max/docs/buildx-3876-bake-resource-overrides
build: describe Bake resource limit overrides
2026-10-28 10:11:47 +01:00
CrazyMax 5cd4aa56ea build: explain file-relative Bake context paths
The build variable reference omits the file-relative context opt-in.
Describe HCL and Compose path bases, implicit contexts, and cwd prefixes.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-28 10:00:16 +01:00
CrazyMax 3d46a19285 build: describe Bake resource limit overrides
The overrides guide does not list or explain per-resource CLI overrides.
Document the supported keys, preservation of other limits, and Linux
support requirements.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-28 09:57:14 +01:00
CrazyMax 8a5470f844 build: clarify remote Bake Git credential scoping
The guide only describes Git credentials for fetching Bake definitions.
Explain reuse for same-host Git contexts, automatic host selection, and
the limits when using local definitions or contexts on other hosts.
Keep the detailed explanation in the token reference.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-28 09:54:22 +01:00
David Karlsson a698d3a0e6 docs: explain sandbox lifecycle environment variables (#26403)
## Summary

The lifecycle reference lists host command environment variables without
explaining their values. Replace the list with a table covering file
merge order, path separators, sandbox name overrides, and the empty
workspace value in cloud environments. Clarify that sbx commands run by
cloud lifecycle commands inherit cloud mode and the selected endpoint.

Companion to #26393; this change can merge independently. Verified
against docker/sandboxes release/v0.49 at c5b19951af12. Scoped rumdl and
Vale checks passed.

@netlify /ai/sandboxes/configuration/environment-files/

Generated by Codex
2026-10-28 08:22:20 +01:00
David Karlsson 1bdc168e07 Clarify registry credential use in Sandboxes (#26450)
Update the host-only registry credential description to refer to `sbx`
as a whole, covering pulls authenticated by the daemon. The credential
storage commands and scope guidance are unchanged.

Validation: Markdown formatting and scoped rumdl/Vale checks passed.
2026-10-28 08:21:26 +01:00
CrazyMax 370c82d987 Merge pull request #26439 from crazy-max/docs/buildx-3962-bake-secret-overrides
build: clarify Bake overrides and secret source configuration
2026-10-27 21:33:14 +01:00
CrazyMax 4508c72d24 Merge pull request #26441 from crazy-max/docs/buildx-3652-policy-provenance-fields
build: describe image provenance policy fields
2026-10-27 21:33:11 +01:00
CrazyMax 0b8f088886 Merge pull request #26438 from crazy-max/docs/buildx-4103-bake-git-advice
build: describe Git advice controls for Bake
2026-10-27 18:09:16 +01:00
David Karlsson e09850d383 docs: align Agentic Platform guidance with the Console (#26422)
The Agentic Platform docs referenced outdated Secrets controls and
omitted steps needed to configure MCP clients, network rules, and SSH
access. This updates the navigation and task guidance from the October
23 UI audit, including sandbox restore actions, kit filters, naming and
compute selection, and delayed usage reporting.

Each of the 11 audit findings has a separate commit. Feature
availability is qualified where it varies by account. Signup
requirements and pause/process semantics remain unchanged; process
restoration still needs product confirmation.

All seven changed Markdown files passed rumdl and Vale with no errors,
warnings, or suggestions.

@netlify /agentic-platform/

Generated by Codex
2026-10-27 18:02:17 +01:00
David Karlsson b2095f2e9e docs: clarify Sandboxes first-run policy setup (#26421)
## Summary

The getting-started walkthrough promised a network preset prompt on the
first sandbox run, even when policy was already configured. Explain when
the CLI prompts, document `sbx policy init balanced` for manual
initialization, and remove outdated prompt transcripts from the
walkthrough and local-policy page. Also clarify that agent kits can add
model-provider allowances under Locked Down.

@netlify /ai/sandboxes/get-started/

Generated by Codex
2026-10-27 17:59:10 +01:00
David Karlsson f55dc7b65b sbx: link to sandbox vs containers page from tutorial (#26464) 2026-10-27 17:50:59 +01:00
Allie Sadler fc5b3aaf1f 4.97 CVE (#26462)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

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

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
2026-10-27 12:33:05 +00:00
Jooyoung Lim 901bf91e15 docs: fix rclone plugin install flag in volumes guide (#26459)
## Description

The rclone example in the volumes guide installs the plugin with
`--aliases rclone`. `docker plugin install` has no `--aliases` flag, so
the command fails before it reaches the daemon:

```console
$ docker plugin install --grant-all-permissions rclone/docker-volume-rclone --aliases rclone
unknown flag: --aliases
```

The flag is `--alias` ("Local name for plugin"), as listed in the
[`docker plugin install`
reference](https://docs.docker.com/reference/cli/docker/plugin/install/)
and used in the [rclone Docker plugin docs](https://rclone.org/docker/).
The later steps in the guide use `-d rclone` and `volume-driver=rclone`,
so they need the plugin to be installed under that alias.

I checked the flag parsing with Docker CLI 29.1.3 against a non-existent
daemon socket: `--aliases` fails with `unknown flag`, while `--alias
rclone` parses and only fails to connect. `npx --no-install rumdl fmt`
and `scripts/lint.sh` (rumdl 0.2.49, Vale 3.17.0) report no issues on
the changed line.

## Related issues or tickets

None.

## Reviews

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-10-27 12:26:50 +01:00
Mahesh Rijal cce0736eb1 docs: make wrapper scripts executable in container examples (#26448)
## Description

Add `COPY --chmod=755` to the wrapper-script copy instruction in both
examples on the [multiple-process container
guide](https://docs.docker.com/engine/containers/multi-service_container/).
A newly created wrapper commonly has mode `0644`; `COPY` preserves that
mode, so `CMD ./my_wrapper_script.sh` exits with 126 before the script
starts.

The issue reproduction was run verbatim. With `umask 022`, the original
Dockerfile returned 126 with `Permission denied`; the `COPY --chmod=755`
control ran successfully, as did the original Dockerfile after making
the host wrapper executable. Both documented recipes were also
reproduced with deterministic stand-ins; the job-control recipe's mode
control was run with a TTY.

Validation: `npx --no-install rumdl fmt` (rumdl 0.2.49) and
`scripts/lint.sh` (rumdl 0.2.49, Vale 3.17.0) passed on the changed
file. No full-site build was run for this two-line documentation change.

## Related issues or tickets

Fixes #26447

## Reviews

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

Signed-off-by: maheshrijal <62394512+maheshrijal@users.noreply.github.com>
2026-10-27 09:46:11 +01:00
Brian Refsdal 171f597d4e docs: add AI Governance Audit Logs API (#25931)
## Description

Adds public documentation for `GET /v2/auditlogs/governance/{org_name}`
and aligns the guide and OpenAPI reference with merged data-platform
main (`66bc70971`), including
[docker/data-platform#2711](https://github.com/docker/data-platform/pull/2711)
and
[docker/data-platform#2712](https://github.com/docker/data-platform/pull/2712).

- Documents raw Organization Access Token authentication and the View
audit logs permission.
- Covers the 25-event default, 100-event page cap, 30-day request
window, and cursor-preserved time bounds. Text search can use the
default window.
- Documents the API and gateway organization limits of 5 requests per
second and the gateway limit of 600 requests per minute per source IP.
Clients and tokens share the organization limits, and each pagination
request counts.
- Updates the structured application 429 example to `limit: 5`,
`window_seconds: 1`, and `retry_after_seconds: 1`.
- Keeps Retry-After optional: application responses include it when the
reset time is known, while gateway responses can omit it and use a
different body. The chart-owned Lua policy was removed in
[docker/data-platform#2725](https://github.com/docker/data-platform/pull/2725);
these docs do not promise gateway header translation.
- Covers request deadlines, search timeouts, and retryable dependency
failures, with links to the audit record reference and
subscription/access-token pages.

## Release status

The production route and gateway policies are enabled in the merged
configuration. One unauthenticated GET to
`https://api.docker.com/v2/auditlogs/governance/vonwig?page_size=1`
returned HTTP 401 with `{"error":"missing or malformed Authorization
header"}`, confirming public routing and missing-token rejection.

Before publishing, confirm the OAT View audit logs permission is
available in Docker Home and record authorized production
query/pagination, organization/IP throttling, retry behavior, and
monitoring validation. No authenticated request or rate-limit load test
was performed in this update. Merged configuration and a 401 response do
not establish those outcomes.

## Validation

- Scoped rumdl and Vale checks: passed with 0 errors, warnings, or
suggestions.
- Prettier check for the OpenAPI YAML: passed.
- OpenAPI 3.0 validation: passed using @apidevtools/swagger-parser
10.1.0.
- Public server and application 429 example checked against the merged
production values.
- `git diff --check`: passed.
- Full Hugo rendering and rendered link validation were not run; PR CI
and the deploy preview still need review.
2026-10-26 12:36:10 -07:00
David Karlsson c572cdcb54 docs: cover sbx 0.50 user-facing changes (#26449)
Documents six user-facing changes in sbx 0.50: kit host mount bindings,
persistent kit volume retention, environment MCP command approvals and
ownership, HTTP query restrictions, cloud sandbox inspection, and exec
exit status in automation. Each change has its own commit. Also vendors
the matching v0.50 CLI reference verbatim and regenerates the release
notes from published GitHub releases.

Kit documentation focuses on sbx usage and links to the canonical
capability definitions. Volume retention follows the 0.50
implementation; the upstream spec's main branch describes a different
storage lifecycle.

Verified against the release implementation. Scoped Markdown and prose
lint, a full Hugo build, and checks of the added internal links pass.

Related release: https://github.com/docker/sandboxes/issues/7698

Generated by Codex
2026-10-26 17:28:15 +01:00
CrazyMax 419ecb4718 Merge pull request #26446 from crazy-max/docs/buildx-3562-scoped-registry-credentials
build: explain scoped Buildx registry credentials
2026-10-26 13:42:12 +01:00
CrazyMax 2828bee92a Merge pull request #26445 from crazy-max/docs/buildx-3593-bake-policy-options
build: explain Bake policy options in HCL
2026-10-26 12:05:35 +01:00
CrazyMax abca8642bb Merge pull request #26442 from crazy-max/docs/buildx-3610-bake-variable-overrides
build: explain explicit Bake variable overrides
2026-10-26 12:03:13 +01:00
CrazyMax d230e4f8fa Merge pull request #26440 from crazy-max/docs/buildx-3738-policy-eval-options
build: update policy eval file and platform options
2026-10-26 12:02:46 +01:00
Allie Sadler abab46c4d9 Desktop: release updates (#26425)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

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

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
2026-10-26 10:58:17 +00:00
Allie Sadler 4495949309 4.97 rn (#26423)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

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

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

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
2026-10-26 10:57:43 +00:00
CrazyMax d0b06efc4f build: describe Git advice controls for Bake
The variable reference omits the remote Bake Git advice control.
Show how to enable advice and distinguish definition fetching from the
build argument used for Git build contexts.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-26 11:45:06 +01:00
CrazyMax eb96097622 build: align Bake override guidance with canonical keys
The guide duplicates incomplete key lists and uses older plural selectors.
Link to the CLI reference for exhaustive keys, distinguish selectors from
Bake file attributes, and explain aliases and inline list operations.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-26 11:42:13 +01:00
CrazyMax f2924ef0e9 build: explain Bake secret source overrides
The overrides guide omits the named secret override supported by Bake.
Show environment and file sources, and explain the declared-ID and
replacement constraints.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-26 11:42:13 +01:00
CrazyMax a701c5e4c0 build: update policy eval file and platform options
The policy guide teaches the hidden filename flag and omits stdin input
and platform selection. Use the supported file flag and add examples for
both capabilities.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-26 11:42:12 +01:00
CrazyMax b90e3677f2 build: describe image provenance policy fields
Policies can inspect provenance metadata beyond the hasProvenance flag.
Document the available fields and show checks for hermetic builds and
complete dependency records, with a signature verification caveat.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-26 11:42:11 +01:00
CrazyMax 0784853a02 build: explain explicit Bake variable overrides
The Bake guides only describe environment-based variable overrides.
Add var flag examples, precedence and type behavior, and its distinction
from target attribute overrides.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-26 11:42:10 +01:00
CrazyMax 76301268ed build: explain Bake policy options in HCL
The guide incorrectly states that Bake policy options require CLI flags.
Document policy objects in HCL and show explicit loading with strict mode.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-26 11:42:09 +01:00
CrazyMax aecc5ff55e build: explain scoped Buildx registry credentials
Buildx registry credential selection has no home in the build guides.
Add a registry authentication page covering scoped configurations and
keep only a cross-reference in the variable reference.

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-10-26 11:42:08 +01:00
Alexa KristensenandCursor 1d503f8b7c Add Manage licenses to Organization management permissions (#26426)
Adds a Manage licenses row to the Organization management table on the
core roles page (Member/Editor ❌, Owner ✅).

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-23 10:35:50 -05:00
Alexa KristensenandCursor b71dd84bd2 docs: expand Desktop releases FAQ for support and older installs (#26415)
## Summary

Adds FAQs for the six-month support window, installing an older build,
and 403 download errors, and notes that Always download updates is Mac
and Windows only.

@netlify /desktop/troubleshoot-and-support/faqs/releases/

**Preview:**
https://deploy-preview-26415--docsdocker.netlify.app/desktop/troubleshoot-and-support/faqs/releases/

Generated by Cursor

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-23 07:17:00 -05:00
Alexa KristensenandCursor 7c82035bcb docs: clarify how to view and change plans (#26417)
## Summary

The billing pages repeated steps covered elsewhere and never said what
each screen shows. Plan pages also left out the actions available from
Docker Home. This explains each Billing screen, documents those actions,
and points plan changes at the plans catalog instead of repeating them.

@netlify /subscription-billing/plans/

Preview:
-
https://deploy-preview-26417--docsdocker.netlify.app/subscription-billing/plans/
-
https://deploy-preview-26417--docsdocker.netlify.app/subscription-billing/manage/plans/
-
https://deploy-preview-26417--docsdocker.netlify.app/subscription-billing/plans/ai-governance/
-
https://deploy-preview-26417--docsdocker.netlify.app/subscription-billing/plans/docker-verified-publisher/

Generated by Cursor

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-23 07:16:26 -05:00