Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _vale/config/vocabularies/Docker/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Jamf
JetBrains
Kerberos
Kitematic
Kubeadm
Kubernetes
Laravel
Laradock
Expand Down
47 changes: 18 additions & 29 deletions content/contribute/components/call-outs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,25 @@ toc_max: 3

We support these broad categories of callouts:

- Alerts (Note, Tip, Important, Warning, Caution)
- Version callouts
- Experimental, which use the `{{%/* experimental */%}}` shortcode
- Restricted, which use the `{{%/* restricted */%}}` shortcode
- Alerts: Note, Tip, Important, Warning, Caution

The experimental and restricted shortcodes take a title as an argument. The
title is optional, defaults to "Experimental" or "Restricted" respectively, and
is displayed in the callout.
We also support summary bars, which represent a feature's required subscription, version, or Adminstrator role.
To add a summary bar:

Add the feature name to the `/data/summary.yaml` file. Use the following attributes:

| Attribute | Description | Possible values |
|----------------|--------------------------------------------------------|---------------------------------------------------------|
| `subscription` | Notes the subscription required to use the feature | All, Personal, Pro, Team, Business |
| `availability` | Notes what product development stage the feature is in | Experimental, Beta, Early access, GA, Retired |
| `requires` | Notes what minimum version is required for the feature | No specific value, use a string to describe the version and link to relevant release notes |
| `for` | Notes if the feature is intended for IT Administrators | Administrators |

Then, add the `summary-bar` shortcode on the page you want to add the summary bar to. Note, the feature name is case sensitive. The icons that appear in the summary bar are automatically rendered.

## Examples

{{< introduced buildx 0.16.0 >}}
{{< summary-bar feature_name="PKG installer" >}}

> [!NOTE]
>
Expand Down Expand Up @@ -54,18 +61,10 @@ is displayed in the callout.

For both of the following callouts, consult [the Docker release lifecycle](/release-lifecycle) for more information on when to use them.

{{% experimental title="Beta feature" %}}
The Builds view is currently in Beta. This feature may change or be removed from future releases.
{{% /experimental %}}

{{% restricted %}}
Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
{{% /restricted %}}

## Formatting
## Formatting

```go
{{</* introduced buildx 0.10.4 "../../release-notes.md#0104" */>}}
> {{< summary-bar feature_name="PKG installer" >}}
```

```html
Expand Down Expand Up @@ -101,14 +100,4 @@ Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
> [!CAUTION]
>
> Here be dragons.
```

