Skip to content

admin-settings: add note regarding KinD + ECI config. #22435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 16, 2025
Merged

admin-settings: add note regarding KinD + ECI config. #22435

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab13eb5
admin-settings: add note regarding KinD + ECI config.
ctalledo Apr 15, 2025
ae49783
Improve wording in admin-settings Kubernetes note.
ctalledo Apr 15, 2025
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
21 changes: 15 additions & 6 deletions ...security/for-admins/hardened-desktop/settings-management/configure-json-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@
}
```

### General
### General

|Parameter|OS|Description|Version|
|:-------------------------------|---|:-------------------------------|---|
Expand All @@ -195,7 +195,7 @@
| `desktopTerminalEnabled` | | If `value` is set to `false`, developers cannot use the Docker terminal to interact with the host machine and execute commands directly from Docker Desktop. | |
|`exposeDockerAPIOnTCP2375`| Windows only| Exposes the Docker API on a specified port. If `value` is set to true, the Docker API is exposed on port 2375. Note: This is unauthenticated and should only be enabled if protected by suitable firewall rules.| |

### File sharing and emulation
### File sharing and emulation

|Parameter|OS|Description|Version|
|:-------------------------------|---|:-------------------------------|---|
Expand Down Expand Up @@ -241,7 +241,7 @@
|        `dockerDaemonOptions` | | Overrides the options in the Linux daemon config file. See the [Docker Engine reference](/reference/cli/dockerd/#daemon-configuration-file).| |

> [!NOTE]
>
>
> This setting is not available to configure via the Docker Admin Console.

### Kubernetes
Expand All @@ -250,15 +250,24 @@
|:-------------------------------|---|:-------------------------------|---|
|`kubernetes`| | If `enabled` is set to true, a Kubernetes single-node cluster is started when Docker Desktop starts. If `showSystemContainers` is set to true, Kubernetes containers are displayed in the Docker Desktop Dashboard and when you run `docker ps`. `imagesRepository` lets you specify which repository Docker Desktop pulls the Kubernetes images from. For example, `"imagesRepository": "registry-1.docker.io/docker"`. | |

### Features in development
> [!NOTE]
>
> When using the `imagesRepository` setting and Enhanced Container Isolation (ECI), add the following images to the [ECI Docker socket mount image list](#enhanced-container-isolation):
>
> `<custom-image-repo>/desktop-cloud-provider-kind:*`
> `<custom-image-repo>/desktop-containerd-registry-mirror:*`
>
> These containers mount the Docker socket, so you must add the images to the ECI images list. If not, ECI will block the mount and Kubernetes won't start.

### Features in development

|Parameter|OS|Description|Version|
|:-------------------------------|---|:-------------------------------|---|
| `allowExperimentalFeatures`| | If `value` is set to `false`, experimental features are disabled.| |
| `allowBetaFeatures`| | If `value` is set to `false`, beta features are disabled.| |
| `enableDockerAI` | | If `value` is set to `false`, Docker AI (Ask Gordon) features are disabled. | |

### Enhanced Container Isolation
### Enhanced Container Isolation

Check warning on line 270 in content/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.HeadingSentenceCase] Use sentence case for headings: 'Enhanced Container Isolation'.

Raw Output:
{"message": "[Docker.HeadingSentenceCase] Use sentence case for headings: 'Enhanced Container Isolation'.", "location": {"path": "content/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md", "range": {"start": {"line": 270, "column": 5}}}, "severity": "WARNING"}

|Parameter|OS|Description|Version|
|:-------------------------------|---|:-------------------------------|---|
Expand All @@ -282,4 +291,4 @@

So as not to disrupt your developers' workflow, Docker doesn't automatically mandate that developers re-launch and re-authenticate once a change has been made.

In Docker Desktop, developers see the relevant settings grayed out.
In Docker Desktop, developers see the relevant settings grayed out.