diff --git a/content/contribute/contribute-guide.md b/content/contribute/contribute-guide.md index 24ce418a1e..e2c4bb4b9f 100644 --- a/content/contribute/contribute-guide.md +++ b/content/contribute/contribute-guide.md @@ -77,7 +77,9 @@ Then, build and run the documentation using [Docker Compose](../compose/index.md docker compose up -d --build ``` -> You need Docker Compose to build and run the docs locally. Docker Compose is included with [Docker Desktop](../desktop/index.md). +> **Note** +> +>You need Docker Compose to build and run the docs locally. Docker Compose is included with [Docker Desktop](../desktop/index.md). > If you don't have Docker Desktop installed, follow the [instructions](../compose/install/index.md) to install Docker Compose. When the container is built and running, visit [http://localhost:4000](http://localhost:4000) in your web browser to view the docs. diff --git a/content/desktop/containerd/_index.md b/content/desktop/containerd/_index.md index 8399399fcc..075f632c17 100644 --- a/content/desktop/containerd/_index.md +++ b/content/desktop/containerd/_index.md @@ -167,7 +167,8 @@ Inspecting the tag on Docker Hub shows that the image is available for multiple > > If you're using an older version, the Docker daemon reports the following > error: - > `Multiple platforms feature is currently not supported for docker driver. Please switch to a different driver`. + > `Multiple platforms feature is currently not supported for docker driver.` + > `Please switch to a different driver`. > > Install a newer version of Buildx following the instructions on > [how to manually download Buildx](../../build/architecture.md#install-buildx). diff --git a/content/desktop/dev-environments/create-dev-env.md b/content/desktop/dev-environments/create-dev-env.md index 48d1ddc52d..9bc164fde7 100644 --- a/content/desktop/dev-environments/create-dev-env.md +++ b/content/desktop/dev-environments/create-dev-env.md @@ -46,13 +46,11 @@ To get started with Dev Environments, you must also install the following tools > If you have enabled the WSL 2 integration in Docker Desktop for Windows, make sure you have an SSH agent running in your WSL 2 distribution. { .important } -
- -
- If your WSL 2 distribution doesn't have an `ssh-agent` running, you can append this script at the end of your profile file (that is: ~/.profile, ~/.zshrc, ...). -

+{{< accordion title="How to start an SSH agent in WSL 2" >}}
+
+If your WSL 2 distribution doesn't have an `ssh-agent` running, you can append this script at the end of your profile file (that is: ~/.profile, ~/.zshrc, ...).
+
+```
 SSH_ENV="$HOME/.ssh/agent-environment"
 function start_agent {
     echo "Initialising new SSH agent..."
@@ -70,9 +68,9 @@ if [ -f "${SSH_ENV}" ]; then
 else
     start_agent;
 fi
-
-
-
+``` + +{{< /accordion >}} To launch a dev environment: diff --git a/content/desktop/extensions-sdk/_index.md b/content/desktop/extensions-sdk/_index.md index 0f360de5b3..0a6e8942cd 100644 --- a/content/desktop/extensions-sdk/_index.md +++ b/content/desktop/extensions-sdk/_index.md @@ -4,6 +4,31 @@ description: Overall index for Docker Extensions SDK documentation keywords: Docker, Extensions, sdk aliases: - /desktop/extensions-sdk/dev/overview/ +grid: + - title: "The build and publish process" + description: Understand the process for building and publishing an extension. + icon: "checklist" + link: "/desktop/extensions-sdk/process/" + - title: "Quickstart guide" + description: Follow the quickstart guide to build a basic Docker Extension quickly. + icon: "explore" + link: "/desktop/extensions-sdk/quickstart/" + - title: "View the design guidelines" + description: Ensure your extension aligns to Docker's design guidelines and principles. + icon: "design_services" + link: "/desktop/extensions-sdk/design/design-guidelines/" + - title: "Publish your extension" + description: Understand how to publish your extension to the Marketplace. + icon: "publish" + link: "/desktop/extensions-sdk/extensions/" + - title: "Interacting with Kubernetes" + description: Find information on how to interact indirectly with a Kubernetes cluster from your Docker Extension. + icon: "multiple_stop" + link: "/desktop/extensions-sdk/dev/kubernetes/" + - title: "Multi-arch extensions" + description: Build your extension for multiple architectures. + icon: "content_copy" + link: "/desktop/extensions-sdk/extensions/multi-arch/" --- The resources in this section help you create your own Docker extension. @@ -22,65 +47,4 @@ the extension to Docker Hub. See [Extensions distribution](extensions/DISTRIBUTI {{< include "extensions-form.md" >}} -
- -
-
-
-
- Process -
-

The build and publish process

-

Understand the process for building and publishing an extension.

-
-
-
-
-
- Quickstart -
-

Quickstart guide

-

Follow the quickstart guide to build a basic Docker Extension quickly.

-
-
-
-
-
- Design quidelines -
-

View the design guidelines

-

Ensure your extension aligns to Docker's design guidelines and principles.

-
-
-
- -
-
-
-
- Publish -
-

Publish your extension

-

Understand how to publish your extension to the Marketplace.

-
-
-
-
-
- Kubernetes -
-

Interacting with Kubernetes

-

Find information on how to interact indirectly with a Kubernetes cluster from your Docker Extension.

-
-
-
-
-
- Multi-arch -
-

Multi-arch extensions

-

Build your extension for multiple architectures.

-
-
-
-
\ No newline at end of file +{{< grid >}} diff --git a/content/desktop/extensions-sdk/dev/api/docker.md b/content/desktop/extensions-sdk/dev/api/docker.md index b542a8a1eb..846388d424 100644 --- a/content/desktop/extensions-sdk/dev/api/docker.md +++ b/content/desktop/extensions-sdk/dev/api/docker.md @@ -128,7 +128,9 @@ await ddClient.docker.cli.exec( ); ``` -> You cannot use this to chain commands in a single `exec()` invocation (like `docker kill $(docker ps -q)` or using pipe between commands). +> **Note** +> +>You cannot use this to chain commands in a single `exec()` invocation (like `docker kill $(docker ps -q)` or using pipe between commands). > > You need to invoke `exec()` for each command and parse results to pass parameters to the next command if needed. diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0.md b/content/desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0.md index 2c336b4502..44d0825532 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0.md +++ b/content/desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0.md @@ -20,9 +20,9 @@ const output = await window.ddClient.backend.execInContainer(container, cmd); console.log(output); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. +> **Warning** +> +> It will be removed in a future version. #### Parameters @@ -51,9 +51,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [get](HttpService.md#get) instead. +> **Warning** +> +> It will be removed in a future version. Use [get](HttpService.md#get) instead. #### Parameters @@ -79,9 +79,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [post](HttpService.md#post) instead. +> **Warning** +> +> It will be removed in a future version. Use [post](HttpService.md#post) instead. #### Parameters @@ -108,9 +108,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [put](HttpService.md#put) instead. +> **Warning** +> +> It will be removed in a future version. Use [put](HttpService.md#put) instead. #### Parameters @@ -137,9 +137,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [patch](HttpService.md#patch) instead. +> **Warning** +> +> It will be removed in a future version. Use [patch](HttpService.md#patch) instead. #### Parameters @@ -166,9 +166,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [delete](HttpService.md#delete) instead. +> **Warning** +> +> It will be removed in a future version. Use [delete](HttpService.md#delete) instead. #### Parameters @@ -194,9 +194,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [head](HttpService.md#head) instead. +> **Warning** +> +> It will be removed in a future version. Use [head](HttpService.md#head) instead. #### Parameters @@ -222,9 +222,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [request](HttpService.md#request) instead. +> **Warning** +> +> It will be removed in a future version. Use [request](HttpService.md#request) instead. #### Parameters @@ -255,9 +255,9 @@ const output = await window.ddClient.backend.execInVMExtension( console.log(output); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. +> **Warning** +> +> It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. #### Parameters @@ -291,9 +291,9 @@ window.ddClient.spawnInVMExtension( ); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. +> **Warning** +> +> It will be removed in a future version. #### Parameters diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md b/content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md index 1771bc47b1..f5ff3b6808 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md +++ b/content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md @@ -20,9 +20,9 @@ The `window.ddClient.backend` object can be used to communicate with the backend the extension metadata. The client is already connected to the backend. -**`Deprecated`** - -:warning: It will be removed in a future version. Use [extension](DockerDesktopClient.md#extension) instead. +>**Warning** +> +> It will be removed in a future version. Use [extension](DockerDesktopClient.md#extension) instead. #### Inherited from @@ -87,9 +87,9 @@ You can use the option `{"all": true}` to list all the running and stopped conta const containers = await window.ddClient.listContainers(); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [listContainers](Docker.md#listcontainers) instead. +>**Warning** +> +> It will be removed in a future version. Use [listContainers](Docker.md#listcontainers) instead. #### Parameters @@ -119,9 +119,9 @@ Get the list of images const images = await window.ddClient.listImages(); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [listImages](Docker.md#listimages) instead. +> **Warning** +> +> It will be removed in a future version. Use [listImages](Docker.md#listimages) instead. #### Parameters @@ -150,9 +150,9 @@ Navigate to the containers window in Docker Desktop. window.ddClient.navigateToContainers(); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [viewContainers](NavigationIntents.md#viewcontainers) instead. +> **Warning** +> +> It will be removed in a future version. Use [viewContainers](NavigationIntents.md#viewcontainers) instead. #### Returns @@ -173,9 +173,9 @@ Navigate to the container window in Docker Desktop. await window.ddClient.navigateToContainer(id); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. +> **Warning** +> +> It will be removed in a future version. #### Parameters @@ -204,9 +204,9 @@ Navigate to the container logs window in Docker Desktop. await window.ddClient.navigateToContainerLogs(id); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. +> **Warning** +> +> It will be removed in a future version. #### Parameters @@ -235,9 +235,9 @@ Navigate to the container inspect window in Docker Desktop. await window.ddClient.navigateToContainerInspect(id); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. +> **Warning** +> +> It will be removed in a future version. #### Parameters @@ -267,9 +267,9 @@ Navigate to the container stats to see the CPU, memory, disk read/write and netw await window.ddClient.navigateToContainerStats(id); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. +> **Warning** +> +> It will be removed in a future version. #### Parameters @@ -298,9 +298,9 @@ Navigate to the images window in Docker Desktop. await window.ddClient.navigateToImages(id); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [viewImages](NavigationIntents.md#viewimages) instead. +> **Warning** +> +> It will be removed in a future version. Use [viewImages](NavigationIntents.md#viewimages) instead. #### Returns @@ -323,9 +323,9 @@ In this navigation route you can find the image layers, commands, created time a await window.ddClient.navigateToImage(id, tag); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [viewImage](NavigationIntents.md#viewimage) instead. +> **Warning** +> +> It will be removed in a future version. Use [viewImage](NavigationIntents.md#viewimage) instead. #### Parameters @@ -356,9 +356,9 @@ Navigate to the volumes window in Docker Desktop. await window.ddClient.navigateToVolumes(); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [viewVolumes](NavigationIntents.md#viewvolumes) instead. +> **Warning** +> +> It will be removed in a future version. Use [viewVolumes](NavigationIntents.md#viewvolumes) instead. #### Returns @@ -380,9 +380,9 @@ Navigate to a specific volume in Docker Desktop. window.ddClient.navigateToVolume(volume); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [viewVolume](NavigationIntents.md#viewvolume) instead. +> **Warning** +> +> It will be removed in a future version. Use [viewVolume](NavigationIntents.md#viewvolume) instead. #### Parameters @@ -410,9 +410,9 @@ Navigate to the Dev Environments window in Docker Desktop. window.ddClient.navigateToDevEnvironments(); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [viewDevEnvironments](NavigationIntents.md#viewdevenvironments) instead. +> **Warning** +> +> It will be removed in a future version. Use [viewDevEnvironments](NavigationIntents.md#viewdevenvironments) instead. #### Returns @@ -438,9 +438,9 @@ window.ddClient.execHostCmd(`cliShippedOnHost xxx`).then((cmdResult: any) => { }); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. +> **Warning** +> +> It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. #### Parameters @@ -478,9 +478,9 @@ window.ddClient.spawnHostCmd( ); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. +> **Warning** +> +> It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. #### Parameters @@ -510,9 +510,9 @@ You can also directly execute the docker binary. const output = await window.ddClient.execDockerCmd("info"); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [exec](DockerCommand.md#exec) instead. +> **Warning** +> +> It will be removed in a future version. Use [exec](DockerCommand.md#exec) instead. #### Parameters @@ -557,9 +557,9 @@ ___ ▸ **spawnDockerCmd**(`cmd`, `args`, `callback`): `void` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [exec](DockerCommand.md#exec) instead. +> **Warning** +> +> It will be removed in a future version. Use [exec](DockerCommand.md#exec) instead. #### Parameters @@ -589,9 +589,9 @@ Opens an external URL with the system default browser. window.ddClient.openExternal("https://docker.com"); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [openExternal](Host.md#openexternal) instead. +**Warning** +> +> It will be removed in a future version. Use [openExternal](Host.md#openexternal) instead. #### Parameters @@ -621,9 +621,9 @@ Display a toast message of type success. window.ddClient.toastSuccess("message"); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [success](Toast.md#success) instead. +>**Warning`** +> +> It will be removed in a future version. Use [success](Toast.md#success) instead. #### Parameters @@ -651,9 +651,9 @@ Display a toast message of type warning. window.ddClient.toastWarning("message"); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [warning](Toast.md#warning) instead. +> **Warning** +> +> It will be removed in a future version. Use [warning](Toast.md#warning) instead. #### Parameters @@ -681,9 +681,9 @@ Display a toast message of type error. window.ddClient.toastError("message"); ``` -**`Deprecated`** - -:warning: It will be removed in a future version. Use [error](Toast.md#error) instead. +>**Warning** +> +> It will be removed in a future version. Use [error](Toast.md#error) instead. #### Parameters diff --git a/content/desktop/hardened-desktop/_index.md b/content/desktop/hardened-desktop/_index.md index b448b724ad..7cdef5e12c 100644 --- a/content/desktop/hardened-desktop/_index.md +++ b/content/desktop/hardened-desktop/_index.md @@ -4,6 +4,23 @@ description: Overview of what Hardened Docker Desktop is and its key features keywords: security, hardened desktop, enhanced container isolation, registry access management, settings management root access, admins, docker desktop, image access management +grid: + - title: "Settings Management" + description: Learn how Settings Management can secure your developers' workflows. + icon: "lock" + link: "/desktop/hardened-desktop/settings-management/" + - title: "Enhanced Container Isolation" + description: Understand how Enhanced Container Isolation can prevent container attacks. + icon: "security" + link: "/desktop/hardened-desktop/enhanced-container-isolation/" + - title: "Registry Access Management" + description: Control the registries developers can access while using Docker Desktop. + icon: "home_storage" + link: "/desktop/hardened-desktop/registry-access-management/" + - title: "Image Access Management" + description: Control the images developers can pull from Docker Hub. + icon: "photo_library" + link: "/docker-hub/image-access-management/" --- >Note @@ -26,47 +43,4 @@ The features of Hardened Docker Desktop operate independently of each other. Whe Docker plans to continue adding more security enhancements to the Hardened Docker Desktop security model. -
- -
-
-
-
- Hardened Docker Desktop -
-

Settings Management

-

Learn how Settings Management can secure your developers' workflows.

-
-
-
-
-
- Release notes -
-

Enhanced Container Isolation

-

Understand how Enhanced Container Isolation can prevent container attacks.

-
-
-
-
-
- -
-
-
- Hardened Docker Desktop -
-

Registry Access Management

-

Control the registries developers can access while using Docker Desktop.

-
-
-
-
-
- Hardened Docker Desktop -
-

Image Access Management

-

Control the images developers can pull from Docker Hub.

-
-
-
\ No newline at end of file +{{< grid >}} diff --git a/content/desktop/hardened-desktop/enhanced-container-isolation/_index.md b/content/desktop/hardened-desktop/enhanced-container-isolation/_index.md index ea43d1449a..f97a889329 100644 --- a/content/desktop/hardened-desktop/enhanced-container-isolation/_index.md +++ b/content/desktop/hardened-desktop/enhanced-container-isolation/_index.md @@ -152,9 +152,9 @@ This means that the root user in the container (0) is in fact the root user in t Since Enhanced Container Isolation [uses the Sysbox container runtime](how-eci-works.md) embedded in the Docker Desktop Linux VM, another way to determine if a container is running with Enhanced Container Isolation is by using `docker inspect`: -{% highlight liquid %} -docker inspect --format='{{.HostConfig.Runtime}}' my_container -{% endhighlight %} +```console +$ docker inspect --format='{{.HostConfig.Runtime}}' my_container +``` It outputs: diff --git a/content/desktop/install/linux-install.md b/content/desktop/install/linux-install.md index 5ecd44fd4c..86f88b40c9 100644 --- a/content/desktop/install/linux-install.md +++ b/content/desktop/install/linux-install.md @@ -31,10 +31,10 @@ and architectures: | Platform | x86_64 / amd64 | -|:------------------------|:-----------------------| -| [Ubuntu](ubuntu.md) | [{{% param "yes" %}}](ubuntu.md) | -| [Debian](debian.md) | [{{% param "yes" %}}](debian.md) | -| [Fedora](fedora.md) | [{{% param "yes" %}}](fedora.md) | +|:-----------------------|:-----------------------:| +| [Ubuntu](ubuntu.md) | ✅ | +| [Debian](debian.md) | ✅ | +| [Fedora](fedora.md) | ✅ | An experimental package is available for [Arch](archlinux.md)-based distributions. Docker has not tested or verified the installation. diff --git a/content/desktop/install/mac-install.md b/content/desktop/install/mac-install.md index 7ee97a93a5..cd3d377a97 100644 --- a/content/desktop/install/mac-install.md +++ b/content/desktop/install/mac-install.md @@ -46,7 +46,7 @@ This page contains download URLs, information about system requirements, and ins {{< /tab >}} {{< tab name="Mac with Apple silicon" >}} -- Beginning with Docker Desktop 4.3.0, we have removed the hard requirement to install Rosetta 2. There are a few optional command line tools that still require Rosetta 2 when using Darwin/AMD64. See [Known issues](../troubleshoot/known-issues.md). However, to get the best experience, we recommend that you install Rosetta 2. To install Rosetta 2 manually from the command line, run the following command: +Beginning with Docker Desktop 4.3.0, we have removed the hard requirement to install Rosetta 2. There are a few optional command line tools that still require Rosetta 2 when using Darwin/AMD64. See [Known issues](../troubleshoot/known-issues.md). However, to get the best experience, we recommend that you install Rosetta 2. To install Rosetta 2 manually from the command line, run the following command: ```console $ softwareupdate --install-rosetta diff --git a/content/desktop/previous-versions/3.x-windows.md b/content/desktop/previous-versions/3.x-windows.md index 7f0484d60a..3104793bb4 100644 --- a/content/desktop/previous-versions/3.x-windows.md +++ b/content/desktop/previous-versions/3.x-windows.md @@ -19,7 +19,7 @@ This page contains release notes for Docker Desktop for Windows 3.x. > > > -> [For Windows](https://desktop.docker.com/win/stable/amd64/67351/Docker Desktop Installer.exe) +> [For Windows](https://desktop.docker.com/win/stable/amd64/67351/Docker%20Desktop%20Installer.exe) ### New