```go
{{%/* experimental title="Beta feature" */%}}
The Builds view is currently in Beta. This feature may change or be removed from future releases.
{{%/* /experimental */%}}

{{%/* restricted */%}}
Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
{{%/* /restricted */%}}
```
```
2 changes: 1 addition & 1 deletion content/manuals/build/builders/drivers/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ To build an image using a non-default driver and load it to the image store,

### Load by default

{{< introduced buildx 0.14.0 >}}
{{< summary-bar feature_name="Load by default" >}}

You can configure the custom build drivers to behave in a similar way to the
default `docker` driver, and load images to the local image store by default.
Expand Down
20 changes: 10 additions & 10 deletions content/manuals/build/building/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Setting `NO_COLOR` to anything turns off colorized output, as recommended by

### BUILDKIT_HOST

{{< introduced buildx 0.9.0 "../release-notes.md#090" >}}
{{< summary-bar feature_name="Buildkit host" >}}

You use the `BUILDKIT_HOST` to specify the address of a BuildKit daemon to use
as a remote builder. This is the same as specifying the address as a positional
Expand Down Expand Up @@ -438,7 +438,7 @@ Example:

### BUILDX_BAKE_GIT_AUTH_HEADER

{{< introduced buildx 0.14.0 >}}
{{< summary-bar feature_name="Buildx bake Git auth token" >}}

Sets the HTTP authentication scheme when using a remote Bake definition in a private Git repository.
This is equivalent to the [`GIT_AUTH_HEADER` secret](./secrets#http-authentication-scheme),
Expand All @@ -453,7 +453,7 @@ $ export BUILDX_BAKE_GIT_AUTH_HEADER=basic

### BUILDX_BAKE_GIT_AUTH_TOKEN

{{< introduced buildx 0.14.0 >}}
{{< summary-bar feature_name="Buildx bake Git auth token" >}}

Sets the HTTP authentication token when using a remote Bake definition in a private Git repository.
This is equivalent to the [`GIT_AUTH_TOKEN` secret](./secrets#git-authentication-for-remote-contexts),
Expand All @@ -467,7 +467,7 @@ $ export BUILDX_BAKE_GIT_AUTH_TOKEN=$(cat git-token.txt)

### BUILDX_BAKE_GIT_SSH

{{< introduced buildx 0.14.0 >}}
{{< summary-bar feature_name="Buildx bake Git SSH" >}}

Lets you specify a list of SSH agent socket filepaths to forward to Bake
for authenticating to a Git server when using a remote Bake definition in a private repository.
Expand Down Expand Up @@ -512,7 +512,7 @@ $ export BUILDX_CONFIG=/usr/local/etc

### BUILDX_CPU_PROFILE

{{< introduced buildx 0.18.0 >}}
{{< summary-bar feature_name="Buildx CPU profile" >}}

If specified, Buildx generates a `pprof` CPU profile at the specified location.

Expand All @@ -538,7 +538,7 @@ $ export BUILDX_EXPERIMENTAL=1

### BUILDX_GIT_CHECK_DIRTY

{{< introduced buildx 0.10.4 "../release-notes.md#0104" >}}
{{< summary-bar feature_name="Buildx Git check dirty" >}}

When set to true, checks for dirty state in source control information for
[provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md).
Expand All @@ -551,7 +551,7 @@ $ export BUILDX_GIT_CHECK_DIRTY=1

### BUILDX_GIT_INFO

{{< introduced buildx 0.10.0 "../release-notes.md#0100" >}}
{{< summary-bar feature_name="Buildx Git info" >}}

When set to false, removes source control information from
[provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md).
Expand All @@ -564,7 +564,7 @@ $ export BUILDX_GIT_INFO=0

### BUILDX_GIT_LABELS

{{< introduced buildx 0.10.0 "../release-notes.md#0100" >}}
{{< summary-bar feature_name="Buildx Git labels" >}}

Adds provenance labels, based on Git information, to images that you build. The
labels are:
Expand Down Expand Up @@ -593,7 +593,7 @@ If the repository is in a dirty state, the `revision` gets a `-dirty` suffix.

### BUILDX_MEM_PROFILE

{{< introduced buildx 0.18.0 >}}
{{< summary-bar feature_name="Buildx mem profile" >}}

If specified, Buildx generates a `pprof` memory profile at the specified
location.
Expand All @@ -610,7 +610,7 @@ $ export BUILDX_MEM_PROFILE=buildx_mem.prof

### BUILDX_NO_DEFAULT_ATTESTATIONS

{{< introduced buildx 0.10.4 "../release-notes.md#0104" >}}
{{< summary-bar feature_name="Buildx no default" >}}

By default, BuildKit v0.11 and later adds
[provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md) to images you
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/build/exporters/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ WARNING: No output specified with docker-container driver.

## Multiple exporters

{{< introduced buildx 0.13.0 >}}
{{< summary-bar feature_name="Build multiple exporters" >}}

You can use multiple exporters for any given build by specifying the `--output`
flag multiple times. This requires **both Buildx and BuildKit** version 0.13.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ If `COMPOSE_ENV_FILES` is not set, and you don't provide `--env-file` in the CLI

### COMPOSE\_MENU

{{< introduced compose 2.26.0 "/manuals/compose/releases/release-notes.md#2260" >}}
{{< summary-bar feature_name="Compose menu" >}}

When enabled, Compose displays a navigation menu where you can choose to open the Compose stack in Docker Desktop, switch on [`watch` mode](../file-watch.md), or use [Docker Debug](/reference/cli/docker/debug.md).

Expand All @@ -183,7 +183,7 @@ When enabled, Compose displays a navigation menu where you can choose to open th

### COMPOSE\_EXPERIMENTAL

{{< introduced compose 2.26.0 "/manuals/compose/releases/release-notes.md#2260" >}}
{{< summary-bar feature_name="Compose experimental" >}}

This is an opt-out variable. When turned off it deactivates the experimental features such as the navigation menu or [Synchronized file shares](/manuals/desktop/features/synchronized-file-sharing.md).

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/compose/how-tos/file-watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases:
- /compose/file-watch/
---

{{< introduced compose 2.22.0 "/manuals/compose/releases/release-notes.md#2220" >}}
{{< summary-bar feature_name="Compose file watch" >}}

{{% include "compose/watch.md" %}}

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/compose/how-tos/lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ desription: How to use lifecycle hooks with Docker Compose
keywords: cli, compose, lifecycle, hooks reference
---

{{< introduced compose 2.30.0 "../releases/release-notes.md#2300" >}}
{{< summary-bar feature_name="Compose lifecycle hooks" >}}

## Services lifecycle hooks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliases:
- /compose/multiple-compose-files/include/
---

{{< introduced compose 2.20.3 "/manuals/compose/releases/release-notes.md#2203" >}}
{{< summary-bar feature_name="Compose include" >}}

{{% include "compose/include.md" %}}

Expand Down
6 changes: 4 additions & 2 deletions content/manuals/desktop/features/desktop-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ params:

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

The Docker Desktop CLI lets you perform key operations such as starting, stopping, restarting, and checking the status of Docker Desktop directly from the command line. It is available with Docker Desktop version 4.37 and later.
The Docker Desktop CLI lets you perform key operations such as starting, stopping, restarting, and checking the status of Docker Desktop directly from the command line.

The Docker Desktop CLI provides:

Expand All @@ -35,6 +35,8 @@ docker desktop COMMAND [OPTIONS]
| `restart` | Restarts Docker Desktop |
| `status` | Displays whether Docker Desktop is running or stopped. |
| `engine ls` | Lists available engines (Windows only) |
| `engine use` | Switch between Linux and Windows containers (Windows only) |
| `engine use` | Switch between Linux and Windows containers (Windows only) |
| `update` | Manage Docker Desktop updates. Available for Mac only and with Docker Desktop version 4.38 and later. |


For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/_index.md).
40 changes: 8 additions & 32 deletions content/manuals/desktop/features/gordon.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,7 @@ params:
text: Beta
---

{{% restricted title=Beta %}}
Ask Gordon is a [Beta](/manuals/release-lifecycle.md) feature, and only members
of the Ask Gordon beta program can access it. Features, user interface, and
behavior are subject to change in future releases.

{{< button text="Apply for access" url="https://docker.qualtrics.com/jfe/form/SV_dmVHFjQ4fZlrEOy" >}}
{{% /restricted %}}
{{< summary-bar feature_name="Ask Gordon" >}}

Ask Gordon is your personal AI assistant embedded in Docker Desktop and the
Docker CLI. It's designed to streamline your workflow and help you make the
Expand Down Expand Up @@ -61,7 +55,8 @@ To provide accurate responses, Ask Gordon may send relevant files, directories,
or image metadata to the Gordon backend along with your query. This data
transfer occurs over the network but is never stored persistently or shared
with third parties. It is used exclusively to process your request and
formulate a response.
formulate a response. For more information about privacy terms and conditions
for Docker AI, review [Gordon's Supplemental Terms](https://www.docker.com/legal/docker-ai-supplemental-terms/).

All data transferred is encrypted in transit.

Expand Down Expand Up @@ -90,16 +85,12 @@ If you have concerns about data collection or usage, you can

To use this feature, you must have:

- [Access to the Ask Gordon beta program](https://docker.qualtrics.com/jfe/form/SV_dmVHFjQ4fZlrEOy).

- Docker Desktop version 4.37 or later.
- Docker Desktop version 4.38 or later.

Ask Gordon is not enabled by default. After having received access to the beta
program, you must enable the feature:
Ask Gordon is not enabled by default. To enable the feature:

1. [Sign in](#sign-in) to your Docker account.
2. [Enable the feature](#enable-the-feature) in the Docker Desktop settings.
3. [Accept the terms of service](#accept-the-terms-of-service).

### Sign in

Expand All @@ -114,26 +105,11 @@ After signing in to your Docker Account, enable the Docker AI feature:
1. Open the **Settings** view in Docker Desktop.
2. Navigate to **Features in development**.
3. Check the **Enable Docker AI** checkbox.
4. Select **Apply & restart**.

### Accept the terms of service

To start using Docker AI, you need to accept the terms of service. You can do
this in one of two ways:

- Open the **Ask Gordon** view in Docker Desktop and ask a question.
- Use the `docker ai` CLI command to issue a query.

The first time you interact with Docker AI, you'll see a prompt to accept the
terms of service. For example:
The Docker AI terms of service agreement is displayed. You must agree to the
terms before you can enable the feature. Review the terms and select **Accept and enable** to continue.

```console
$ docker ai what can you do?

