centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-04-04 18:28:58 +07:00
Code Issues Packages Projects Releases Wiki Activity

Fix review comments from Mathieu and Guillaume

Browse Source
This commit is contained in:
usha-mandya
2019-04-11 18:37:26 +02:00
parent 8ad7723c88
commit 316d8fb63b
17 changed files with 109 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
ee/desktop/admin/configure/mac-admin.md
View File

@@ -10,7 +10,7 @@ This page contains information on how system administrators can configure Docker
The administrator configuration file allows you to customize and standardize your Docker Desktop environment across the organization.
When you install Docker Desktop Enterprise, a configuration file with default values is installed in, and must remain in, the following location:
When you install Docker Desktop Enterprise, a configuration file with default values is installed at the following location. Do not change the location of the `admin-settings.json` file.
`/Library/Application Support/Docker/DockerDesktop/admin-settings.json`
@@ -18,12 +18,12 @@ To edit `admin-settings.json`, you must have sudo access privileges.
## Syntax for `admin-settings.json`
1. `configurationFileVersion`: This must be the first parameter listed in `admin-settings.json`. It specifies the version of the configuration file format and must be set to 1.
1. `configurationFileVersion`: This must be the first parameter listed in `admin-settings.json`. It specifies the version of the configuration file format and must not be changed.
2. A nested list of configuration parameters, each of which contains a minimum of the following two settings:
- `locked`: If set to `true`, users without elevated access privileges are not able to edit this setting from the UI or by directly editing the `settings.json` file (the `settings.json` file stores the user's preferences). If set to `false`, users without elevated access privileges can change this setting from the UI or by directly editing
`settings.json`. If this setting is omitted, the default value is `false'.
`settings.json`. If this setting is omitted, the default value is `false`.
- `value`: Specifies the value of the parameter. Docker Desktop Enterprise uses the value when first started and after a reset to factory defaults. If this setting is omitted, a default value that is built into the application is used.
@@ -34,23 +34,16 @@ The following `admin-settings.json` code and table provide the required syntax a
```json
{
"configurationFileVersion": 1,
"analyticsEnabled": {
"locked": false,
"value": false
"locked": false,
"value": false
},
"dockerCliOptions": {
"stackOrchestrator": {
"locked": false,
"value": "swarm"
}
},
"versionPacks": {
"allowUserInstall": {
"value": true
}
},
"proxy": {
"locked": false,
"value": {
@@ -60,9 +53,9 @@ The following `admin-settings.json` code and table provide the required syntax a
}
},
"linuxVM": {
"cpus": {
"locked": false,
"value": 2
"cpus": {
"locked": false,
"value": 2
},
"memoryMiB": {
"locked": false,
@@ -91,7 +84,6 @@ The following `admin-settings.json` code and table provide the required syntax a
}
}
},
"kubernetes": {
"enabled": {
@@ -111,7 +103,6 @@ The following `admin-settings.json` code and table provide the required syntax a
"value": null
}
}
}
```
@@ -121,9 +112,7 @@ Parameter values and descriptions for environment configuration on Mac:
| :--------------------------------- | :--------------------------------- |
| `configurationFileVersion` | Specifies the version of the configuration file format. |
| `analyticsEnabled` | If `value` is true, allow Docker Desktop Enterprise to sends diagnostics, crash reports, and usage data. This information helps Docker improve and troubleshoot the application. |
| `dockerCliOptions` | Specifies key-value pairs in the user's `%HOME%\\.docker\\config.json` file. In the sample code provided, the orchestration for docker stack commands is set to `swarm` rather than `kubernetes`. |
| `versionPacks` | Parameters and settings related to version packs - grouped together here for convenience. |
| `allowUserInstall` | If true, users are able to install new version packs. If false, only the admin can install new version packs. |
| `dockerCliOptions` | Specifies key-value pairs in the user's `~/.docker/config.json` file. In the sample code provided, the orchestration for docker stack commands is set to `swarm` rather than `kubernetes`. |
| `proxy` | The `http` setting specifies the HTTP proxy setting. The `https` setting specifies the HTTPS proxy setting. The `exclude` setting specifies a comma-separated list of hosts and domains to bypass the proxy. **Warning:** This parameter should be locked after being set: `locked: "true"`. |
| `linuxVM` | Parameters and settings related to the Linux VM - grouped together in this example for convenience. |
| `cpus` | Specifies the default number of virtual CPUs for the VM. If the physical machine has only 1 core, the default value is set to 1. |
@@ -135,8 +124,8 @@ Parameter values and descriptions for environment configuration on Mac:
| `dockerDaemonOptions` | Overrides the options in the linux daemon config file. For more information, see [Docker engine reference](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file). |
| (End of `linuxVM` section.) | |
| `kubernetes` | Parameters and settings related to kubernetes options - grouped together here for convenience. |
| `enabled` | If `locked` is set to `true`, the k8s cluster starts when Docker Desktop Enterprise is started. |
| `showSystemContainers` | If true, displays k8s internal containers when running docker commands such as `docker ps`. |
| `enabled` | If `locked` is set to `true`, the Kubernetes cluster starts when Docker Desktop Enterprise is started. |
| `showSystemContainers` | If true, displays Kubernetes internal containers when running docker commands such as `docker ps`. |
| `podNetworkCIDR` | This is currently unimplemented. `locked` must be set to true. |
| `serviceCIDR` | This is currently unimplemented. `locked` must be set to true. |
| (End of `kubernetes` section.) | |

32
ee/desktop/admin/configure/windows-admin.md
View File

@@ -8,9 +8,11 @@ This page contains information on how system administrators can configure Docker
# Environment configuration (administrators only)
The administrator configuration file allows you to customize and standardize your Docker Desktop environment across the organization. When you install Docker Desktop Enterprise, a configuration file with default values is installed the following location:
The administrator configuration file allows you to customize and standardize your Docker Desktop environment across the organization.
`\%ProgramData%\\DockerDesktop\\admin-settings.json`
When you install Docker Desktop Enterprise, a configuration file with default values is installed at the following location. Do not change the location of the `admin-settings.json` file.
`\%ProgramData%\DockerDesktop\admin-settings.json`
which defaults to:
@@ -20,7 +22,7 @@ You must have administrator access privileges to edit `admin-settings.json`.
## Syntax for `admin-settings.json`
1. `configurationFileVersion`: This must be the first parameter listed in `admin-settings.json`. It specifies the version of the configuration file format and must be set to 1.
1. `configurationFileVersion`: This must be the first parameter listed in `admin-settings.json`. It specifies the version of the configuration file format and must not be changed.
2. A nested list of configuration parameters, each of which contains a minimum of
the following two settings:
@@ -43,8 +45,8 @@ The following `admin-settings.json` code and table provide the required syntax a
"value": "linux"
},
"analyticsEnabled": {
"locked": false,
"value": false
"locked": false,
"value": false
},
"exposeDockerAPIOnTCP2375": {
"locked": false,
@@ -146,7 +148,7 @@ The following `admin-settings.json` code and table provide the required syntax a
"locked": true,
"value": [ ]
},
"sharedFolders": [ "%USERPROFILE%" ]
"sharedFolders": ["%USERPROFILE%"]
}
```
@@ -157,31 +159,29 @@ Parameter values and descriptions for environment configuration on Windows:
| `configurationFileVersion` | Specifies the version of the configuration file format. |
| `engine` | Specifies the default Docker engine to be used. `linux` specifies the Linux engine. `windows` specifies the Windows engine. |
| `analyticsEnabled` | If `value` is true, allow Docker Desktop Enterprise to sends diagnostics, crash reports, and usage data. This information helps Docker improve and troubleshoot the application. |
| `exposeDockerAPIOnTCP2375` | Exposes Docker API on a specified port. In this example, setting 'locked' to `true` exposes the Docker API on port 2375. > **Warning:** This is unauthenticated and should only be enabled if protected by suitable firewall rules.|
| `dockerCliOptions` | Specifies key-value pairs in the user's `%HOME%\\.docker\\config.json` file. In the sample code provided, the orchestration for docker stack commands is set to `swarm` rather than `kubernetes`. |
| `exposeDockerAPIOnTCP2375` | Exposes Docker API on a specified port. In this example, setting 'locked' to `true` exposes the Docker API on port 2375. **Warning:** This is unauthenticated and should only be enabled if protected by suitable firewall rules.|
| `dockerCliOptions` | Specifies key-value pairs in the user's `%HOME%\.docker\config.json` file. In the sample code provided, the orchestration for docker stack commands is set to `swarm` rather than `kubernetes`. |
| `proxy` | The `http` setting specifies the HTTP proxy setting. The `https` setting specifies the HTTPS proxy setting. The `exclude` setting specifies a comma-separated list of hosts and domains to bypass the proxy. **Warning:** This parameter should be locked after being set: `locked: "true"`. |
| `linuxVM` | Parameters and settings related to the Linux VM - grouped together in this example for convenience. |
| `cpus` | Specifies the default number of virtual CPUs for the VM. If the physical machine has only 1 core, the default value is set to 1. |
| `memoryMiB` | Specifies the amount of memory in MiB (1 MiB = 1048576 bytes) allocated for the VM.
| `swapMiB` | Specifies the amount of memory in MiB (1 MiB = 1048576 bytes) allocated for the swap file. |
| `dataFolder` | Specifies the root folder where Docker Desktop should put VM disk files. ( |
| `dataFolder` | Specifies the root folder where Docker Desktop should put VM disk files. |
| `diskSizeMiB` | Specifies the amount of disk storage in MiB (1 MiB = 1048576 bytes) allocated for images and containers. |
| `hypervCIDR` | Specifies the subnet used for Hyper-V networking. The chosen subnet must not conflict with other resources on your network. |
| `vpnkitCIDR` | Specifies the subnet used for VPNKit networking and drive sharing. The chosen subnet must not conflict with other resources on your network. |
| `useDnsForwarder` | If `value` is set to `true`, this automatically determines the upstream DNS servers based on the host's network adapters. |
| `dns` | If `value` for `useDnsForwarder` is set to `false`, the Linux VM uses the server information in this `value` setting for DNS resolution. |
| `dockerDaemonOptions` | Overrides the options in the linux daemon config file. For more information, see [Docker engine reference](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file). |
| `dockerDaemonOptions` | Overrides the options in the Linux daemon config file. For more information, see [Docker engine reference](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file). |
| (End of `linuxVM` section.) | |
| `windows` | Parameters and settings related to the Windows daemon-related options - grouped together in this example for convenience. |
| `dockerDaemonOptions` | Overrides the options in the Windows daemon config file. For more information, see [Docker engine reference](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file). |
| (End of `windows` section.) | |
| `kubernetes` | Parameters and settings related to kubernetes options - grouped together here for convenience. |
| `enabled` | If `locked` is set to `true`, the k8s cluster starts when Docker Desktop Enterprise is started. |
| `showSystemContainers` | If true, displays k8s internal containers when running docker commands such as `docker ps`. |
| `enabled` | If `locked` is set to `true`, the Kubernetes cluster starts when Docker Desktop Enterprise is started. |
| `showSystemContainers` | If true, displays Kubernetes internal containers when running docker commands such as `docker ps`. |
| `podNetworkCIDR` | This is currently unimplemented. `locked` must be set to true. |
| `serviceCIDR` | This is currently unimplemented. `locked` must be set to true. |
| (End of `kubernetes` section.) | |
| `sharedDrives` | If `sharedDrives` is set to `true`, this locks the drives users are allowed to share ( `["C", "D"]` ), but does not actually share drives by default (sharing a drive prompts the user for a password). `value` is a whitelist of drives that can be shared. **Warning:** Note that when updating this value, if you remove drives that have been shared, you must also `net share /delete` those drives. |
| `sharedFolders` | If specified, restrict the folders the user is allowed to share with windows containers |
| `versionPacks` | Parameters and settings related to version packs - grouped together here for convenience. |
| `allowUserInstall` | By default, `allowUserInstall` is set to `false`, which allows only administrators to install new version packs. If set to `true`, users can also install new version packs. **Warning:** Version packs contain code which runs as Administrator. |
| `sharedDrives` | If `sharedDrives` is set to `true`, this locks the drives users are allowed to share ( `["C", "D"]` ), but does not actually share drives by default (sharing a drive prompts the user for a password). `value` is a whitelist of drives that can be shared. **Warning:** Note that when updating this value, if you remove drives that have been shared, you must also `net share /delete` those drives. |
| `sharedFolders` | If specified, restrict the folders the user is allowed to share with Windows containers. |

22
ee/desktop/admin/install/mac.md
View File

@@ -6,7 +6,7 @@ keywords: Docker EE, Mac, Docker Desktop, Enterprise
This page contains information about the system requirements and specific instructions that help you install Docker Desktop Enterprise (DDE) on Mac.
> **Warning:** If you are using the community version of Docker Desktop, you must uninstall Docker Desktop community in order to install Docker Desktop Enterprise.
> **Warning:** If you are using the Community version of Docker Desktop, you must uninstall Docker Desktop Community in order to install Docker Desktop Enterprise.
# System requirements
@@ -30,11 +30,11 @@ Administrators can configure additional settings by modifying the administrator
# License file
You must install the Docker Desktop Enterprise license file at the following location:
Install the Docker Desktop Enterprise license file at the following location:
`/Library/Group Containers/group.com.docker/docker_subscription.lic`
If the license file is missing, you will be asked to provide it when you try to run Docker Desktop Enterprise.
You must create the path if it doesn't already exist. If the license file is missing, you will be asked to provide it when you try to run Docker Desktop Enterprise. Contact your system administrator to obtain the license file.
# Firewall exceptions
@@ -55,7 +55,7 @@ Docker Desktop Enterprise requires the following firewall exceptions. If you do
# Version packs
Docker Desktop Enterprise is bundled with default version pack [Enterprise 2.1 (Docker
Engine 18.09 / Kubernetes 1.11.5)](https://download.docker.com/win/enterprise/enterprise-2.1.ddvp). System administrators can install versions packs using a command line tool to use a different version of the Docker Engine and Kubernetes for development work:
Engine 18.09 / Kubernetes 1.11.5)](https://download.docker.com/win/enterprise/enterprise-2.1.ddvp). System administrators can install version packs using a command line tool to use a different version of the Docker Engine and Kubernetes for development work:
- [Docker Community (18.09/Kubernetes
1.13.0)](https://download.docker.com/win/enterprise/community.ddvp)
@@ -77,7 +77,7 @@ System administrators can use a command line executable to install and uninstall
When you install Docker Desktop Enterprise, the command line tool is installed at the following location:
`[ApplicationPath]/Contents/Resources/bin/dockerdesktop-admin`
[ApplicationPath]/Contents/Resources/bin/dockerdesktop-admin
>**Note:** Command line installation is supported for administrators only. You must have `sudo` access privilege to run the CLI commands.
@@ -85,7 +85,7 @@ When you install Docker Desktop Enterprise, the command line tool is installed a
Run the following command to install or upgrade a version pack to the version contained in the specified `.ddvp` archive:
`dockerdesktop-admin version-pack install [path-to-archive]`
dockerdesktop-admin version-pack install [path-to-archive]
>**Note:** You must stop Docker Desktop before installing a version pack.
@@ -93,18 +93,14 @@ Run the following command to install or upgrade a version pack to the version co
Run the following command to uninstall the specified version pack:
`dockerdesktop-admin version-pack uninstall [version-pack-name]`
dockerdesktop-admin version-pack uninstall [version-pack-name]
>**Note:** You must stop Docker Desktop before uninstalling a version pack.
## Application uninstall
Run one of the following commands to uninstall the application:
Run the following command to uninstall the application:
`dockerdesktop-admin uninstall`
OR
`sudo /Applications/Docker.app/Contents/Resources/bin/dockerdesktop-admin app uninstall`
sudo /Applications/Docker.app/Contents/Resources/bin/dockerdesktop-admin app uninstall
The `sudo` command uninstalls files such as version packs that are installed by an administrator, but are not accessible by users.

24
ee/desktop/admin/install/windows.md
View File

@@ -6,7 +6,7 @@ keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise
This page contains information about the system requirements and specific instructions that help you install Docker Desktop Enterprise (DDE) on Windows.
> **Warning:** If you are using the community version of Docker Desktop, you must uninstall Docker Desktop community in order to install Docker Desktop Enterprise.
> **Warning:** If you are using the Community version of Docker Desktop, you must uninstall Docker Desktop Community in order to install Docker Desktop Enterprise.
# System requirements
@@ -24,7 +24,7 @@ Hyper-V on Windows 10:
- BIOS-level hardware virtualization support must be enabled in the
BIOS settings:
![Virtualization Technology (VTx) must be enabled in BIOS settings](/images/windows-prereq.png "BIOS setting information for hardware virtualization support")
![Virtualization Technology (VTx) must be enabled in BIOS settings](../../images/windows-prereq.png "BIOS setting information for hardware virtualization support")
# Installation
@@ -40,9 +40,9 @@ For information about installing DDE using the command line, see [Command line i
Install the Docker Desktop Enterprise license file at the following location:
C:\Users\Docker\AppData\Roaming\Docker\docker_subscription.lic
%ProgramData%\DockerDesktop\docker_subscription.lic
If the license file is missing, you will be asked to provide it when you try to run Docker Desktop Enterprise.
You must create the path if it doesn't already exist. If the license file is missing, you will be asked to provide it when you try to run Docker Desktop Enterprise. Contact your system administrator to obtain the license file.
# Firewall exceptions
@@ -63,7 +63,7 @@ Docker Desktop Enterprise requires the following firewall exceptions. If you do
# Version packs
Docker Desktop Enterprise is bundled with default version pack [Enterprise 2.1 (Docker
Engine 18.09 / Kubernetes 1.11.5)](https://download.docker.com/win/enterprise/enterprise-2.1.ddvp). System administrators can install versions packs using a CLI tool to use a different version of the Docker Engine and Kubernetes for development work:
Engine 18.09 / Kubernetes 1.11.5)](https://download.docker.com/win/enterprise/enterprise-2.1.ddvp). System administrators can install version packs using a CLI tool to use a different version of the Docker Engine and Kubernetes for development work:
- [Docker Community (18.09/Kubernetes
1.13.0)](https://download.docker.com/win/enterprise/community.ddvp)
@@ -93,9 +93,9 @@ For example:
msiexec /i DockerDesktop.msi /quiet AUTOSTART=no STARTMENUSHORTCUT=no INSTALLDIR=”D:\Docker Desktop”
Docker Desktop Enterprise includes a command line executable to install and uninstall DDE and version packs. When you install DDE, the command line tool is installed at the following location:
Docker Desktop Enterprise includes a command line executable to install and uninstall version packs. When you install DDE, the command line tool is installed at the following location:
`[ApplicationPath]\dockerdesktop-admin.exe`
[ApplicationPath]\dockerdesktop-admin.exe
## Version-pack install
@@ -109,10 +109,16 @@ Run the following command to install or upgrade a version pack to the version co
Run the following command to uninstall the specified version pack:
dockerdesktop-admin.exe -UninstallVersionPack=[version-pack-name]
dockerdesktop-admin.exe -UninstallVersionPack=[version-pack-name|path-to-archive]
>**Note:** You must stop Docker Desktop before uninstalling a version pack.
## Application uninstall
To uninstall the application, use system settings or the `.msi` file.
To uninstall the application:
1. Open the **Add or remove programs** dialog
1. Select **Docker Desktop** from the **Apps & features** list.
1. Click **Uninstall**.

BIN
ee/desktop/images/docker-menu-context-switch.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 28 KiB

BIN
ee/desktop/images/kubernetes-install-complete.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 56 KiB

BIN
ee/desktop/images/prefs-advanced.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 41 KiB

BIN
ee/desktop/images/prefs-daemon-adv.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 46 KiB

BIN
ee/desktop/images/prefs-daemon-basic.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 69 KiB

After

Width:  |  Height:  |  Size: 43 KiB

BIN
ee/desktop/images/prefs-disk.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 40 KiB

BIN
ee/desktop/images/prefs-fileshare.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 45 KiB

BIN
ee/desktop/images/prefs-general.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 71 KiB

After

Width:  |  Height:  |  Size: 46 KiB

BIN
ee/desktop/images/prefs-kubernetes.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 79 KiB

After

Width:  |  Height:  |  Size: 52 KiB

BIN
ee/desktop/images/prefs-proxies.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 46 KiB

BIN
ee/desktop/images/proxy-settings.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 67 KiB

95
ee/desktop/user/mac-user.md
View File

@@ -38,10 +38,6 @@ This page contains information about testing the installation and configuring Do
![nginx home page](../images/hello-world-nginx.png)
> Early beta releases used `docker` as the hostname to build the URL. Now,
> ports are exposed on the private IP addresses of the VM and forwarded to
> `localhost` with no other host name set.
4. View the details on the container while your web server is running (with
`docker container ls` or `docker ps`):
@@ -67,41 +63,38 @@ $ docker image rm nginx
Click on the Docker icon from the menu bar and then **Preferences** to configure the runtime options described below.
![Docker context menu](../images/prefs.png)
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
![Docker context menu](../images/prefs.png)
## General
![Preferences](../images/./prefs-general.png)
General settings include:
- **Start Docker Desktop when you log in**: Clear this check box if you don't want to start Docker Desktop when you open your session.
- **Start Docker Desktop when you log in:** Starts Docker Desktop when you open your session. (Enabled by default)
- **Include VM in Time Machine backups** backs up the Docker Desktop Enterprise virtual
machine. (Disabled by default.)
- **Include VM in Time Machine backups:** Backs up the Docker Desktop Enterprise virtual machine. (Disabled by default)
**Securely store Docker logins in macOS keychain** stores your Docker login
credentials. (Enabled by default.)
**Securely store Docker logins in macOS keychain:** Stores your Docker login
credentials. (Enabled by default)
- **Send usage statistics**: Send diagnostics, crash reports, and usage
- **Send usage statistics:** Sends diagnostics, crash reports, and usage
data to Docker. This information helps Docker improve the application and get
more context for troubleshooting problems. (Enabled by default.)
more context for troubleshooting problems. (Enabled by default)
## File Sharing
Choose which local directories to share with your containers. File sharing is
Choose which local directories to share with your containers. File sharing is
required for volume mounting if the project lives outside of the `/Users`
directory. In that case, share the drive where the Dockerfile and volume are
located. Otherwise, you get `file not found` or `cannot start service errors at
runtime`.
located. Otherwise, you get `file not found` or `cannot start service` errors at
runtime.
![File Sharing](../images/prefs-fileshare.png)
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
File share settings are:
File sharing settings include the following options:
- **Add a Directory**: Click `+` and navigate to the directory you want to add.
@@ -110,7 +103,7 @@ File share settings are:
There are some limitations on the directories that can be shared:
- They cannot be a subdirectory of an already shared directory.
- They cannot be a subdirectory of a directory that has been shared already.
- They cannot already exist inside of Docker.
For more information, see:
@@ -136,19 +129,17 @@ On the Advanced tab, you can limit resources available to Docker.
![Advanced Preference settings](../images/prefs-advanced.png)
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
Advanced settings include the following options:
Advanced settings are:
**CPUs**: By default, Docker Desktop Enterprise is set to use half the number of processors
- **CPUs**: By default, Docker Desktop Enterprise is set to use half the number of processors
available on the host machine. To increase processing power, set this to a
higher number; to decrease, lower the number.
**Memory**: By default, Docker Desktop Enterprise is set to use `2` GB runtime memory,
- **Memory**: By default, Docker Desktop Enterprise is set to use 2 GB runtime memory,
allocated from the total available memory on your Mac. To increase RAM, set this
to a higher number; to decrease it, lower the number.
**Swap**: Configure swap file size as needed. The default is 1 GB.
- **Swap**: Configure swap file size as needed. The default is 1 GB.
## Proxies
@@ -191,15 +182,12 @@ Select **Basic** to configure the daemon with interactive settings, or select
![Daemon](../images/prefs-daemon-basic.png)
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
### Experimental features
Docker Desktop Enterprise has experimental features enabled
on Docker Engine, as described in [Docker Experimental Features](https://github.com/docker/docker-ce/blob/master/components/cli/experimental/README.md) Readme. If you don't select **Experimental Features**, Docker Desktop Enterprise
uses the current generally available release of Docker Engine.
on Docker Engine, as described in [Docker Experimental Features](https://github.com/docker/cli/blob/master/experimental/README.md) Readme. If you don't select **Experimental Features**, Docker Desktop Enterprise uses the current generally available release of Docker Engine.
> **Note:** Do not enable experimental features in production. Experimental features are not appropriate for production environments or workloads. They are meant to be sandbox experiments for new ideas. Some experimental features may become incorporated into upcoming stable releases, but others may be modified or pulled from subsequent Edge releases, and never released on Stable.
> **Note:** Do not enable experimental features in production. Experimental features are not appropriate for production environments or workloads. They are meant to be sandbox experiments for new ideas.
You can see whether you are running experimental mode at the command line. If
`Experimental` is `true`, then Docker is running in experimental mode, as shown
@@ -216,9 +204,11 @@ You can set up a custom and insecure [registry](https://docs.docker.com/registry
using [Docker Hub](https://hub.docker.com/) or [Docker Trusted Registry](https://docs.docker.com/ee/dtr/). Add URLs for
your insecure registries and registry mirrors on which to host your images.
See also:
- [How do I add custom CA certificates?](https://docs.docker.com/docker-for-windows/faqs/#how-do-i-add-custom-ca-certificates)
- [How do I add client certificates?](https://docs.docker.com/docker-for-windows/faqs/#how-do-i-add-client-certificates)
For more information, see:
- [How do I add custom CA certificates?](https://docs.docker.com/docker-for-mac/faqs/#how-do-i-add-custom-ca-certificates)
- [How do I add client certificates?](https://docs.docker.com/docker-for-mac/faqs/#how-do-i-add-client-certificates)
### Daemon configuration file
@@ -236,8 +226,6 @@ changes when asked.
Docker Desktop Enterprise includes a standalone Kubernetes server that runs on your Mac, so
that you can test deploying your Docker workloads on Kubernetes.
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
The Kubernetes client command, `kubectl`, is included and configured to connect
to the local Kubernetes server. If you have `kubectl` already installed and
pointing to some other environment, such as `minikube` or a GKE cluster, be sure
@@ -251,34 +239,32 @@ $ kubectl config use-context docker-for-desktop
If you installed `kubectl` with Homebrew, or by some other method, and
experience conflicts, remove `/usr/local/bin/kubectl`.
- To enable Kubernetes support and install a standalone instance of Kubernetes running as a Docker container, select **Enable Kubernetes**, choose the [default orchestrator](https://docs.docker.com/docker-for-mac/kubernetes/#override-the-default-orchestrator) and click the **Apply** button.
To enable Kubernetes support and install a standalone instance of Kubernetes running as a Docker container, select **Enable Kubernetes**, choose the [default orchestrator](https://docs.docker.com/docker-for-mac/kubernetes/#override-the-default-orchestrator) and click the **Apply** button.
![Enable Kubernetes](../images/prefs-kubernetes.png)
An Internet connection is required. Images required to run the Kubernetes server are downloaded and instantiated as containers, and the `/usr/local/bin/kubectl` command is installed on your Mac.
Images required to run the Kubernetes server are downloaded and instantiated as containers, and the `/usr/local/bin/kubectl` command is installed on your mac.
When Kubernetes is enabled and running, an additional status bar item displays at the bottom right of the Docker Desktop Enterprise **Preferences** dialog.
![Installation complete](../images/kubernetes-install-complete.png)
The status of Kubernetes shows in the Docker menu and the context points to `docker-for-desktop`.
The status of Kubernetes shows in the Docker menu and the context points to `docker-desktop`.
![Docker Menu with Kubernetes](../images/kube-context.png)
- By default, Kubernetes containers are hidden from commands like `docker
service ls`, because managing them manually is not supported. To make them
visible, select **Show system containers (advanced)** and click **Apply and
restart**. Most users do not need this option.
By default, Kubernetes containers are hidden from commands like `docker
service ls`, because managing them manually is not supported. To view these containers, select **Show system containers (advanced)** and click **Apply and restart**. Most users do not have to use this option.
- To disable Kubernetes support at any time, deselect **Enable Kubernetes**. The
Kubernetes containers are stopped and removed, and the
`/usr/local/bin/kubectl` command is removed.
To disable Kubernetes support at any time, clear the **Enable Kubernetes** check box. The
Kubernetes containers are stopped and removed, and the
`/usr/local/bin/kubectl` command is removed.
For more about using the Kubernetes integration with Docker Desktop Enterprise, see [Deploy on Kubernetes](https://docs.docker.com/docker-for-mac/kubernetes)</a>.
For more information about using the Kubernetes integration with Docker Desktop Enterprise, see [Deploy on Kubernetes](https://docs.docker.com/docker-for-mac/kubernetes).
## Reset
Click on the Docker icon from the menu bar and then **Preferences**. Click **Reset** to reset factory defaults, restart the Docker daemon, reset Kubernetes cluster, or to reset disk image.
Click on the Docker icon from the menu bar and then **Preferences**. Click **Reset** to reset to factory defaults, restart the Docker daemon, reset Kubernetes cluster, or to reset the disk image.
![Uninstall or reset Docker](../images/prefs-reset-mac.png)
@@ -334,7 +320,7 @@ Desktop Enterprise `xhyve` virtual machine).
> or to the `~/.docker/certs.d` directory in order for the changes to take
> effect.
>
> * The registry cannot be listed as an _insecure registry_ (see [Docker Daemon](#daemon). Docker Desktop Enterprise ignores certificates listed
> * The registry cannot be listed as an _insecure registry_ (see [Docker Daemon](#daemon)). Docker Desktop Enterprise ignores certificates listed
> under insecure registries, and does not send client certificates. Commands
> like `docker run` that attempt to pull from the registry produce error
> messages on the command line, as well as on the registry.
@@ -342,7 +328,7 @@ Desktop Enterprise `xhyve` virtual machine).
### Directory structures for certificates
If you have this directory structure, you do not need to manually add the CA
certificate to your Mac OS system login:
certificate to your macOS system login:
```
/Users/<user>/.docker/certs.d/
@@ -375,13 +361,12 @@ also in your keychain.
```
To learn more about how to install a CA root certificate for the registry and
how to set the client TLS certificate for verification, see [Verify repository client with certificates](https://docs.docker.com/engine/security/certificates)</a> in the Docker Engine
how to set the client TLS certificate for verification, see [Verify repository client with certificates](https://docs.docker.com/engine/security/certificates) in the Docker Engine
topics.
## Install shell completion
Docker Desktop Enterprise comes with scripts to enable completion for the `docker`,
`docker-machine`, and `docker-compose` commands. The completion scripts may be
Docker Desktop Enterprise comes with scripts to enable completion for `docker` and `docker-compose` commands. The completion scripts may be
found inside `Docker.app`, in the `Contents/Resources/etc/` directory and can be
installed both in Bash and Zsh.
@@ -394,20 +379,18 @@ installed bash through [Homebrew](http://brew.sh/).
```bash
etc=/Applications/Docker.app/Contents/Resources/etc
ln -s $etc/docker.bash-completion $(brew --prefix)/etc/bash_completion.d/docker
ln -s $etc/docker-machine.bash-completion $(brew --prefix)/etc/bash_completion.d/docker-machine
ln -s $etc/docker-compose.bash-completion $(brew --prefix)/etc/bash_completion.d/docker-compose
```
### Zsh
In Zsh, the [completion
system](http://zsh.sourceforge.net/Doc/Release/Completion-System.html)</a> takes care of things. To activate completion for Docker commands,
system](http://zsh.sourceforge.net/Doc/Release/Completion-System.html) takes care of things. To activate completion for Docker commands,
these files need to be copied or symlinked to your Zsh `site-functions/`
directory. For example, if you installed Zsh through [Homebrew](http://brew.sh/):
```bash
etc=/Applications/Docker.app/Contents/Resources/etc
ln -s $etc/docker.zsh-completion /usr/local/share/zsh/site-functions/_docker
ln -s $etc/docker-machine.zsh-completion /usr/local/share/zsh/site-functions/_docker-machine
ln -s $etc/docker-compose.zsh-completion /usr/local/share/zsh/site-functions/_docker-compose
```

92
ee/desktop/user/windows-user.md
View File

@@ -12,12 +12,6 @@ This page contains information about testing the installation and configuring Do
2. Run `docker --version` to ensure that you have a supported version of Docker:
```shell
> docker --version
Docker version 18.03.0-ce, build 0520e24
```
3. Pull the [hello-world image](https://hub.docker.com/r/library/hello-world) from Docker Hub and run a container:
```shell
@@ -171,10 +165,6 @@ The Docker Desktop Enterprise user interface provides options to configure Docke
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
## About Docker Desktop
This option displays information about your Docker Desktop installation. It lists version information of all the components installed.
## Settings
The **Settings** dialog allows you to configure your Docker Desktop Enterprise settings. The following section explains various configuration options available from the **Settings** dialog.
@@ -205,8 +195,6 @@ available to your [Linux containers](#switch-between-windows-and-linux-container
![Shared drives](../images/settings-shared-drives.png)
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
Permission for shared drives are tied to the credentials you provide here. If you run `docker` commands under a different username than the one configured here, your containers cannot access the mounted volumes.
To apply shared drives, you are prompted for your Windows system (domain) username and password. You can select an option to have Docker store the credentials so that you don't need to enter them every time.
@@ -220,13 +208,10 @@ the Linux VM, or use a [data volume](https://docs.docker.com/storage/volumes/) (
for database files. See [Volume mounts from host paths use a nobrl option to override database locking](https://docs.docker.com/docker-for-windows/troubleshoot/#volume-mounts-from-host-paths-use-a-nobrl-option-to-override-database-locking).
- Docker Desktop sets permissions to read/write/execute for users, groups and others [0777 or a+rwx](http://permissions-calculator.org/decode/0777/).
This is not configurable. See [Permissions errors on data directories for shared volumes](https://docs.docker.com/docker-for-windows/troubleshoot/#permissions-errors-on-data-directories-for-shared-volumes)</a>.
This is not configurable. See [Permissions errors on data directories for shared volumes](https://docs.docker.com/docker-for-windows/troubleshoot/#permissions-errors-on-data-directories-for-shared-volumes).
- Ensure the domain user has access to shared drives, as described in [Verify domain user has permissions for shared drives](https://docs.docker.com/docker-for-windows/troubleshoot/#verify-domain-user-has-permissions-for-shared-drives-volumes).
- You can share local drives with your _containers_ but not with Docker Machine
nodes. See the FAQ, [Can I share local drives and filesystem with my Docker Machine VMs?](https://docs.docker.com/docker-for-windows/faqs/#can-i-share-local-drives-and-filesystem-with-my-docker-machine-vms)
#### Firewall rules for shared drives
Shared drives require port 445 to be open between the host machine and the
@@ -262,8 +247,6 @@ The Linux VM restarts after changing the settings on the **Advanced** tab. This
![CPU and Memory settings](../images/settings-advanced.png)
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
- **CPUs** - Change the number of processors assigned to the Linux VM.
- **Memory** - Change the amount of memory the Docker Desktop Enterprise Linux VM uses.
@@ -297,8 +280,6 @@ proxy when pulling containers.
![Proxies](../images/settings-proxies.png)
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
When you start a container, your proxy settings propagate into the containers. For example:
```ps
@@ -321,9 +302,8 @@ to keep running across restarts, you should consider using
### Daemon
You can configure the Docker daemon to hone how your containers run.
**Advanced mode** lets you edit the JSON directly. **Basic mode** lets you
configure the more common daemon options with interactive settings (and also JSON).
Docker Desktop Enterprise enables you to configure the Docker daemon based on your preferences.
The **Basic** mode lets you configure the more common daemon options with interactive settings and the **Advanced** mode lets you edit the JSON file directly.
![Docker Daemon](../images/settings-daemon-basic.png)
@@ -332,18 +312,10 @@ configure the more common daemon options with interactive settings (and also JSO
#### Experimental mode
Docker Desktop Enterprise has the experimental version
of Docker Engine enabled, described in the [Docker Experimental Features](https://github.com/docker/cli/blob/master/experimental/README.md) readme on
GitHub.
of Docker Engine enabled, described in the [Docker Experimental Features](https://github.com/docker/cli/blob/master/experimental/README.md) readme. If you don't select **Experimental Features**, Docker Desktop Enterprise uses the current generally available release of Docker Engine.
Experimental features are not appropriate for production environments or
workloads. They are meant to be sandbox experiments for new ideas. Some
experimental features may become incorporated into upcoming stable releases, but
others may be modified or pulled from subsequent Edge releases, and never
released on Stable.
In Docker Desktop Enterprise, you can toggle **experimental mode** on and
off. If you toggle it off, Docker Desktop Enterprise uses the current generally
available release of Docker Engine.
> **Note:** Do not enable experimental features in production. Experimental features are not appropriate for production environments or
workloads. They are meant to be sandbox experiments for new ideas.
Run `docker version` to see if you are in Experimental mode. Experimental mode
is listed under `Server` data. If `Experimental` is `true`, then Docker is
@@ -373,7 +345,7 @@ Server:
Experimental: true
```
#### Custom registries
#### Insecure registries
You can set up your own [registries](https://docs.docker.com/registry/introduction) on the **Basic** Daemon settings.
@@ -382,7 +354,11 @@ and [Docker Trusted Registry](https://docs.docker.com/ee/dtr/). Here, you
can use Docker to set up your own [insecure registry](https://docs.docker.com/registry/insecure/).
Simply add URLs for insecure registries and registry mirrors on which to host your images.
See [How do I add custom CA certificates?](https://docs.docker.com/docker-for-windows/faqs/#how-do-i-add-custom-ca-certificates) and [How do I add client certificates?](https://docs.docker.com/docker-for-windows/faqs/#how-do-i-add-client-certificates) in the FAQs.
For more information, see:
- [How do I add custom CA certificates?](https://docs.docker.com/docker-for-windows/faqs/#how-do-i-add-custom-ca-certificates)
- [How do I add client certificates?](https://docs.docker.com/docker-for-windows/faqs/#how-do-i-add-client-certificates)
### Daemon configuration file
@@ -408,8 +384,6 @@ Docker workloads on Kubernetes.
![Enable Kubernetes](../images/settings-kubernetes.png)
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
The Kubernetes client command, `kubectl`, is included and configured to connect
to the local Kubernetes server. If you have `kubectl` already installed and
pointing to some other environment, such as `minikube` or a GKE cluster, be sure
@@ -431,18 +405,16 @@ experience conflicts, remove it.
running as a Docker container, select **Enable Kubernetes** and click the
**Install** button.
An Internet connection is required. Images required to run the Kubernetes
server are downloaded and instantiated as containers, and the
> `Program Files\Docker\Docker\Resources\bin\kubectl.exe` command is installed.
Images required to run the Kubernetes server are instantiated as containers, and the `kubectl.exe` command is installed in the path.
- By default, Kubernetes containers are hidden from commands like `docker
service ls`, because managing them manually is not supported. To make them
visible, select **Show system containers (advanced)** and click **Apply and restart**.
Most users do not need this option.
Most users do not have to use this option.
- To disable Kubernetes support at any time, deselect **Enable Kubernetes**.
The Kubernetes containers are stopped and removed, and the
`/usr/local/bin/kubectl` command is removed.
`kubectl` command is removed.
For more about using the Kubernetes integration with Docker Desktop Enterprise,
see [Deploy on Kubernetes](https://docs.docker.com/docker-for-windows/kubernetes).
@@ -453,7 +425,7 @@ On the Reset tab, you can restart Docker or reset its configuration.
![Reset](../images/settings-reset.png)
- **Restart Docker** - Shuts down and restarts the Docker application.
- **Restart Docker Desktop** - Shuts down and restarts the Docker Desktop application.
- **Reset to factory defaults** - Resets Docker to factory defaults. This is
useful in cases where Docker stops working or becomes unresponsive.
@@ -470,15 +442,9 @@ To switch to a different version pack, simply click on the version pack you woul
The **Diagnose and Feedback** option allows you troubleshoot any issues you may be experiencing with Docker Desktop Enterprise. For more information, see [Troubleshoot DDE issues on Windows](/troubleshoot/windows-issues).
Alternatively, log on to our [Docker Desktop for Windows forum](https://forums.docker.com/c/docker-for-windows) to get help from the community, review current user topics, or join a discussion.
Log on to [Docker Desktop for Windows issues on GitHub](https://github.com/docker/for-win/issues) to review community-reported issues.
To give feedback on the documentation or to update it yourself, use the **Edit this page** or **Request docs changes** options on the right-hand pane on each docs page.
## Switch between Windows and Linux containers
From the Docker Desktop Enterprise menu, you can toggle which daemon (Linux or Windows) the Docker CLI talks to. Select **Switch to Windows containers** to use Windows containers, or select **Switch to Linux containers** to use Linux containers (the default).
From the Docker Desktop Enterprise menu, you can toggle which daemon (Linux or Windows) the Docker CLI talks to. Select **Switch to Windows containers** to use Windows containers, or select **Switch to Linux containers** to use Linux containers.
![Windows-Linux container types switch](../images/docker-menu-switch.png)
@@ -500,7 +466,7 @@ The **Settings** dialog changes with Windows containers. When you switch to Wind
- [Proxies](#proxies)
- [Docker daemon](#daemon)
- [Daemon](#daemon)
- [Diagnose and Feedback](#diagnose-and-feedback)
@@ -510,7 +476,7 @@ If you set proxies or daemon configuration in Windows containers mode, these app
## Docker Hub
Select **Sign in /Create Docker ID** from the Docker Desktop Enterprise menu to access your [Docker Hub](https://hub.docker.com/) account. Once logged in, you can access your Docker Hub repositories directly from the Docker Desktop Enterprise menu.
Select **Sign in /Create Docker ID** from the Docker Desktop Enterprise menu to access your [Docker Hub](https://hub.docker.com/) account. Once logged in, select **Repositories** on the Docker Desktop Enterprise menu to access your Docker Hub repositories directly.
See the following [Docker Hub topics](https://docs.docker.com/docker-hub/) to learn more:
@@ -522,26 +488,6 @@ See the following [Docker Hub topics](https://docs.docker.com/docker-hub/) to le
Select this option to open the Application Designer user interface. Application Designer provides a library of application and service templates to help Docker developers quickly create new Docker applications. For more information, see [Application Designer](/app-designer).
## Documentation
Select this option to access the latest Docker Desktop Enterprise documentation. Note that documentation may be updated anytime. We recommend that you regularly visit the [Docker Desktop Enterprise Documentation](/) page to learn about the updates.
## Repositories
TBD
## Kubernetes Context
TBD
## Restart
Click **Restart** to restart Docker Desktop. Note that restarting Docker Desktop stops all running containers.
## Quit Docker Desktop
Click **Quit Docker Desktop** to exit Docker Desktop Enterprise.
# Adding TLS certificates
You can add trusted **Certificate Authorities (CAs)** to your Docker daemon to verify registry server certificates, and **client certificates**, to authenticate to registries.