Skip to content

Commit ec2228b

Browse files
sarahsanders-dockerstevenleleusha-mandyachaomonicaaevesdocker
authored
publish updates from main (#22397)
Automated pull request for publishing docs updates. --------- Signed-off-by: CrazyMax <[email protected]> Signed-off-by: Craig <[email protected]> Co-authored-by: stevenlele <[email protected]> Co-authored-by: Usha Mandya <[email protected]> Co-authored-by: Monica Chao <[email protected]> Co-authored-by: Allie Sadler <[email protected]> Co-authored-by: CrazyMax <[email protected]> Co-authored-by: Craig Osterhout <[email protected]> Co-authored-by: Sarah Sanders <[email protected]>
2 parents acf5b30 + b720d48 commit ec2228b

File tree

24 files changed

+222
-172
lines changed

24 files changed

+222
-172
lines changed

_vale/Docker/Acronyms.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ exceptions:
7878
- KDE
7979
- LESS
8080
- LLDB
81+
- LLM
8182
- LTS
8283
- MAC
8384
- MATE

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Nginx
7777
Nutanix
7878
Nuxeo
7979
OAuth
80+
Ollama
8081
OTel
8182
Okta
8283
PKG

content/manuals/build/building/base-images.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@ For most cases, you don't need to create your own base image. Docker Hub
2222
contains a vast library of Docker images that are suitable for use as a base
2323
image in your build. [Docker Official
2424
Images](../../docker-hub/image-library/trusted-content.md#docker-official-images)
25-
are specifically designed as a set of hardened, battle-tested images that
26-
support a wide variety of platforms, languages, and frameworks. There are also
27-
[Docker Verified
25+
have clear documentation, promote best practices, and are regularly updated
26+
There are also [Docker Verified
2827
Publisher](../../docker-hub/image-library/trusted-content.md#verified-publisher-images)
2928
images, created by trusted publishing partners, verified by Docker.
3029

content/manuals/build/building/best-practices.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ image. When choosing an image, ensure it's built from a trusted source and keep
4646
it small.
4747

4848
- [Docker Official Images](https://hub.docker.com/search?image_filter=official)
49-
are some of the most secure and dependable images on Docker Hub. Typically,
50-
Docker Official images have few or no packages containing CVEs, and are
51-
thoroughly reviewed by Docker and project maintainers.
49+
are a curated collection that have clear documentation, promote best
50+
practices, and are regularly updated. They provide a trusted starting point
51+
for many applications.
5252

5353
- [Verified Publisher](https://hub.docker.com/search?image_filter=store) images
5454
are high-quality images published and maintained by the organizations

content/manuals/build/ci/github-actions/cache.md

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ jobs:
8787
{{< summary-bar feature_name="Cache backend API" >}}
8888
8989
The [GitHub Actions cache exporter](../../cache/backends/gha.md)
90-
backend uses the [GitHub Cache API](https://github.com/tonistiigi/go-actions-cache/blob/master/api.md)
90+
backend uses the [GitHub Cache service API](https://github.com/tonistiigi/go-actions-cache)
9191
to fetch and upload cache blobs. That's why you should only use this cache
92-
backend in a GitHub Action workflow, as the `url` (`$ACTIONS_CACHE_URL`) and
92+
backend in a GitHub Action workflow, as the `url` (`$ACTIONS_RESULTS_URL`) and
9393
`token` (`$ACTIONS_RUNTIME_TOKEN`) attributes only get populated in a workflow
9494
context.
9595

@@ -121,6 +121,64 @@ jobs:
121121
cache-to: type=gha,mode=max
122122
```
123123

124+
> [!IMPORTANT]
125+
>
126+
> Starting [April 15th, 2025, only GitHub Cache service API v2 will be supported](https://gh.io/gha-cache-sunset).
127+
>
128+
> If you encounter the following error during your build:
129+
>
130+
> ```console
131+
> ERROR: failed to solve: This legacy service is shutting down, effective April 15, 2025. Migrate to the new service ASAP. For more information: https://gh.io/gha-cache-sunset
132+
> ```
133+
>
134+
> You're probably using outdated tools that only support the legacy GitHub
135+
> Cache service API v1. Here are the minimum versions you need to upgrade to
136+
> depending on your use case:
137+
> * Docker Buildx >= v0.21.0
138+
> * BuildKit >= v0.20.0
139+
> * Docker Compose >= v2.33.1
140+
> * Docker Engine >= v28.0.0 (if you're building using the Docker driver with containerd image store enabled)
141+
>
142+
> If you're building using the `docker/build-push-action` or `docker/bake-action`
143+
> actions on GitHub hosted runners, Docker Buildx and BuildKit are already up
144+
> to date but on self-hosted runners, you may need to update them yourself.
145+
> Alternatively, you can use the `docker/setup-buildx-action` action to install
146+
> the latest version of Docker Buildx:
147+
>
148+
> ```yaml
149+
> - name: Set up Docker Buildx
150+
> uses: docker/setup-buildx-action@v3
151+
> with:
152+
> version: latest
153+
> ```
154+
>
155+
> If you're building using Docker Compose, you can use the
156+
> `docker/setup-compose-action` action:
157+
>
158+
> ```yaml
159+
> - name: Set up Docker Compose
160+
> uses: docker/setup-compose-action@v1
161+
> with:
162+
> version: latest
163+
> ```
164+
>
165+
> If you're building using the Docker Engine with the containerd image store
166+
> enabled, you can use the `docker/setup-docker-action` action:
167+
>
168+
> ```yaml
169+
> -
170+
> name: Set up Docker
171+
> uses: docker/setup-docker-action@v4
172+
> with:
173+
> version: latest
174+
> daemon-config: |
175+
> {
176+
> "features": {
177+
> "containerd-snapshotter": true
178+
> }
179+
> }
180+
> ```
181+
124182
### Cache mounts
125183

126184
BuildKit doesn't preserve cache mounts in the GitHub Actions cache by default.

content/manuals/desktop/features/containerd.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,38 @@
11
---
22
title: containerd image store
3-
weight: 10
3+
weight: 80
44
description: How to activate the containerd integration feature in Docker Desktop
55
keywords: Docker, containerd, engine, image store, lazy-pull
66
toc_max: 3
77
aliases:
88
- /desktop/containerd/
99
---
1010

11-
This page provides information about the ongoing integration of `containerd` for
12-
image and file system management in the Docker Engine.
11+
Docker Desktop is transitioning to use containerd for image and filesystem management. This page outlines the benefits, setup process, and new capabilities enabled by the containerd image store.
1312

1413
> [!NOTE]
1514
>
16-
> Images and containers are not shared between the classic image store and the
17-
> new containerd image store. When you switch image stores, containers and
18-
> images from the inactive store remain but are hidden until you switch back.
15+
> Docker Desktop maintains separate image stores for the classic and containerd image stores.
16+
> When switching between them, images and containers from the inactive store remain on disk but are hidden until you switch back.
1917
20-
## What is containerd?
18+
## What is `containerd`?
2119

22-
`containerd` is an abstraction of the low-level kernel features
23-
used to run and manage containers on a system.
24-
It's a platform used in container software like Docker and Kubernetes.
20+
`containerd` is a container runtime that provides a lightweight, consistent interface for container lifecycle management. It is already used under the hood by Docker Engine for creating, starting, and stopping containers.
2521

26-
Docker Engine already uses `containerd` for container lifecycle management,
27-
which includes creating, starting, and stopping containers.
28-
This page describes the next step of the containerd integration for Docker:
29-
the containerd image store.
22+
Docker Desktop’s ongoing integration of containerd now extends to the image store, offering more flexibility and modern image support.
3023

31-
## Image store
24+
## What is the `containerd` image store?
3225

3326
The image store is the component responsible for pushing, pulling,
3427
and storing images on the filesystem.
28+
3529
The classic Docker image store is limited in the types of images that it supports.
3630
For example, it doesn't support image indices, containing manifest lists.
3731
When you create multi-platform images, for example,
3832
the image index resolves all the platform-specific variants of the image.
3933
An image index is also required when building images with attestations.
4034

41-
The containerd image store extends range of image types
35+
The containerd image store extends the range of image types
4236
that the Docker Engine can natively interact with.
4337
While this is a low-level architectural change,
4438
it's a prerequisite for unlocking a range of new use cases, including:
@@ -88,8 +82,4 @@ and load them to your local image store:
8882

8983
<script async id="asciicast-ZSUI4Mi2foChLjbevl2dxt5GD" src="https://asciinema.org/a/ZSUI4Mi2foChLjbevl2dxt5GD.js"></script>
9084

91-
## Feedback
9285

93-
Thanks for trying the new features available with `containerd`. Give feedback or
94-
report any bugs you may find through the issues tracker on the
95-
[feedback form](https://dockr.ly/3PODIhD).

content/manuals/desktop/features/desktop-cli.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
---
2-
title: Using the Docker Desktop CLI
2+
title: Use the Docker Desktop CLI
33
linkTitle: Docker Desktop CLI
4-
weight: 120
4+
weight: 100
55
description: How to use the Docker Desktop CLI
66
keywords: cli, docker desktop, macos, windows, linux
7-
params:
8-
sidebar:
9-
badge:
10-
color: green
11-
text: New
127
---
138

149
{{< summary-bar feature_name="Docker Desktop CLI" >}}

content/manuals/desktop/features/dev-environments/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: Dev Environments
33
keywords: Dev Environments, share, local, Compose
44
title: Overview of Dev Environments
55
linkTitle: Dev Environments
6-
weight: 40
6+
weight: 130
77
aliases:
88
- /desktop/dev-environments/
99
params:

content/manuals/desktop/features/gordon/_index.md

Lines changed: 30 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,22 @@ of the Docker ecosystem.
1717

1818
## What is Ask Gordon?
1919

20-
Ask Gordon is a suite of AI-powered capabilities integrated into Docker's tools.
21-
These features, currently in Beta, are not enabled by default, and are not
22-
production-ready. You may also encounter the term "Docker AI" as a broader
23-
reference to this technology.
20+
Ask Gordon provides AI-powered assistance in Docker tools. It offers contextual help for tasks like:
21+
22+
- Improving Dockerfiles
23+
- Running and troubleshooting containers
24+
- Interacting with your images and code
25+
- Finding vulnerabilities or configuration issues
2426

25-
The goal of Ask Gordon is to make Docker's tools for managing images and
26-
containers more intuitive and accessible. It provides contextual assistance
27-
tailored to your local environment, including Dockerfiles, containers, and
28-
applications.
27+
It understands your local environment, including source code, Dockerfiles, and images, to provide personalized and actionable guidance.
2928

30-
Ask Gordon integrates directly with Docker's tools to help you perform specific
31-
tasks. It understands your local setup, such as your local source code and
32-
images. For example, you can ask Gordon to help you identify vulnerabilities in
33-
your project or how to optimize a Dockerfile in your local repository. This
34-
tight integration ensures responses are practical and actionable.
29+
These features are not enabled by default, and are not
30+
production-ready. You may also encounter the term "Docker AI" as a broader
31+
reference to this technology.
3532

36-
> [!NOTE] Ask Gordon is powered by Large Language Models (LLMs). Like all
33+
> [!NOTE]
34+
>
35+
> Ask Gordon is powered by Large Language Models (LLMs). Like all
3736
> LLM-based tools, its responses may sometimes be inaccurate. Always verify the
3837
> information provided.
3938
@@ -81,55 +80,32 @@ making it more effective for all users.
8180
If you have concerns about data collection or usage, you can
8281
[disable](#disable-ask-gordon) the feature at any time.
8382

84-
## Setup
85-
86-
To use this feature, you must have:
87-
88-
- Docker Desktop version 4.38 or later.
89-
90-
Ask Gordon is not enabled by default. To enable the feature:
91-
92-
1. [Sign in](#sign-in) to your Docker account.
93-
2. [Enable the feature](#enable-the-feature) in the Docker Desktop settings.
83+
## Enable Ask Gordon
9484

95-
### Sign in
96-
97-
1. Open Docker Desktop.
98-
2. Select the **Sign in** button.
99-
3. Complete the sign-in process in your web browser.
100-
101-
### Enable the feature
102-
103-
After signing in to your Docker Account, enable the Docker AI feature:
104-
105-
1. Navigate to the **Features in development** tab in settings.
106-
2. Under the **Experimental features** tab, select **Access experimental features**.
107-
3. Select **Apply and restart**.
108-
4. Quit and reopen Docker Desktop to ensure the changes take effect.
109-
5. Open the **Settings** view in Docker Desktop.
110-
6. Navigate to **Features in development**.
111-
7. From the **Beta** tab, check the **Enable Docker AI** checkbox.
85+
1. Sign in to your Docker account.
86+
2. Navigate to the **Features in development** tab in settings.
87+
3. Under the **Experimental features** tab, select **Access experimental features**.
88+
4. Select **Apply and restart**.
89+
5. Quit and reopen Docker Desktop to ensure the changes take effect.
90+
6. Open the **Settings** view in Docker Desktop.
91+
7. Navigate to **Features in development**.
92+
8. From the **Beta** tab, check the **Enable Docker AI** checkbox.
11293

11394
The Docker AI terms of service agreement is displayed. You must agree to the
11495
terms before you can enable the feature. Review the terms and select **Accept
11596
and enable** to continue.
11697

117-
8. Select **Apply & restart**.
98+
9. Select **Apply & restart**.
11899

119100
## Using Ask Gordon
120101

121102
The primary interfaces to Docker's AI capabilities are through the **Ask
122103
Gordon** view in Docker Desktop, or if you prefer to use the CLI: the `docker
123104
ai` CLI command.
124105

125-
If you've used an AI chatbot before, these interfaces will be pretty familiar to
126-
you. You can chat with the Docker AI to get help with your Docker tasks.
127-
128-
### Contextual help
129-
130106
Once you've enabled the Docker AI features, you'll also find references to **Ask
131107
Gordon** in various other places throughout the Docker Desktop user interface.
132-
Whenever you encounter a button with the "sparkles" (✨) icon in the user
108+
Whenever you encounter a button with the **Sparkles** (✨) icon in the user
133109
interface, you can use the button to get contextual support from Ask Gordon.
134110

135111
## Example workflows
@@ -179,7 +155,7 @@ able to help you get set up:
179155
2. Open the **Images** view in Docker Desktop and select the image.
180156
3. Select the **Run** button.
181157

182-
In the _Run a new container_ dialog that opens, you should see a message about
158+
In the **Run a new container** dialog, you should see a message about
183159
**Ask Gordon**.
184160

185161
![Ask Gordon hint in Docker Desktop](../../images/gordon-run-ctr.png)
@@ -218,13 +194,17 @@ across several dimensions:
218194

219195
## Disable Ask Gordon
220196

197+
### For individual users
198+
221199
If you've enabled Ask Gordon and you want to disable it again:
222200

223201
1. Open the **Settings** view in Docker Desktop.
224202
2. Navigate to **Features in development**.
225203
3. Clear the **Enable Docker AI** checkbox.
226204
4. Select **Apply & restart**.
227205

206+
### For organizations
207+
228208
If you want to disable Ask Gordon for your entire Docker organization, using
229209
[Settings
230210
Management](/manuals/security/for-admins/hardened-desktop/settings-management/_index.md),
@@ -271,4 +251,4 @@ here's how you can get in touch:
271251
the **Ask Gordon** view in Docker Desktop, or from the CLI by running the
272252
`docker ai feedback` command.
273253

274-
Thank you for helping us improve Ask Gordon.
254+

0 commit comments

Comments
 (0)