Before using Gordon, please accept the terms of service
```

After accepting the terms, you can begin using Ask Gordon.
4. Select **Apply & restart**.

## Using Ask Gordon

Expand Down
20 changes: 15 additions & 5 deletions content/manuals/desktop/features/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: See how you can deploy to Kubernetes on Docker Desktop
keywords: deploy, kubernetes, kubectl, orchestration, Docker Desktop
title: Deploy on Kubernetes with Docker Desktop
linkTitle: Deploy on Kubernetes
aliases:
- /docker-for-windows/kubernetes/
- /docker-for-mac/kubernetes/
Expand All @@ -11,7 +12,7 @@ weight: 60

Docker Desktop includes a standalone Kubernetes server and client, as well as Docker CLI integration, enabling local Kubernetes development and testing directly on your machine.

The Kubernetes server runs as a single-node cluster within a Docker container. This lightweight setup helps you explore Kubernetes features, test workloads, and work with container orchestration in parallel with other Docker functionalities.
The Kubernetes server runs as a single or multi-node cluster within a Docker container. This lightweight setup helps you explore Kubernetes features, test workloads, and work with container orchestration in parallel with other Docker functionalities.

Kubernetes on Docker Desktop runs alongside other workloads, including Swarm services and standalone containers.

Expand All @@ -30,8 +31,11 @@ Turning the Kubernetes server on or off in Docker Desktop does not affect your o

1. Open the Docker Desktop Dashboard and navigate to **Settings**.
2. Select the **Kubernetes** tab.
3. Select the **Enable Kubernetes** checkbox.
4. Select **Apply & Restart** to save the settings and then select **Install** to confirm. This sets up the images required to run the Kubernetes server as containers, and installs the `kubectl` command-line tool on your system at `/usr/local/bin/kubectl` (Mac) or `C:\Program Files\Docker\Docker\Resources\bin\kubectl.exe` (Windows).
3. Toggle on **Enable Kubernetes**.
4. Choose your cluster provisioning method. You can choose either **Kubeadm** or **kind** if you are signed in and are using Docker Desktop version 4.38 or later.

If you select **kind** you can also choose the Kubernetes version and the number of nodes.
5. Select **Apply & Restart** to save the settings. This sets up the images required to run the Kubernetes server as containers, and installs the `kubectl` command-line tool on your system at `/usr/local/bin/kubectl` (Mac) or `C:\Program Files\Docker\Docker\Resources\bin\kubectl.exe` (Windows).

> [!NOTE]
>
Expand All @@ -45,9 +49,15 @@ You can check which version of Kubernetes you're on with:
$ kubectl version
```

### Viewing system containers
### Additional settings

#### Kubernetes dashboard

Once Kubernetes is installed and set up, you can select the **Deploy the Kubernetes Dashboard into cluster** setting so you can manage and monitor your Kubernetes clusters and applications more easily.

#### Viewing system containers

By default, Kubernetes system containers are hidden. To inspect these containers, navigate to **Settings** > **Kubernetes** and then enable **Show system containers (advanced)**.
By default, Kubernetes system containers are hidden. To inspect these containers, enable **Show system containers (advanced)**.

You can now view the running Kubernetes containers with `docker ps` or in the Docker Desktop Dashboard.

Expand Down
4 changes: 2 additions & 2 deletions content/manuals/desktop/features/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ syntax for `-p` is `HOST_PORT:CLIENT_PORT`.

See [Proxies](/manuals/desktop/settings-and-maintenance/settings.md#proxies)

### SOCKS5 proxy support
### SOCKS5 proxy support

{{< introduced desktop 4.28.0 "../release-notes.md#4280" >}}
{{< summary-bar feature_name="SOCKS5 proxy support" >}}

> [!NOTE]
>
Expand Down
Loading