Skip to content

Commit 0131f27

Browse files
github-actions[bot]aevesdockerArthurFlagcraig-osterhout
authored
publish updates from main (#22979)
Automated pull request for publishing docs updates. --------- Signed-off-by: Craig <[email protected]> Co-authored-by: Allie Sadler <[email protected]> Co-authored-by: Arthur <[email protected]> Co-authored-by: Craig Osterhout <[email protected]>
1 parent 2195db7 commit 0131f27

File tree

11 files changed

+82
-89
lines changed

11 files changed

+82
-89
lines changed

_vale/Docker/Forbidden.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
extends: substitution
2+
message: "Use '%s' instead of '%s'."
3+
level: error
4+
ignorecase: false
5+
swap:
6+
Docker CE: Docker Engine

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
(?i)[A-Z]{2,}'?s
2+
Adreno
3+
Aleksandrov
24
Amazon
35
Anchore
4-
Aleksandrov
56
Apple
67
Artifactory
78
Azure
@@ -114,6 +115,7 @@ Nginx
114115
npm
115116
Nutanix
116117
Nuxeo
118+
NVIDIA
117119
OAuth
118120
Okta
119121
Ollama
@@ -126,8 +128,7 @@ PKG
126128
Postgres
127129
PowerShell
128130
Python
129-
Pyright
130-
pyright
131+
Qualcomm
131132
rollback
132133
rootful
133134
runc
@@ -200,6 +201,7 @@ Zsh
200201
[Pp]rocfs
201202
[Pp]roxied
202203
[Pp]roxying
204+
[pP]yright
203205
[Rr]eal-time
204206
[Rr]egex(es)?
205207
[Rr]untimes?

content/manuals/ai/mcp-catalog-and-toolkit/catalog.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Docker MCP Catalog
33
description: Learn about the benefits of the MCP Catalog, how you can use it, and how you can contribute
4-
keywords: docker hub, mcp, mcp servers, ai agents, calatog, docker
4+
keywords: docker hub, mcp, mcp servers, ai agents, catalog, docker
55
---
66

7-
The [Docker MCP Catalog](https://hub.docker.com/catalogs/mcp) is a centralized, trusted registry for discovering, sharing, and running MCP-compatible tools. Seamlessly integrated into Docker Hub, it offers verified, versioned, and curated MCP servers packaged as Docker images. The catalog is also available in Docker Desktop.
7+
The [Docker MCP Catalog](https://hub.docker.com/mcp) is a centralized, trusted registry for discovering, sharing, and running MCP-compatible tools. Seamlessly integrated into Docker Hub, it offers verified, versioned, and curated MCP servers packaged as Docker images. The catalog is also available in Docker Desktop.
88

99
The catalog solves common MCP server challenges:
1010

@@ -32,10 +32,11 @@ Each tool in the MCP Catalog is packaged as a Docker image with metadata:
3232
- Connect tools to their preferred agents with simple configuration through the [MCP Toolkit](toolkit.md).
3333
- Pull and run tools using Docker Desktop or the CLI.
3434

35-
Each catalog entry provides:
35+
Each catalog entry displays:
3636

3737
- Tool description and metadata
3838
- Version history
39+
- List of tools provided by the MCP server
3940
- Example configuration for agent integration
4041

4142
## Use an MCP server from the catalog
@@ -44,11 +45,11 @@ To use an MCP server from the catalog, see [MCP toolkit](toolkit.md).
4445

4546
## Contribute an MCP server to the catalog
4647

47-
The MCP server registry is available at https://github.com/docker/mcp-registry. To submit an MCP server:
48+
The MCP server registry is available at https://github.com/docker/mcp-registry. To submit an MCP server,
4849
follow the [contributing guidelines](https://github.com/docker/mcp-registry/blob/main/CONTRIBUTING.md).
4950

5051
When your pull request is reviewed and approved, your MCP server is available in 24 hours on:
5152

5253
- Docker Desktop's [MCP Toolkit feature](toolkit.md)
5354
- The [Docker MCP catalog](https://hub.docker.com/mcp)
54-
- The [Docker Hub](https://hub.docker.com/u/mcp) mcp namespace (for MCP servers built by Docker)
55+
- The [Docker Hub](https://hub.docker.com/u/mcp) `mcp` namespace (for MCP servers built by Docker)

content/manuals/ai/model-runner/_index.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,41 @@ with AI models locally.
4040
- Run and interact with AI models directly from the command line or from the Docker Desktop GUI
4141
- Manage local models and display logs
4242

43+
## Requirements
44+
45+
Docker Model Runner is supported on the following platforms:
46+
47+
{{< tabs >}}
48+
{{< tab name="Windows">}}
49+
50+
Windows(amd64):
51+
- NVIDIA GPUs
52+
- NVIDIA drivers 576.57+
53+
54+
Windows(arm64):
55+
- OpenCL for Adreno
56+
- Qualcomm Adreno GPU (6xx series and later)
57+
58+
> [!NOTE]
59+
> Some llama.cpp features might not be fully supported on the 6xx series.
60+
61+
{{< /tab >}}
62+
{{< tab name="MacOS">}}
63+
64+
- Apple Silicon
65+
66+
{{< /tab >}}
67+
{{< tab name="Linux">}}
68+
69+
Docker Engine only:
70+
71+
- Linux CPU & Linux NVIDIA
72+
- NVIDIA drivers 575.57.08+
73+
74+
{{< /tab >}}
75+
{{</tabs >}}
76+
77+
4378
## How it works
4479

4580
Models are pulled from Docker Hub the first time they're used and stored locally. They're loaded into memory only at runtime when a request is made, and unloaded when not in use to optimize resources. Since models can be large, the initial pull may take some time — but after that, they're cached locally for faster access. You can interact with the model using [OpenAI-compatible APIs](#what-api-endpoints-are-available).

content/manuals/build/metadata/attestations/sbom.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,22 @@
22
title: SBOM attestations
33
keywords: build, attestations, sbom, spdx, metadata, packages
44
description: |
5-
SBOM build attestations describe the contents of your image,
6-
and the packages used to build it.
5+
SBOM attestations describe what software artifacts an image contains and the artifacts used to create the image.
76
aliases:
87
- /build/attestations/sbom/
98
---
109

11-
Software Bill of Materials (SBOM) attestations describe what software artifacts
12-
an image contains, and artifacts used to create the image. Metadata included in
13-
an SBOM for describing software artifacts may include:
10+
SBOM attestations help ensure [software supply chain transparency](/guides/docker-scout/s3c.md) by verifying the software artifacts an image contains and the artifacts used to create the image. Metadata included in an [SBOM](/guides/docker-scout/sbom.md) for describing software artifacts may include:
1411

1512
- Name of the artifact
1613
- Version
1714
- License type
1815
- Authors
1916
- Unique package identifier
2017

21-
There are benefits to indexing contents of an image during the build, as opposed
22-
to scanning a final image. When scanning happens as part of the build, you're
23-
able to detect software you use to build the image, that may not show up in the
24-
final image.
18+
Indexing the contents of an image during the build has benefits over scanning a final image. When scanning happens as part of the build, you can detect software you used to build the image, which may not show up in the final image.
2519

26-
The SBOMs generated by BuildKit follow the SPDX standard. SBOMs attach to the
27-
final image as a JSON-encoded SPDX document, using the format defined by the
28-
[in-toto SPDX predicate](https://github.com/in-toto/attestation/blob/main/spec/predicates/spdx.md).
20+
Docker supports SBOM generation and attestation through an SLSA-compliant build process using BuildKit and attestations. The SBOMs generated by [BuildKit](/manuals/build/buildkit/_index.md) follow the SPDX standard and attach to the final image as a JSON-encoded SPDX document, using the format defined by the [in-toto SPDX predicate](https://github.com/in-toto/attestation/blob/main/spec/predicates/spdx.md). On this page, you’ll learn how to create, manage, and verify SBOM attestations using Docker tooling.
2921

3022
## Create SBOM attestations
3123

content/manuals/compose/how-tos/lifecycle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Using lifecycle hooks with Compose
33
linkTitle: Use lifecycle hooks
44
weight: 20
5-
desription: How to use lifecycle hooks with Docker Compose
6-
keywords: cli, compose, lifecycle, hooks reference
5+
description: Learn how to use Docker Compose lifecycle hooks like post_start and pre_stop to customize container behavior.
6+
keywords: docker compose lifecycle hooks, post_start, pre_stop, docker compose entrypoint, docker container stop hooks, compose hook commands
77
---
88

99
{{< summary-bar feature_name="Compose lifecycle hooks" >}}

content/manuals/compose/how-tos/profiles.md

Lines changed: 14 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,12 @@ If you want to enable all profiles at the same time, you can run `docker compose
8585

8686
## Auto-starting profiles and dependency resolution
8787

88+
When you explicitly target a service on the command line that has one or more profiles assigned, you do not need to enable the profile manually as Compose runs that service regardless of whether its profile is activated. This is useful for running one-off services or debugging tools.
89+
90+
Only the targeted service (and any of its declared dependencies via `depends_on`) is started. Other services that share the same profile will not be started unless:
91+
- They are also explicitly targeted, or
92+
- The profile is explicitly enabled using `--profile` or `COMPOSE_PROFILES`.
93+
8894
When a service with assigned `profiles` is explicitly targeted on the command
8995
line its profiles are started automatically so you don't need to start them
9096
manually. This can be used for one-off services and debugging tools.
@@ -108,72 +114,19 @@ services:
108114
```
109115

110116
```sh
111-
# Only start backend and db
117+
# Only start backend and db (no profiles involved)
112118
$ docker compose up -d
113119
114-
# This runs db-migrations (and, if necessary, start db)
115-
# by implicitly enabling the profiles "tools"
120+
# Run the db-migrations service without manually enabling the 'tools' profile
116121
$ docker compose run db-migrations
117122
```
118123

119-
But keep in mind that `docker compose` only automatically starts the
120-
profiles of the services on the command line and not of any dependencies.
121-
122-
This means that any other services the targeted service `depends_on` should either:
123-
- Share a common profile
124-
- Always be started, by omitting `profiles` or having a matching profile started explicitly
125-
126-
```yaml
127-
services:
128-
web:
129-
image: web
130-
131-
mock-backend:
132-
image: backend
133-
profiles: ["dev"]
134-
depends_on:
135-
- db
136-
137-
db:
138-
image: mysql
139-
profiles: ["dev"]
140-
141-
phpmyadmin:
142-
image: phpmyadmin
143-
profiles: ["debug"]
144-
depends_on:
145-
- db
146-
```
147-
148-
```sh
149-
# Only start "web"
150-
$ docker compose up -d
151-
152-
# Start mock-backend (and, if necessary, db)
153-
# by implicitly enabling profiles "dev"
154-
$ docker compose up -d mock-backend
155-
156-
# This fails because profiles "dev" is not enabled
157-
$ docker compose up phpmyadmin
158-
```
159-
160-
Although targeting `phpmyadmin` automatically starts the profiles `debug`, it doesn't automatically start the profiles required by `db` which is `dev`.
124+
In this example, `db-migrations` runs even though it is assigned to the tools profile, because it was explicitly targeted. The `db` service is also started automatically because it is listed in `depends_on`.
161125

162-
To fix this you either have to add the `debug` profile to the `db` service:
163-
164-
```yaml
165-
db:
166-
image: mysql
167-
profiles: ["debug", "dev"]
168-
```
169-
170-
or start the `dev` profile explicitly:
171-
172-
```console
173-
# Profiles "debug" is started automatically by targeting phpmyadmin
174-
$ docker compose --profile dev up phpmyadmin
175-
$ COMPOSE_PROFILES=dev docker compose up phpmyadmin
176-
```
126+
If the targeted service has dependencies that are also gated behind a profile, you must ensure those dependencies are either:
127+
- In the same profile
128+
- Started separately
129+
- Not assigned to any profile so are always enabled
177130

178131
## Stop application and services with specific profiles
179132

@@ -208,6 +161,7 @@ services:
208161
```
209162

210163
if you only want to stop the `phpmyadmin` service, you can run
164+
211165
```console
212166
$ docker compose down phpmyadmin
213167
```

content/manuals/compose/how-tos/project-name.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
title: Specify a project name
33
weight: 10
4-
description: Understand the different ways you can set a project name in Compose and what the precedence is.
4+
description: Learn how to set a custom project name in Compose and understand the precedence of each method.
55
keywords: name, compose, project, -p flag, name top-level element
66
aliases:
77
- /compose/project-name/
88
---
99

10-
In Compose, the default project name is derived from the base name of the project directory. However, you have the flexibility to set a custom project name.
10+
By default, Compose assigns the project name based on the name of the directory that contains the Compose file. You can override this with several methods.
1111

1212
This page offers examples of scenarios where custom project names can be helpful, outlines the various methods to set a project name, and provides the order of precedence for each approach.
1313

1414
> [!NOTE]
1515
>
1616
> The default project directory is the base directory of the Compose file. A custom value can also be set
17-
> for it using the [`--project-directory` command line option](/reference/cli/docker/compose.md#use--p-to-specify-a-project-name).
17+
> for it using the [`--project-directory` command line option](/reference/cli/docker/compose.md#options).
1818
1919
## Example use cases
2020

content/manuals/compose/how-tos/startup-order.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
description: How to control service startup and shutdown order in Docker Compose
3-
keywords: documentation, docs, docker, compose, startup, shutdown, order
2+
description: Learn how to manage service startup and shutdown order in Docker Compose using depends_on and healthchecks.
3+
keywords: docker compose startup order, compose shutdown order, depends_on, service healthcheck, control service dependencies
44
title: Control startup and shutdown order in Compose
55
linkTitle: Control startup order
66
weight: 30
@@ -13,7 +13,7 @@ You can control the order of service startup and shutdown with the
1313
containers in dependency order, where dependencies are determined by
1414
`depends_on`, `links`, `volumes_from`, and `network_mode: "service:..."`.
1515

16-
A good example of when you might use this is an application which needs to access a database. If both services are started with `docker compose up`, there is a chance this will fail since the application service might start before the database service and won't find a database able to handle its SQL statements.
16+
For example, if your application needs to access a database and both services are started with `docker compose up`, there is a chance this will fail since the application service might start before the database service and won't find a database able to handle its SQL statements.
1717

1818
## Control startup
1919

data/summary.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Docker Init:
162162
Docker Model Runner:
163163
availability: Beta
164164
requires: Docker Engine or Docker Desktop (Windows) 4.41+ or Docker Desktop (MacOS) 4.40+
165-
for: Docker Desktop for Mac with Apple Silicon or Windows with NVIDIA GPUs
165+
for: See Requirements section below
166166
Docker Projects:
167167
availability: Beta
168168
Docker Scout exceptions:

0 commit comments

Comments
 (0)