Skip to content

Commit cb21bfc

Browse files
ECI and Kubernetes Improvements (#21961)
<!--Delete sections as needed --> ## Description * Added an image in the "Deploy on Kubernetes" section showing the Docker Desktop Kubernetes settings. * Updated the ECI FAQs regarding ECI protection for docker build and Kubernetes. ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [X] Editorial review - [ ] Product review --------- Signed-off-by: Cesar Talledo <[email protected]> Co-authored-by: Allie Sadler <[email protected]>
1 parent 8b264bd commit cb21bfc

File tree

3 files changed

+43
-21
lines changed

3 files changed

+43
-21
lines changed

content/manuals/desktop/features/kubernetes.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ aliases:
1010
weight: 60
1111
---
1212

13-
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.
13+
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.
1414

15-
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.
15+
The Kubernetes server runs as a single or multi-node cluster, within Docker container(s). This lightweight setup helps you explore Kubernetes features, test workloads, and work with container orchestration in parallel with other Docker functionalities.
1616

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

19+
![k8s settings](../images/k8s-settings.png)
20+
1921
## What happens when I enable Kubernetes in Docker Desktop?
2022

2123
When you enable Kubernetes in Docker Desktop, the following actions are triggered in the Docker Desktop backend and VM:
@@ -30,18 +32,18 @@ Turning the Kubernetes server on or off in Docker Desktop does not affect your o
3032
## Install and turn on Kubernetes
3133

3234
1. Open the Docker Desktop Dashboard and navigate to **Settings**.
33-
2. Select the **Kubernetes** tab.
35+
2. Select the **Kubernetes** tab.
3436
3. Toggle on **Enable Kubernetes**.
35-
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.
37+
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.
3638

37-
If you select **kind** you can also choose the Kubernetes version and the number of nodes.
39+
If you select **kind** you can also choose the Kubernetes version and the number of nodes.
3840
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).
3941

4042
> [!NOTE]
4143
>
4244
> Docker Desktop for Linux does not include `kubectl` by default. You can install it separately by following the [Kubernetes installation guide](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/). Ensure the `kubectl` binary is installed at `/usr/local/bin/kubectl`.
4345
44-
When Kubernetes is enabled, its status is displayed in the Docker Desktop Dashboard footer and the Docker menu.
46+
When Kubernetes is enabled, its status is displayed in the Docker Desktop Dashboard footer and the Docker menu.
4547

4648
You can check which version of Kubernetes you're on with:
4749

@@ -53,7 +55,7 @@ $ kubectl version
5355

5456
#### Kubernetes dashboard
5557

56-
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.
58+
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.
5759

5860
#### Viewing system containers
5961

@@ -79,7 +81,7 @@ $ kubectl config use-context docker-desktop
7981
> [!TIP]
8082
>
8183
> If the `kubectl` config get-contexts command returns an empty result, try:
82-
>
84+
>
8385
> - Running the command in the Command Prompt or PowerShell.
8486
> - Setting the `KUBECONFIG` environment variable to point to your `.kube/config` file.
8587
@@ -111,13 +113,13 @@ Kubernetes clusters are not automatically upgraded with Docker Desktop updates.
111113
$ kubectl config use-context docker-desktop
112114
```
113115
You can then try checking the logs of the [Kubernetes system containers](#viewing-system-containers) if you have enabled that setting.
114-
- If you're experiencing cluster issues after updating, reset your Kubernetes cluster. Resetting a Kubernetes cluster can help resolve issues by essentially reverting the cluster to a clean state, and clearing out misconfigurations, corrupted data, or stuck resources that may be causing problems. If the issue still persists, you may need to clean and purge data, and then restart Docker Desktop.
116+
- If you're experiencing cluster issues after updating, reset your Kubernetes cluster. Resetting a Kubernetes cluster can help resolve issues by essentially reverting the cluster to a clean state, and clearing out misconfigurations, corrupted data, or stuck resources that may be causing problems. If the issue still persists, you may need to clean and purge data, and then restart Docker Desktop.
115117

116118
## Turn off and uninstall Kubernetes
117119

118120
To turn off Kubernetes in Docker Desktop:
119121

120122
1. From the Docker Desktop Dashboard, select the **Settings** icon.
121-
2. Select the **Kubernetes** tab.
123+
2. Select the **Kubernetes** tab.
122124
3. Deselect the **Enable Kubernetes** checkbox.
123125
4. Select **Apply & Restart** to save the settings. This stops and removes Kubernetes containers, and also removes the `/usr/local/bin/kubectl` command.
135 KB
Loading

content/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/faq.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,22 +69,42 @@ See [ECI Docker socket mount permissions](config.md#docker-socket-mount-permissi
6969
Not yet. It protects all containers launched by users via `docker create` and
7070
`docker run`.
7171

72-
Prior to Docker Desktop 4.30, it did not protect containers implicitly used by
73-
`docker build` with the `docker` build driver (the default driver). Starting
74-
with Docker Desktop 4.30, it protects such containers, except for Docker Desktop
75-
on WSL 2 (Windows hosts).
72+
For containers implicitly created by `docker build` as well as Docker
73+
Desktop's integrated Kubernetes, protection varies depending on the Docker
74+
Desktop version (see the following two FAQs).
7675

77-
Note that ECI always protects containers used by `docker build`, when using the
78-
[docker-container build driver](/manuals/build/builders/drivers/_index.md), since Docker
79-
Desktop 4.19 and on all supported platforms (Windows with WSL 2 or Hyper-V, Mac,
80-
and Linux).
76+
ECI does not yet protect Docker Desktop Extension containers and
77+
[Dev Environments containers](/manuals/desktop/features/dev-environments/_index.md).
8178

82-
ECI does not yet protect Docker Desktop Kubernetes pods, Extension containers,
83-
and [Dev Environments containers](/manuals/desktop/features/dev-environments/_index.md).
79+
### Does ECI protect containers implicitly used by `docker build`?
80+
81+
Prior to Docker Desktop 4.19, ECI did not protect containers used implicitly
82+
by `docker build` during the build process.
83+
84+
Since Docker Desktop 4.19, ECI protects containers used by `docker build`
85+
when using the [Docker container build driver](/manuals/build/builders/drivers/_index.md).
86+
87+
In addition, since Docker Desktop 4.30, ECI also protects containers used by
88+
`docker build` when using the default "docker" build driver, on all
89+
platforms supported by Docker Desktop except Windows with WSL 2.
90+
91+
### Does ECI protect Kubernetes in Docker Desktop?
92+
93+
Prior to Docker Desktop 4.38, ECI did not protect the Kubernetes cluster
94+
integrated in Docker Desktop.
95+
96+
Since Docker Desktop 4.38, ECI protects the integreated Kubernetes cluster
97+
when using the new **kind** provisioner (see [Deploy On Kubernetes](/manuals/desktop/features/kubernetes.md)).
98+
In this case, each node in the multi-node Kubernetes cluster is actually an ECI
99+
protected container. With ECI disabled, each node in the Kubernetes cluster is
100+
a less-secure fully privileged container.
101+
102+
ECI does not protect the integrated Kubernetes cluster when using the
103+
older **Kubeadm** single-node cluster provisioner.
84104

85105
### Does ECI protect containers launched prior to enabling ECI?
86106

87-
No. Containers created prior to switching on ECI are not protected. Therefore, it is
107+
No. Containers created prior to switching on ECI are not protected. Therefore, it is
88108
recommended you remove all containers prior to switching on ECI.
89109

90110
### Does ECI affect the performance of containers?

0 commit comments

Comments
 (0)