docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix review comments from Mathieu and Guillaume

This commit is contained in:
usha-mandya 2019-04-11 18:37:26 +02:00 committed by Maria Bermudez
parent 382c7c2d33
commit 78692dd7a6
4 changed files with 3 additions and 429 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4,7 +4,6 @@ description: Learn about Docker Desktop Enterprise
keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise
--- ---
<<<<<<< HEAD
This page contains information on how system administrators can configure Docker Desktop Enterprise (DDE) settings, specify and lock configuration parameters to create a standardized development environment on Mac operating systems. This page contains information on how system administrators can configure Docker Desktop Enterprise (DDE) settings, specify and lock configuration parameters to create a standardized development environment on Mac operating systems.
## Environment configuration (administrators only) ## Environment configuration (administrators only)
@ -12,77 +11,39 @@ 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. 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 at the following location. Do not change the location of the `admin-settings.json` file. 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.
=======
# Environment configuration on Mac (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 in, and must remain in, the following location:
>>>>>>> 1013: Move desktop ent content to docs-private
`/Library/Application Support/Docker/DockerDesktop/admin-settings.json` `/Library/Application Support/Docker/DockerDesktop/admin-settings.json`
To edit `admin-settings.json`, you must have sudo access privileges. To edit `admin-settings.json`, you must have sudo access privileges.
<<<<<<< HEAD
### Syntax for `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 not be changed. 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.
=======
## 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.
>>>>>>> 1013: Move desktop ent content to docs-private
2. A nested list of configuration parameters, each of which contains a minimum of the following two settings: 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 - `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
<<<<<<< HEAD
`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. - `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.
### Parameters and settings ### Parameters and settings
=======
`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.
## Parameters and settings
>>>>>>> 1013: Move desktop ent content to docs-private
The following `admin-settings.json` code and table provide the required syntax and descriptions for parameters and values: The following `admin-settings.json` code and table provide the required syntax and descriptions for parameters and values:
```json ```json
{ {
"configurationFileVersion": 1, "configurationFileVersion": 1,
<<<<<<< HEAD
"analyticsEnabled": { "analyticsEnabled": {
"locked": false, "locked": false,
"value": false "value": false
}, },
=======
"analyticsEnabled": {
"locked": false,
"value": false
},
>>>>>>> 1013: Move desktop ent content to docs-private
"dockerCliOptions": { "dockerCliOptions": {
"stackOrchestrator": { "stackOrchestrator": {
"locked": false, "locked": false,
"value": "swarm" "value": "swarm"
} }
}, },
<<<<<<< HEAD
=======
"versionPacks": {
"allowUserInstall": {
"value": true
}
},
>>>>>>> 1013: Move desktop ent content to docs-private
"proxy": { "proxy": {
"locked": false, "locked": false,
"value": { "value": {
@ -92,15 +53,9 @@ The following `admin-settings.json` code and table provide the required syntax a
} }
}, },
"linuxVM": { "linuxVM": {
<<<<<<< HEAD
"cpus": { "cpus": {
"locked": false, "locked": false,
"value": 2 "value": 2
=======
"cpus": {
"locked": false,
"value": 2
>>>>>>> 1013: Move desktop ent content to docs-private
}, },
"memoryMiB": { "memoryMiB": {
"locked": false, "locked": false,
@ -129,10 +84,6 @@ The following `admin-settings.json` code and table provide the required syntax a
} }
} }
}, },
<<<<<<< HEAD
=======
>>>>>>> 1013: Move desktop ent content to docs-private
"kubernetes": { "kubernetes": {
"enabled": { "enabled": {
@ -152,10 +103,6 @@ The following `admin-settings.json` code and table provide the required syntax a
"value": null "value": null
} }
} }
<<<<<<< HEAD
=======
>>>>>>> 1013: Move desktop ent content to docs-private
} }
``` ```
@ -165,13 +112,7 @@ Parameter values and descriptions for environment configuration on Mac:
| :--------------------------------- | :--------------------------------- | | :--------------------------------- | :--------------------------------- |
| `configurationFileVersion` | Specifies the version of the configuration file format. | | `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. | | `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. |
<<<<<<< HEAD
| `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`. | | `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`. |
=======
| `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. |
>>>>>>> 1013: Move desktop ent content to docs-private
| `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"`. | | `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. | | `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. | | `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. |
@ -183,13 +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). | | `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.) | | | (End of `linuxVM` section.) | |
| `kubernetes` | Parameters and settings related to kubernetes options - grouped together here for convenience. | | `kubernetes` | Parameters and settings related to kubernetes options - grouped together here for convenience. |
<<<<<<< HEAD
| `enabled` | If `locked` is set to `true`, the Kubernetes cluster starts when Docker Desktop Enterprise is started. | | `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`. | | `showSystemContainers` | If true, displays Kubernetes internal containers when running docker commands such as `docker ps`. |
=======
| `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`. |
>>>>>>> 1013: Move desktop ent content to docs-private
| `podNetworkCIDR` | This is currently unimplemented. `locked` must be set to true. | | `podNetworkCIDR` | This is currently unimplemented. `locked` must be set to true. |
| `serviceCIDR` | 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.) | | | (End of `kubernetes` section.) | |

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

@ -4,7 +4,6 @@ description: Learn about Docker Desktop Enterprise configuration
keywords: Docker Admin, Windows, Docker Desktop, Enterprise keywords: Docker Admin, Windows, Docker Desktop, Enterprise
--- ---
<<<<<<< HEAD
This page contains information on how system administrators can configure Docker Desktop Enterprise (DDE) settings, specify and lock configuration parameters to create a standardized development environment on Windows operating systems. This page contains information on how system administrators can configure Docker Desktop Enterprise (DDE) settings, specify and lock configuration parameters to create a standardized development environment on Windows operating systems.
## Environment configuration (administrators only) ## Environment configuration (administrators only)
@ -14,13 +13,6 @@ The administrator configuration file allows you to customize and standardize you
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. 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` `\%ProgramData%\DockerDesktop\admin-settings.json`
=======
# Environment configuration on Windows (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:
`\%ProgramData%\\DockerDesktop\\admin-settings.json`
>>>>>>> 1013: Move desktop ent content to docs-private
which defaults to: which defaults to:
@ -28,15 +20,9 @@ which defaults to:
You must have administrator access privileges to edit `admin-settings.json`. You must have administrator access privileges to edit `admin-settings.json`.
<<<<<<< HEAD
### Syntax for `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 not be changed. 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.
=======
## 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.
>>>>>>> 1013: Move desktop ent content to docs-private
2. A nested list of configuration parameters, each of which contains a minimum of 2. A nested list of configuration parameters, each of which contains a minimum of
the following two settings: the following two settings:
@ -47,11 +33,7 @@ You must have administrator access privileges to edit `admin-settings.json`.
- `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. - `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.
<<<<<<< HEAD
### Parameters and settings ### Parameters and settings
=======
## Parameters and settings
>>>>>>> 1013: Move desktop ent content to docs-private
The following `admin-settings.json` code and table provide the required syntax and descriptions for parameters and values: The following `admin-settings.json` code and table provide the required syntax and descriptions for parameters and values:
@ -63,13 +45,8 @@ The following `admin-settings.json` code and table provide the required syntax a
"value": "linux" "value": "linux"
}, },
"analyticsEnabled": { "analyticsEnabled": {
<<<<<<< HEAD
"locked": false, "locked": false,
"value": false "value": false
=======
"locked": false,
"value": false
>>>>>>> 1013: Move desktop ent content to docs-private
}, },
"exposeDockerAPIOnTCP2375": { "exposeDockerAPIOnTCP2375": {
"locked": false, "locked": false,
@ -81,14 +58,6 @@ The following `admin-settings.json` code and table provide the required syntax a
"value": "swarm" "value": "swarm"
} }
}, },
<<<<<<< HEAD
=======
"versionPacks": {
"allowUserInstall": {
"value": false
}
},
>>>>>>> 1013: Move desktop ent content to docs-private
"proxy": { "proxy": {
"locked": false, "locked": false,
"value": { "value": {
@ -174,11 +143,7 @@ The following `admin-settings.json` code and table provide the required syntax a
"locked": true, "locked": true,
"value": [ ] "value": [ ]
}, },
<<<<<<< HEAD
"sharedFolders": ["%USERPROFILE%"] "sharedFolders": ["%USERPROFILE%"]
=======
"sharedFolders": [ "%USERPROFILE%" ]
>>>>>>> 1013: Move desktop ent content to docs-private
} }
``` ```
@ -189,39 +154,25 @@ Parameter values and descriptions for environment configuration on Windows:
| `configurationFileVersion` | Specifies the version of the configuration file format. | | `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. | | `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. | | `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. |
<<<<<<< HEAD
| `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.| | `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`. | | `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`. |
>>>>>>> 1013: Move desktop ent content to docs-private
| `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"`. | | `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. | | `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. | | `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. | `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. | | `swapMiB` | Specifies the amount of memory in MiB (1 MiB = 1048576 bytes) allocated for the swap file. |
<<<<<<< HEAD
| `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. |
=======
| `dataFolder` | Specifies the root folder where Docker Desktop should put VM disk files. ( |
>>>>>>> 1013: Move desktop ent content to docs-private
| `diskSizeMiB` | Specifies the amount of disk storage in MiB (1 MiB = 1048576 bytes) allocated for images and containers. | | `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. | | `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. | | `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. | | `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. | | `dns` | If `value` for `useDnsForwarder` is set to `false`, the Linux VM uses the server information in this `value` setting for DNS resolution. |
<<<<<<< HEAD
| `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). |
=======
| `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). |
>>>>>>> 1013: Move desktop ent content to docs-private
| (End of `linuxVM` section.) | | | (End of `linuxVM` section.) | |
| `windows` | Parameters and settings related to the Windows daemon-related options - grouped together in this example for convenience. | | `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). | | `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.) | | | (End of `windows` section.) | |
| `kubernetes` | Parameters and settings related to kubernetes options - grouped together here for convenience. | | `kubernetes` | Parameters and settings related to kubernetes options - grouped together here for convenience. |
<<<<<<< HEAD
| `enabled` | If `locked` is set to `true`, the Kubernetes cluster starts when Docker Desktop Enterprise is started. | | `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`. | | `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. | | `podNetworkCIDR` | This is currently unimplemented. `locked` must be set to true. |
@ -229,14 +180,3 @@ Parameter values and descriptions for environment configuration on Windows:
| (End of `kubernetes` section.) | | | (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. | | `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. | | `sharedFolders` | If specified, restrict the folders the user is allowed to share with Windows containers. |
=======
| `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`. |
| `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. |
>>>>>>> 1013: Move desktop ent content to docs-private

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

@ -6,7 +6,6 @@ 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. This page contains information about the system requirements and specific instructions that help you install Docker Desktop Enterprise (DDE) on Mac.
<<<<<<< HEAD
> **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 ## System requirements
@ -14,21 +13,11 @@ This page contains information about the system requirements and specific instru
- Mac hardware must be a 2010 or newer model, with Intel’s hardware support for memory management unit (MMU) virtualization, including Extended Page Tables (EPT) and Unrestricted Mode. You can check to see if your machine has this support by running the following command in a terminal: `sysctl kern.hv_support` - Mac hardware must be a 2010 or newer model, with Intel’s hardware support for memory management unit (MMU) virtualization, including Extended Page Tables (EPT) and Unrestricted Mode. You can check to see if your machine has this support by running the following command in a terminal: `sysctl kern.hv_support`
- macOS 10.12 and newer macOS releases are supported. We recommend upgrading to the latest version of macOS. - macOS 10.12 and newer macOS releases are supported. We recommend upgrading to the latest version of macOS.
=======
> **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
- Mac hardware must be a 2010 or newer model, with Intel’s hardware support for memory management unit (MMU) virtualization, including Extended Page Tables (EPT) and Unrestricted Mode. You can check to see if your machine has this support by running the following command in a terminal: `sysctl kern.hv_support`
- MacOS 10.12 and newer MacOS releases are supported. We recommend upgrading to the latest version of macOS.
>>>>>>> 1013: Move desktop ent content to docs-private
- At least 4GB of RAM - At least 4GB of RAM
- VirtualBox prior to version 4.3.30 must NOT be installed (it is incompatible with Docker for Mac). If you have a newer version of VirtualBox installed, it’s fine. - VirtualBox prior to version 4.3.30 must NOT be installed (it is incompatible with Docker for Mac). If you have a newer version of VirtualBox installed, it’s fine.
<<<<<<< HEAD
> **Note:** Docker supports Docker Desktop Enterprise on the most recent versions of macOS. That is, the current release of macOS and the previous two releases. As new major versions of macOS are made generally available, Docker will stop supporting the oldest version and support the newest version of macOS (in addition to the previous two releases). > **Note:** Docker supports Docker Desktop Enterprise on the most recent versions of macOS. That is, the current release of macOS and the previous two releases. As new major versions of macOS are made generally available, Docker will stop supporting the oldest version and support the newest version of macOS (in addition to the previous two releases).
## Installation ## Installation
@ -50,27 +39,6 @@ Install the Docker Desktop Enterprise license file at the following location:
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. 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 ## Firewall exceptions
=======
# Installation
Download Docker Desktop Enterprise for [**Mac**](https://download.docker.com/mac/enterprise/Docker.pkg). The DDE installer includes Docker Engine, Docker CLI client, and Docker Compose.
Double-click the `.pkg` file to begin the installation and follow the on-screen instructions.
Mac administrators can use the command line option `\$ sudo installer -pkg Docker.pkg -target /` for fine tuning and mass installation. After running this command, you can start Docker Desktop Enterprise from the Application folder on each individual machine.
Administrators can configure additional settings by modifying the administrator configuration file. For more information, see [Configure Desktop Enterprise for Mac](/configure/mac-admin).
# License file
You must 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.
# Firewall exceptions
>>>>>>> 1013: Move desktop ent content to docs-private
Docker Desktop Enterprise requires the following firewall exceptions. If you do not have firewall access, or are unsure about how to set firewall exceptions, contact your system administrator. Docker Desktop Enterprise requires the following firewall exceptions. If you do not have firewall access, or are unsure about how to set firewall exceptions, contact your system administrator.
@ -86,7 +54,6 @@ Docker Desktop Enterprise requires the following firewall exceptions. If you do
- If using Kubernetes, the API server is exposed with TLS on - If using Kubernetes, the API server is exposed with TLS on
`127.0.0.1:6443` by `com.docker.vpnkit`. `127.0.0.1:6443` by `com.docker.vpnkit`.
<<<<<<< HEAD
## Version packs ## Version packs
Docker Desktop Enterprise is bundled with default version pack [Enterprise 3.0 (Docker Engine 19.03 / Kubernetes 1.14.1)](https://download.docker.com/mac/enterprise/enterprise-3.0.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 Desktop Enterprise is bundled with default version pack [Enterprise 3.0 (Docker Engine 19.03 / Kubernetes 1.14.1)](https://download.docker.com/mac/enterprise/enterprise-3.0.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:
@ -94,42 +61,21 @@ Docker Desktop Enterprise is bundled with default version pack [Enterprise 3.0 (
- [Docker Enterprise 2.0 (17.06/Kubernetes 1.8.11)](https://download.docker.com/mac/enterprise/enterprise-2.0.ddvp) - [Docker Enterprise 2.0 (17.06/Kubernetes 1.8.11)](https://download.docker.com/mac/enterprise/enterprise-2.0.ddvp)
- [Docker Enterprise 2.1 (18.09/Kubernetes 1.11.5)](https://download.docker.com/mac/enterprise/enterprise-2.1.ddvp) - [Docker Enterprise 2.1 (18.09/Kubernetes 1.11.5)](https://download.docker.com/mac/enterprise/enterprise-2.1.ddvp)
=======
# 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:
- [Docker Community (18.09/Kubernetes
1.13.0)](https://download.docker.com/win/enterprise/community.ddvp)
- [Docker Enterprise 2.0 (17.06/Kubernetes
1.8.11)](https://download.docker.com/win/enterprise/enterprise-2.0.ddvp)
>>>>>>> 1013: Move desktop ent content to docs-private
For information on using the CLI tool for version pack installation, see [Command line installation](#command-line-installation). For information on using the CLI tool for version pack installation, see [Command line installation](#command-line-installation).
> **Note:** It is not possible to install the version packs using the Docker Desktop user interface or by double-clicking the `.ddvp` file. > **Note:** It is not possible to install the version packs using the Docker Desktop user interface or by double-clicking the `.ddvp` file.
<<<<<<< HEAD
Available version packs are listed within the **Version Selection** option in the Docker Desktop menu. If more than one version pack is installed, you can select the corresponding entry to work with a different version pack. After you select a different version pack, Docker Desktop restarts and the selected Docker Engine and Kubernetes versions are used. Available version packs are listed within the **Version Selection** option in the Docker Desktop menu. If more than one version pack is installed, you can select the corresponding entry to work with a different version pack. After you select a different version pack, Docker Desktop restarts and the selected Docker Engine and Kubernetes versions are used.
If more than one version pack is installed, you can select the corresponding entry to work with a different version pack. After you select a different version pack, Docker Desktop restarts and the selected Docker Engine and Kubernetes versions are used. If more than one version pack is installed, you can select the corresponding entry to work with a different version pack. After you select a different version pack, Docker Desktop restarts and the selected Docker Engine and Kubernetes versions are used.
## Command line installation ## Command line installation
=======
Available version packs are listed within the **Version Selection** option in the Docker Desktop Enterprise menu. If more than one version pack is installed, you can select the corresponding entry to work with a different version pack. After you select a different version pack, Docker Desktop Enterprise restarts and the selected Docker Engine and Kubernetes versions are used.
If more than one version pack is installed, you can select the corresponding entry to work with a different version pack. After you select a different version pack, Docker Desktop Enterprise restarts and the selected Docker Engine and Kubernetes versions are used.
# Command line installation
>>>>>>> 1013: Move desktop ent content to docs-private
System administrators can use a command line executable to install and uninstall Docker Desktop Enterprise and version packs. System administrators can use a command line executable to install and uninstall Docker Desktop Enterprise and version packs.
When you install Docker Desktop Enterprise, the command line tool is installed at the following location: When you install Docker Desktop Enterprise, the command line tool is installed at the following location:
<<<<<<< HEAD
[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. >**Note:** Command line installation is supported for administrators only. You must have `sudo` access privilege to run the CLI commands.
@ -155,36 +101,5 @@ Run the following command to install or upgrade a version pack to the version co
Run the following command to uninstall the application: Run the following command to uninstall the application:
sudo /Applications/Docker.app/Contents/Resources/bin/dockerdesktop-admin app uninstall sudo /Applications/Docker.app/Contents/Resources/bin/dockerdesktop-admin app uninstall
=======
`[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.
## Version-pack install
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]`
>**Note:** You must stop Docker Desktop Enterprise before installing a version pack.
## Version-pack uninstall
Run the following command to uninstall the specified version pack:
`dockerdesktop-admin version-pack uninstall [version-pack-name]`
>**Note:** You must stop Docker Desktop Enterprise before uninstalling a version pack.
## Application uninstall
Run one of the following commands to uninstall the application:
`dockerdesktop-admin uninstall`
OR
`sudo /Applications/Docker.app/Contents/Resources/bin/dockerdesktop-admin app uninstall`
>>>>>>> 1013: Move desktop ent content to docs-private
The `sudo` command uninstalls files such as version packs that are installed by an administrator, but are not accessible by users. The `sudo` command uninstalls files such as version packs that are installed by an administrator, but are not accessible by users.

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

@ -1,20 +1,12 @@
--- ---
<<<<<<< HEAD
title: Use Docker Desktop Enterprise on Mac title: Use Docker Desktop Enterprise on Mac
=======
title: Using Docker Desktop Enterprise on Mac
>>>>>>> 1013: Move desktop ent content to docs-private
description: Exploring the Mac user interface description: Exploring the Mac user interface
keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise
--- ---
<<<<<<< HEAD
This page contains information about testing the installation and configuring Docker Desktop Enterprise (DDE) runtime options on Mac. This page contains information about testing the installation and configuring Docker Desktop Enterprise (DDE) runtime options on Mac.
## Test your installation ## Test your installation
=======
# Test your installation
>>>>>>> 1013: Move desktop ent content to docs-private
1. Open a command-line terminal and test that your installation works by 1. Open a command-line terminal and test that your installation works by
running the simple Docker image, [hello-world](https://hub.docker.com/_/hello-world/). running the simple Docker image, [hello-world](https://hub.docker.com/_/hello-world/).
@ -46,13 +38,6 @@ This page contains information about testing the installation and configuring Do
![nginx home page](../images/hello-world-nginx.png) ![nginx home page](../images/hello-world-nginx.png)
<<<<<<< HEAD
=======
> 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.
>>>>>>> 1013: Move desktop ent content to docs-private
4. View the details on the container while your web server is running (with 4. View the details on the container while your web server is running (with
`docker container ls` or `docker ps`): `docker container ls` or `docker ps`):
@ -74,7 +59,6 @@ $ docker image ls
$ docker image rm nginx $ docker image rm nginx
``` ```
<<<<<<< HEAD
## Docker Desktop user interface ## Docker Desktop user interface
The Docker Desktop Enterprise user interface provides options to configure Docker Desktop preferences such as installation, version packs, Docker Hub login, and more. Right-click the Docker icon from the menu bar to open the Docker Desktop user interface. The Docker Desktop Enterprise user interface provides options to configure Docker Desktop preferences such as installation, version packs, Docker Hub login, and more. Right-click the Docker icon from the menu bar to open the Docker Desktop user interface.
@ -94,23 +78,11 @@ Click on the Docker icon from the menu bar and then **Preferences** to configure
![Docker context menu](../images/prefs.png) ![Docker context menu](../images/prefs.png)
#### General #### General
=======
# Docker Desktop Enterprise Preferences
Choose ![whale menu](../images/whale-x.png) → **Preferences** from the menu bar and 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.
## General
>>>>>>> 1013: Move desktop ent content to docs-private
![Preferences](../images/./prefs-general.png) ![Preferences](../images/./prefs-general.png)
General settings include: General settings include:
<<<<<<< HEAD
- **Start Docker Desktop when you log in:** Starts Docker Desktop when you open your session. (Enabled by default) - **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)
@ -133,33 +105,6 @@ runtime.
![File Sharing](../images/prefs-fileshare.png) ![File Sharing](../images/prefs-fileshare.png)
File sharing settings include the following options: File sharing settings include the following options:
=======
- **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.
- **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.)
- **Send usage statistics**: Send 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.)
## File Sharing
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`.
![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:
>>>>>>> 1013: Move desktop ent content to docs-private
- **Add a Directory**: Click `+` and navigate to the directory you want to add. - **Add a Directory**: Click `+` and navigate to the directory you want to add.
@ -168,11 +113,7 @@ File share settings are:
There are some limitations on the directories that can be shared: There are some limitations on the directories that can be shared:
<<<<<<< HEAD
- They cannot be a subdirectory of a directory that has been shared already. - They cannot be a subdirectory of a directory that has been shared already.
=======
- They cannot be a subdirectory of an already shared directory.
>>>>>>> 1013: Move desktop ent content to docs-private
- They cannot already exist inside of Docker. - They cannot already exist inside of Docker.
For more information, see: For more information, see:
@ -181,11 +122,7 @@ For more information, see:
- [Volume mounting requires file sharing for any project directories outside of `/Users`](https://docs.docker.com/docker-for-mac/troubleshoot/#volume-mounting-requires-file-sharing-for-any-project-directories-outside-of-users). - [Volume mounting requires file sharing for any project directories outside of `/Users`](https://docs.docker.com/docker-for-mac/troubleshoot/#volume-mounting-requires-file-sharing-for-any-project-directories-outside-of-users).
<<<<<<< HEAD
#### Disk #### Disk
=======
## Disk
>>>>>>> 1013: Move desktop ent content to docs-private
Specify the **Disk image location** of the Linux volume, where containers and Specify the **Disk image location** of the Linux volume, where containers and
images are stored. images are stored.
@ -196,17 +133,12 @@ the existing image or replace it.
![Disk settings](../images/prefs-disk.png) ![Disk settings](../images/prefs-disk.png)
<<<<<<< HEAD
#### Advanced #### Advanced
=======
## Advanced
>>>>>>> 1013: Move desktop ent content to docs-private
On the Advanced tab, you can limit resources available to Docker. On the Advanced tab, you can limit resources available to Docker.
![Advanced Preference settings](../images/prefs-advanced.png) ![Advanced Preference settings](../images/prefs-advanced.png)
<<<<<<< HEAD
Advanced settings include the following options: Advanced settings include the following options:
- **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
@ -220,23 +152,6 @@ 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 #### Proxies
=======
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
Advanced settings are:
**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,
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.
## Proxies
>>>>>>> 1013: Move desktop ent content to docs-private
Docker Desktop Enterprise detects HTTP/HTTPS Proxy Settings from macOS and automatically Docker Desktop Enterprise detects HTTP/HTTPS Proxy Settings from macOS and automatically
propagates these to Docker and to your containers. For example, if you set your propagates these to Docker and to your containers. For example, if you set your
@ -267,11 +182,7 @@ Docker restarts automatically to pick up the new settings. If you have
containers that you wish to keep running across restarts, you should consider containers that you wish to keep running across restarts, you should consider
using [restart policies](https://docs.docker.com/engine/reference/run/#restart-policies---restart). using [restart policies](https://docs.docker.com/engine/reference/run/#restart-policies---restart).
<<<<<<< HEAD
#### Daemon #### Daemon
=======
## Daemon
>>>>>>> 1013: Move desktop ent content to docs-private
You can configure options on the Docker daemon that determine how your You can configure options on the Docker daemon that determine how your
containers run. containers run.
@ -281,24 +192,12 @@ Select **Basic** to configure the daemon with interactive settings, or select
![Daemon](../images/prefs-daemon-basic.png) ![Daemon](../images/prefs-daemon-basic.png)
<<<<<<< HEAD
##### Experimental features ##### Experimental features
Docker Desktop Enterprise has experimental features enabled Docker Desktop Enterprise has experimental features enabled
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. 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. > **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.
=======
> **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.
> **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.
>>>>>>> 1013: Move desktop ent content to docs-private
You can see whether you are running experimental mode at the command line. If 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 `Experimental` is `true`, then Docker is running in experimental mode, as shown
@ -309,17 +208,12 @@ here. (If `false`, Experimental mode is off.)
true true
``` ```
<<<<<<< HEAD
##### Insecure registries ##### Insecure registries
=======
### Insecure registries
>>>>>>> 1013: Move desktop ent content to docs-private
You can set up a custom and insecure [registry](https://docs.docker.com/registry/introduction) to store your public or private images (instead of You can set up a custom and insecure [registry](https://docs.docker.com/registry/introduction) to store your public or private images (instead of
using [Docker Hub](https://hub.docker.com/) or [Docker Trusted Registry](https://docs.docker.com/ee/dtr/). Add URLs for 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. your insecure registries and registry mirrors on which to host your images.
<<<<<<< HEAD
For more information, see: 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 custom CA certificates?](https://docs.docker.com/docker-for-mac/faqs/#how-do-i-add-custom-ca-certificates)
@ -327,13 +221,6 @@ For more information, see:
- [How do I add client certificates?](https://docs.docker.com/docker-for-mac/faqs/#how-do-i-add-client-certificates) - [How do I add client certificates?](https://docs.docker.com/docker-for-mac/faqs/#how-do-i-add-client-certificates)
##### Daemon configuration file ##### Daemon configuration file
=======
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)
### Daemon configuration file
>>>>>>> 1013: Move desktop ent content to docs-private
Click the **Advanced** tab to configure the daemon from the JSON file. For a Click the **Advanced** tab to configure the daemon from the JSON file. For a
full list of options, see the Docker Engine [dockerd command line reference](https://docs.docker.com/engine/reference/commandline/dockerd). full list of options, see the Docker Engine [dockerd command line reference](https://docs.docker.com/engine/reference/commandline/dockerd).
@ -344,20 +231,11 @@ changes when asked.
![Docker Daemon](../images/prefs-daemon-adv.png) ![Docker Daemon](../images/prefs-daemon-adv.png)
<<<<<<< HEAD
#### Kubernetes #### Kubernetes
=======
## Kubernetes
>>>>>>> 1013: Move desktop ent content to docs-private
Docker Desktop Enterprise includes a standalone Kubernetes server that runs on your Mac, so Docker Desktop Enterprise includes a standalone Kubernetes server that runs on your Mac, so
that you can test deploying your Docker workloads on Kubernetes. that you can test deploying your Docker workloads on Kubernetes.
<<<<<<< HEAD
=======
> **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon.
>>>>>>> 1013: Move desktop ent content to docs-private
The Kubernetes client command, `kubectl`, is included and configured to connect The Kubernetes client command, `kubectl`, is included and configured to connect
to the local Kubernetes server. If you have `kubectl` already installed and 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 pointing to some other environment, such as `minikube` or a GKE cluster, be sure
@ -371,25 +249,16 @@ $ kubectl config use-context docker-for-desktop
If you installed `kubectl` with Homebrew, or by some other method, and If you installed `kubectl` with Homebrew, or by some other method, and
experience conflicts, remove `/usr/local/bin/kubectl`. experience conflicts, remove `/usr/local/bin/kubectl`.
<<<<<<< HEAD
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) ![Enable Kubernetes](../images/prefs-kubernetes.png)
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.
=======
- 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.
>>>>>>> 1013: Move desktop ent content to docs-private
When Kubernetes is enabled and running, an additional status bar item displays at the bottom right of the Docker Desktop Enterprise **Preferences** dialog. 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) ![Installation complete](../images/kubernetes-install-complete.png)
<<<<<<< HEAD
The status of Kubernetes shows in the Docker menu and the context points to `docker-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) ![Docker Menu with Kubernetes](../images/kube-context.png)
@ -428,54 +297,12 @@ See the following [Docker Hub topics](https://docs.docker.com/docker-hub/) to le
- [Builds and Images](https://docs.docker.com/docker-hub/official_images/) - [Builds and Images](https://docs.docker.com/docker-hub/official_images/)
### Add TLS certificates ### Add TLS certificates
=======
The status of Kubernetes shows in the Docker menu and the context points to `docker-for-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.
- 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.
For more about using the Kubernetes integration with Docker Desktop Enterprise, see [Deploy on Kubernetes](https://docs.docker.com/docker-for-mac/kubernetes)</a>.
## Reset
Select ![whale menu](../images/whale-x.png) -> **Preferences** from the menu bar, then click **Reset** to reset factory defaults, restart the Docker daemon, or uninstall.
![Uninstall or reset Docker](../images/prefs-reset.png)
> Uninstall Docker Desktop Enterprise from the commandline
>
>To uninstall Docker Desktop Enterprise from a terminal, run: `<DockerforMacPath>
>--uninstall`. If your instance is installed in the default location, this
>command provides a clean uninstall:
>
>```shell
>$ /Applications/Docker.app/Contents/MacOS/Docker --uninstall
>Docker is running, exiting...
>Docker uninstalled successfully. You can move the Docker application to the trash.
>```
>You might want to use the command-line uninstall if, for example, you find that
>the app is non-functional, and you cannot uninstall it from the menu.
## Add TLS certificates
>>>>>>> 1013: Move desktop ent content to docs-private
You can add trusted Certificate Authorities (CAs) (used to verify registry You can add trusted Certificate Authorities (CAs) (used to verify registry
server certificates) and client certificates (used to authenticate to server certificates) and client certificates (used to authenticate to
registries) to your Docker daemon. registries) to your Docker daemon.
<<<<<<< HEAD
#### Add custom CA certificates (server side) #### Add custom CA certificates (server side)
=======
### Add custom CA certificates (server side)
>>>>>>> 1013: Move desktop ent content to docs-private
All trusted CAs (root or intermediate) are supported. Docker Desktop Enterprise creates a All trusted CAs (root or intermediate) are supported. Docker Desktop Enterprise creates a
certificate bundle of all user-trusted CAs based on the Mac Keychain, and certificate bundle of all user-trusted CAs based on the Mac Keychain, and
@ -507,11 +334,7 @@ take effect.
For a complete explanation of how to do this, see the blog post [Adding For a complete explanation of how to do this, see the blog post [Adding
Self-signed Registry Certs to Docker & Docker Desktop Enterprise](http://container-solutions.com/adding-self-signed-registry-certs-docker-mac/). Self-signed Registry Certs to Docker & Docker Desktop Enterprise](http://container-solutions.com/adding-self-signed-registry-certs-docker-mac/).
<<<<<<< HEAD
#### Add client certificates #### Add client certificates
=======
### Add client certificates
>>>>>>> 1013: Move desktop ent content to docs-private
You can put your client certificates in You can put your client certificates in
`~/.docker/certs.d/<MyRegistry>:<Port>/client.cert` and `~/.docker/certs.d/<MyRegistry>:<Port>/client.cert` and
@ -525,26 +348,15 @@ Desktop Enterprise `xhyve` virtual machine).
> or to the `~/.docker/certs.d` directory in order for the changes to take > or to the `~/.docker/certs.d` directory in order for the changes to take
> effect. > effect.
> >
<<<<<<< HEAD
> * 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
=======
> * The registry cannot be listed as an _insecure registry_ (see [Docker Daemon](#daemon). Docker Desktop Enterprise ignores certificates listed
>>>>>>> 1013: Move desktop ent content to docs-private
> under insecure registries, and does not send client certificates. Commands > under insecure registries, and does not send client certificates. Commands
> like `docker run` that attempt to pull from the registry produce error > like `docker run` that attempt to pull from the registry produce error
> messages on the command line, as well as on the registry. > messages on the command line, as well as on the registry.
<<<<<<< HEAD
#### Directory structures for certificates #### Directory structures for certificates
If you have this directory structure, you do not need to manually add the CA If you have this directory structure, you do not need to manually add the CA
certificate to your macOS system login: certificate to your macOS system login:
=======
### 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:
>>>>>>> 1013: Move desktop ent content to docs-private
``` ```
/Users/<user>/.docker/certs.d/ /Users/<user>/.docker/certs.d/
@ -577,7 +389,6 @@ also in your keychain.
``` ```
To learn more about how to install a CA root certificate for the registry and To learn more about how to install a CA root certificate for the registry and
<<<<<<< HEAD
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 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. topics.
@ -588,19 +399,6 @@ found inside `Docker.app`, in the `Contents/Resources/etc/` directory and can be
installed both in Bash and Zsh. installed both in Bash and Zsh.
#### Bash #### Bash
=======
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
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
found inside `Docker.app`, in the `Contents/Resources/etc/` directory and can be
installed both in Bash and Zsh.
### Bash
>>>>>>> 1013: Move desktop ent content to docs-private
Bash has [built-in support for completion](https://www.debian-administration.org/article/316/An_introduction_to_bash_completion_part_1). To activate completion for Docker commands, these files need to be Bash has [built-in support for completion](https://www.debian-administration.org/article/316/An_introduction_to_bash_completion_part_1). To activate completion for Docker commands, these files need to be
copied or symlinked to your `bash_completion.d/` directory. For example, if you have copied or symlinked to your `bash_completion.d/` directory. For example, if you have
@ -609,7 +407,6 @@ installed bash through [Homebrew](http://brew.sh/).
```bash ```bash
etc=/Applications/Docker.app/Contents/Resources/etc etc=/Applications/Docker.app/Contents/Resources/etc
ln -s $etc/docker.bash-completion $(brew --prefix)/etc/bash_completion.d/docker ln -s $etc/docker.bash-completion $(brew --prefix)/etc/bash_completion.d/docker
<<<<<<< HEAD
ln -s $etc/docker-compose.bash-completion $(brew --prefix)/etc/bash_completion.d/docker-compose ln -s $etc/docker-compose.bash-completion $(brew --prefix)/etc/bash_completion.d/docker-compose
``` ```
@ -617,25 +414,11 @@ ln -s $etc/docker-compose.bash-completion $(brew --prefix)/etc/bash_completion.d
In Zsh, the [completion In Zsh, the [completion
system](http://zsh.sourceforge.net/Doc/Release/Completion-System.html) 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,
=======
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,
>>>>>>> 1013: Move desktop ent content to docs-private
these files need to be copied or symlinked to your Zsh `site-functions/` 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/): directory. For example, if you installed Zsh through [Homebrew](http://brew.sh/):
```bash ```bash
etc=/Applications/Docker.app/Contents/Resources/etc etc=/Applications/Docker.app/Contents/Resources/etc
ln -s $etc/docker.zsh-completion /usr/local/share/zsh/site-functions/_docker ln -s $etc/docker.zsh-completion /usr/local/share/zsh/site-functions/_docker
<<<<<<< HEAD
=======
ln -s $etc/docker-machine.zsh-completion /usr/local/share/zsh/site-functions/_docker-machine
>>>>>>> 1013: Move desktop ent content to docs-private
ln -s $etc/docker-compose.zsh-completion /usr/local/share/zsh/site-functions/_docker-compose ln -s $etc/docker-compose.zsh-completion /usr/local/share/zsh/site-functions/_docker-compose
``` ```