1
0
mirror of https://github.com/docker/docs.git synced 2026-10-25 06:09:46 +03:00

123 Commits

Author SHA1 Message Date
Sebastiaan van Stijn
e495211493 engine: add v29.6 and v29.7 to API version matrix
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-08-03 12:24:29 +02:00
Alexa Kristensen
3448dcdcda Revert "docs: add Enterprise Data API reference and usage reports guide" (#25632)
Reverts docker/docs#25383
2026-07-23 11:59:20 -05:00
cassio-paesleme
a2d3787389 docs: add Enterprise Data API reference and usage reports guide (#25383)
## Summary

- Adds OpenAPI 3.0 spec and API reference page for the Docker Enterprise
Data API at `/reference/api/enterprise-data/`
- Adds feature guide for enterprise usage reports at
`/manuals/enterprise/reports/`

## Context

Docker Enterprise subscribers will be able to programmatically export
organization usage reports (pull data) via
`api.docker.com/enterprise-data/v1/`. This is a new API surface,
separate from the Hub API, supporting both PAT and OAT authentication.

Related PRs:
- API implementation:
[docker/data-platform#817](https://github.com/docker/data-platform/pull/817)
- FGA scope for OAT auth:
[docker/iam-services#1029](https://github.com/docker/iam-services/pull/1029)

## New pages

| Path | Description |
|---|---|
| `/reference/api/enterprise-data/api.yaml` | OpenAPI 3.0 spec (4
endpoints: list types, list reports, download, schema) |
| `/reference/api/enterprise-data/index.md` | API reference landing page
|
| `/manuals/enterprise/reports/_index.md` | Feature guide with auth
setup, curl walkthrough, pagination, troubleshooting |

## Test plan

- [ ] API reference renders correctly at
`/reference/api/enterprise-data/`
- [ ] Feature guide renders in the Enterprise sidebar
- [ ] curl examples are copy-pasteable and accurate


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

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Alexa <alexa.kristensen@docker.com>
2026-07-23 11:26:34 -05:00
Craig Osterhout
7ca960b7a2 hub: fix broken link (#25625)
<!--Delete sections as needed -->

## Description

Fixed broken link.

## Related issues or tickets

Closes #25379

## Reviews

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

- [ ] Editorial review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-07-22 13:30:19 -05:00
Paweł Gronowski
50595451ab engine: 29.6.0
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-06-18 22:44:56 +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
Craig Osterhout
37fab0f3f7 offload: update activity log (#25268)
<!--Delete sections as needed -->

## Description

- Added note to Offload Activity logs page about the username and
details being displayed. Note that `user_id` and `org_id` is not
currently displayed in the event description/details.
- Added example to API docs showing what data is returned for Offload.
We don't currently document the data for all the event types, so I
avoided doing it inconsistently for Offload and instead opted to add it
as an example.

Previews:
-
https://deploy-preview-25268--docsdocker.netlify.app/admin/activity-logs/#offload-events
-
https://deploy-preview-25268--docsdocker.netlify.app/reference/api/hub/latest/#tag/audit-logs/operation/AuditLogs_ListAuditLogs

UI reference:
<img width="1617" height="678" alt="image"
src="https://github.com/user-attachments/assets/30a7cb6c-c6ea-43fc-981c-2856080ab9d2"
/>


## Related issues or tickets

ENGDOCS-3312

## 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-08 11:30:18 -07:00
David Karlsson
4fdf475942 sbx: vendor latest ai governance openapi spec
Sync the AI Governance Policy API reference with the upstream spec from
docker/governor-services#242. Wraps the ListPolicies response data under
a `data` object, adds the updatePolicy and deletePolicy endpoints,
migrates policy scope from profiles to teams, and switches rule/policy
updates to application/json.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-04 13:01:57 +02:00
David Karlsson
2fe4b84081 sbx: fix ai governance api auth endpoint
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-06-02 17:17:27 +02:00
David Karlsson
553c69e1b7 sbx: restructure governance docs and add API reference (#25162)
## Summary

Restructures the Docker AI Governance documentation under
\`/ai/sandboxes/governance/\` and adds the supporting API reference.

Preview links:

-
https://deploy-preview-25162--docsdocker.netlify.app/ai/sandboxes/governance/
-
https://deploy-preview-25162--docsdocker.netlify.app/reference/api/ai-governance/

### Information architecture

The existing \`security/governance\` and \`security/policy\` pages are
merged into a new top-level \`governance\` section so local-policy and
org-policy sit side by side instead of being split across unrelated
parents:

- \`/ai/sandboxes/governance/\` — section landing; explains local + org
as layered enforcement
- \`/ai/sandboxes/governance/concepts/\` — resource model, rule syntax,
evaluation, precedence
- \`/ai/sandboxes/governance/local/\` — \`sbx policy\` CLI for
individual machines
- \`/ai/sandboxes/governance/org/\` — Admin Console flow (was
\`security/governance.md\`)
- \`/ai/sandboxes/governance/monitoring/\` — \`sbx policy ls\` / \`sbx
policy log\`

### API reference

\`/reference/api/ai-governance/\` renders the Governance OpenAPI spec
vendored at \`content/reference/api/ai-governance/api.yaml\` from
\`docker/governor-services\`. Operations, schemas, examples, and status
codes are fully driven by the spec — future updates land via re-vendor,
not in-repo edits. Anything wrong in the rendered reference should be
fixed upstream and re-vendored here.

The spec has been re-vendored to the latest upstream version, which
updated the server URL to \`hub.docker.com/v2\` and added the
\`/governance/\` prefix to all API paths.

### Review focus

1. The \`/ai/sandboxes/governance/\` landing — does the local + org
framing match how the product is positioned?
2. \`/reference/api/ai-governance/\` — does the rendered spec match the
source of truth, and is anything important missing?

Generated by Claude Code

---------

Co-authored-by: Louis-Arnaud <la.catoire@gmail.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-02 10:05:05 +02:00
Sebastiaan van Stijn
10c483da08 engine: update versions for v29.5.0
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-05-15 11:49:58 +02:00
Alexa Kristensen
26ea39ec33 Agent redirect skill and small admin > company reorg (#24856)
This PR captures a small chunk of work intended to test a new agent
skill for handling redirect aliases, link references, and link anchors.
2026-04-24 07:50:35 -05:00
Alexa Kristensen
3619fb1780 Admin IA refresh (#24852)
PR to capture work:

- Update / simplify titles to match docs
- Create subcategories within org/company
- Wrestle with redirect nightmare part 2

Filing a follow up PR to create parallel structure in the `Company`
subcategory. This PR's scope is for `Organization` only.
2026-04-23 07:30:04 -05:00
Sebastiaan van Stijn
d558d46d14 engine: update API-version matrix and add Minimum API version
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-04-14 10:37:54 +02:00
Claude Docs Agent
bf8999ae1b docs: update Engine API version to v1.54, docker CE to v29.3.0 2026-03-24 12:20:12 +01:00
David Karlsson
0f5c795327 Fix issue #24406: correct Docker Hub API documentation (#24443)
Fixes discrepancies in the Docker Hub organization access token API
documentation to match actual API behavior.

Changes:
- Removed `created_by` field from create endpoint response (API only
returns `created_at`)
- Updated scope examples from `repo-pull` to `scope-image-pull` (correct
format with `scope-` prefix)
- Enhanced repository path documentation with validation requirements
for TYPE_REPO resources

These changes align the OpenAPI specification with the actual API
implementation as discovered during Terraform provider development.

Fixes #24406

---------

Co-authored-by: David Karlsson <dvdksn@users.noreply.github.com>
2026-03-20 08:32:39 -07:00
Tiara Johnson
e7e28c4386 Update pricing url with ref and refAction params [GRO-282] (#24339)
## Description
In order to better attribute upgrade sources, we are adding two params -
`ref` and `refAction` to the existing pricing url.
The `ref` will be "Docs" and the `refAction` will be the particular docs
page from where the pricing url click is originated.

## Related issues or tickets
https://docker.atlassian.net/browse/GRO-282

## Reviews
@akristen You should see the new url params when hovering over or
clicking any of the updated pricing urls

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

---------

Co-authored-by: Alexa Kristensen <81787716+akristen@users.noreply.github.com>
2026-03-12 09:12:44 -05:00
Sebastiaan van Stijn
a2eb5a8189 engine: slight tweaks to client sdk examples
I noticed that building the examples would produce a client with the
default ("Go-http-client/1.1") User-Agent; this is something to look
into (probably should have a saner default), but regardless, it's
good practice to set your own;

- Update examples to show setting the User-Agent
- Use "log.Fatal" instead of "panic"; both exit the binary, but
  probably are slightly more readable.
- Use the authconfig.Encode utility, which codifies the canonical
  format to encode the JSON, so that users don't have to replicate
  the same format.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-03-11 16:22:17 +01:00
Thomas Brüggemann
ca0020e2af Update Docker.DotNet link in C# library section
Fork because of unmaintained orginal repo.
2026-02-25 10:10:15 +01:00
Sebastiaan van Stijn
c00894853f engine: update API version table
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-02-20 19:11:37 +01:00
David Karlsson
49d1f65b35 deps: upgrade to hugo v0.156.0 and fix deprecations 2026-02-19 16:09:15 +01:00
Craig Osterhout
4cae670c4d hub: add deletion note (#24078)
<!--Delete sections as needed -->

## Description

Delete operation may time-out. Hub automatically retries without user
interaction in both the UI and API.

Added notes to make the user aware.

## Related issues or tickets

ENGDOCS-3173

## 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-02-18 14:56:52 -08:00
github-actions[bot]
f5240e4220 docs: address issue #23308 (#24115)
## Summary
Added documentation for DOCKER_HOST requirement when using Docker SDKs
with Docker Desktop for Linux.

## Changes
- Added "Using Docker SDKs with Docker Desktop" section to Linux install
docs explaining why SDKs need DOCKER_HOST set and providing
configuration commands
- Added FAQ entry "How do I use Docker SDKs with Docker Desktop for
Linux?" with troubleshooting steps
- Added note in SDK reference docs alerting Docker Desktop for Linux
users to set DOCKER_HOST before using SDKs

Fixes #23308

---
🤖 Generated with [cagent](https://github.com/docker/cagent)

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: aevesdocker <allie.sadler@docker.com>
2026-02-12 11:03:06 +00:00
luojiyin
9be23c8032 Fix spelling errors across documentation and config files
- seee → see (hub API docs)
- dameon → daemon (release notes)
- plugable → pluggable (release notes)
- adminstrative → administrative (account docs)
- docekr → Docker (opentelemetry guide)
- addFlagLables → addFlagLabels (tensorflowjs guide)
- terrabytes → terabytes (Vale config)
- Dasboard → Dashboard (Vale vocabulary)
- plaform → platform (CLI docs)
- correponds → corresponds (CLI docs)
- digset → digest (buildx docs)

Signed-off-by: luojiyin <luojiyin@hotmail.com>
2026-02-08 13:15:42 +08:00
Paweł Gronowski
9d71967f31 api: 1.53
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-01-27 10:46:10 +01:00
Paweł Gronowski
129055470a engine: Update version
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-01-19 14:46:00 +01:00
Paweł Gronowski
28fc8f6d73 engine: Update version
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-01-16 15:04:59 +01:00
MohammadHasan Akbari
e42100bfe1 chore: update api version in api docs links
Signed-off-by: MohammadHasan Akbari <jarqvi.jarqvi@gmail.com>
2026-01-07 15:47:34 +03:30
MohammadHasan Akbari
1596996ab0 fix: update api docs links
Signed-off-by: MohammadHasan Akbari <jarqvi.jarqvi@gmail.com>
2026-01-06 14:40:53 +03:30
Paweł Gronowski
eb2beaa0b6 engine: Update version
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2025-12-12 16:54:01 +01:00
David Karlsson
36a6d2708c Merge pull request #23751 from dvdksn/update-go-sdk-examples
update go sdk examples
2025-12-03 21:52:16 +01:00
Paweł Gronowski
23d565e72e engine: Update version
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2025-12-02 23:38:33 +01:00
David Karlsson
0461b5f724 config: bump latest engine version to v29.0.4
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-25 10:16:26 +01:00
Josh
51795e35d2 feat: Add expires_at to PAT management (#23754)
<!--Delete sections as needed -->

## Description

- feat: Add expiry fields to PAT management API endpoints.

## Reviews

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

- [x] Technical review
- [ ] Editorial review
- [ ] Product review
2025-11-24 09:30:18 +00:00
David Karlsson
34db3110ce engine: update go sdk examples to use new moby/moby/client module
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-20 18:01:07 +01:00
Nick Adcock
962c42c50b Add Offload activity log events (#23716)
<!--Delete sections as needed -->

## Description

Adds the Offload activity log events to the activity-logs documentation.
Adds all activity log actions to the audit-logs API spec.

## 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: Nick Adcock <nick.adcock@docker.com>
2025-11-13 12:09:40 -08:00
David Karlsson
53953dc8d0 engine: use moby/moby/api module and bump min api version to 1.44
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
(cherry picked from commit 79abab7d09)
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-12 10:27:04 +01:00
Paweł Gronowski
dbc061c762 engine: Update version
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2025-11-12 10:27:00 +01:00
Paweł Gronowski
426040e864 engine: Update version
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2025-11-05 16:41:43 +01:00
Craig Osterhout
86d5f139ef hub: dvp docs update (#23474)
<!--Delete sections as needed -->

## Description

- Added Hub infrastructure as benefit for DVP, and add a visual.
  - Based on existing public info at:
    - https://www.docker.com/trust/availability/
    - https://www.cloudflare.com/case-studies/docker/
- Rearranged topic structure and flesh out the benefits section.
- Added DVP Core GUI and reports to analytics topic
- Added how DVPers can verify no pull limit
- Added that DVP is applied per namespace/org. 

Updated pages:

https://deploy-preview-23474--docsdocker.netlify.app/docker-hub/repos/manage/trusted-content/dvp-program/

https://deploy-preview-23474--docsdocker.netlify.app/docker-hub/repos/manage/trusted-content/insights-analytics/


## Related issues or tickets

ENGDOCS-3020
ENGDOCS-3035

## Reviews

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

- [ ] Editorial review
- [ ] Product review
- [ ] Engineering review

---------

Signed-off-by: Craig <craig.osterhout@docker.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2025-10-27 12:45:38 -07:00
Guillaume Tardif
fa132e348d Merge pull request #23515 from gtardif/extension_binary_exec_on_host
Update extension documentation: the SDK to execute commands on the host is not restricted to binaries listed in the extension metadata.
2025-10-10 15:59:50 +02:00
Paweł Gronowski
6c14a64179 engine: Update version
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2025-10-08 15:02:25 +02:00
Guillaume Tardif
e7bf04bff1 Update extension documentation: the SDK to execute commands on the host is not restricted to binaries listed in the extension metadata.
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2025-10-07 18:35:52 +02:00
Paweł Gronowski
270c02b9fd docker: 28.5.0 (#23486)
<!--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: Paweł Gronowski <pawel.gronowski@docker.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-10-03 10:10:11 +01:00
Vincent DAMERY
fb5a0b304d [docker-hub-api] Fix Assign repository group endpoints req/resp (#23453)
<!--Delete sections as needed -->

## Description

[docker-hub-api] Fix `Assign repository group` endpoints
request/response.

see https://github.com/docker/hub-feedback/issues/2495

<!-- 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) -->

- [x] Technical review
- [ ] Editorial review
- [ ] Product review
2025-09-25 09:46:05 -04:00
JPBotelho
2c0d6fd792 fix: typos (#23435)
<!--Delete sections as needed -->

## Description

Fixed typos

## 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
2025-09-19 16:05:53 -07:00
Vincent DAMERY
479e7dcf5c [docker-hub-api] Add Create, Get, Head repository endpoint (#23428)
<!--Delete sections as needed -->

## Description

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

Add `Create repository` endpoint

## Related issues or tickets

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

## Reviews

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

- [x] Technical review
- [ ] Editorial review
- [ ] Product review
2025-09-19 10:27:11 -04:00
Paweł Gronowski
d17ff77224 engine: 28.4.0 (#23326)
<!--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: Paweł Gronowski <pawel.gronowski@docker.com>
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2025-09-04 09:45:09 +01:00
Vincent DAMERY
420e0b8796 [docker-hub-api] Fix listNamespaceRepositories max page_size : 1000 -> 100 (#23201)
<!--Delete sections as needed -->

## Description

[docker-hub-api] Fix listNamespaceRepositories max `page_size` : 1000 ->
100

## Related issues or tickets

https://github.com/docker/docs/issues/23199

## Reviews

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

- [x] Technical review
- [ ] Editorial review
- [ ] Product review
2025-08-05 16:11:09 +02:00
Vincent DAMERY
188949b60b [docker-hub-api] Add repository immutable tags endpoints to update settings and validate regex before update (#23179)
<!--Delete sections as needed -->

## Description

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

[docker-hub-api] Add repository immutable tags endpoints to update
settings and validate regex before update.

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->
- https://docker.atlassian.net/browse/RG-3017
- https://docker.atlassian.net/browse/RG-3018

## Reviews

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

- [x] Technical review
- [ ] Editorial review
- [ ] Product review
2025-08-04 09:38:44 +01:00