diff --git a/_data/toc.yaml b/_data/toc.yaml index e610ab8e1e..092ae2838f 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1169,9 +1169,9 @@ manuals: - sectiontitle: User section: - path: /ee/desktop/user/mac-user/ - title: Using DDE on Mac + title: Use DDE on Mac - path: /ee/desktop/user/windows-user/ - title: Using DDE on Windows + title: Use DDE on Windows - path: /ee/desktop/app-designer/ title: Application designer - sectiontitle: Troubleshoot diff --git a/ee/desktop/admin/configure/mac-admin.md b/ee/desktop/admin/configure/mac-admin.md index c0c7f529a5..a229ce63ae 100644 --- a/ee/desktop/admin/configure/mac-admin.md +++ b/ee/desktop/admin/configure/mac-admin.md @@ -4,7 +4,9 @@ description: Learn about Docker Desktop Enterprise keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise --- -# Environment configuration on Mac (administrators only) +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) The administrator configuration file allows you to customize and standardize your Docker Desktop environment across the organization. diff --git a/ee/desktop/admin/configure/windows-admin.md b/ee/desktop/admin/configure/windows-admin.md index 4ac1dff73d..e071ddb69d 100644 --- a/ee/desktop/admin/configure/windows-admin.md +++ b/ee/desktop/admin/configure/windows-admin.md @@ -4,7 +4,9 @@ description: Learn about Docker Desktop Enterprise configuration keywords: Docker Admin, Windows, Docker Desktop, Enterprise --- -# Environment configuration on Windows (administrators only) +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) 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: diff --git a/ee/desktop/admin/install/mac.md b/ee/desktop/admin/install/mac.md index 395235ef74..63428017b0 100644 --- a/ee/desktop/admin/install/mac.md +++ b/ee/desktop/admin/install/mac.md @@ -22,9 +22,9 @@ This page contains information about the system requirements and specific instru 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. +Double-click the `.pkg` file to begin the installation and follow the on-screen instructions. When the installation is complete, click the Launchpad icon in the Dock and then **Docker** to start Docker Desktop. -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. +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 from the Applications folder on each machine. Administrators can configure additional settings by modifying the administrator configuration file. For more information, see [Configure Desktop Enterprise for Mac](/configure/mac-admin). @@ -67,9 +67,9 @@ For information on using the CLI tool for version pack installation, see [Comman > **Note:** It is not possible to install the version packs using the Docker Desktop user interface or by double-clicking the `.ddvp` file. -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. +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 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 restarts and the selected Docker Engine and Kubernetes versions are used. # Command line installation @@ -87,7 +87,7 @@ Run the following command to install or upgrade a version pack to the version co `dockerdesktop-admin version-pack install [path-to-archive]` - >**Note:** You must stop Docker Desktop Enterprise before installing a version pack. + >**Note:** You must stop Docker Desktop before installing a version pack. ## Version-pack uninstall @@ -95,7 +95,7 @@ Run the following command to install or upgrade a version pack to the version co `dockerdesktop-admin version-pack uninstall [version-pack-name]` ->**Note:** You must stop Docker Desktop Enterprise before uninstalling a version pack. +>**Note:** You must stop Docker Desktop before uninstalling a version pack. ## Application uninstall diff --git a/ee/desktop/admin/install/windows.md b/ee/desktop/admin/install/windows.md index 4ecb62982b..74093e25d7 100644 --- a/ee/desktop/admin/install/windows.md +++ b/ee/desktop/admin/install/windows.md @@ -32,11 +32,11 @@ Download Docker Desktop Enterprise for [**Windows**](https://download.docker.com The DDE installer includes Docker Engine, Docker CLI client, and Docker Compose. -Double-click the `.msi` file to begin the installation and follow the on-screen instructions. +Double-click the `.msi` file to begin the installation and follow the on-screen instructions. When the installation is complete, select **Docker Desktop** from the Start menu to start Docker Desktop. # 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: `C:\Users\Docker\AppData\Roaming\Docker\docker_subscription.lic` @@ -71,7 +71,7 @@ Engine 18.09 / Kubernetes 1.11.5)](https://download.docker.com/win/enterprise/en For information on using the CLI tool for version pack installation, see [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. +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. # Command line installation @@ -89,7 +89,7 @@ Run the following command to install or upgrade a version pack to the version co `dockerdesktop-admin.exe -InstallVersionPack=[path-to-archive]` ->**Note:** You must stop Docker Desktop Enterprise before installing a version pack. +>**Note:** You must stop Docker Desktop before installing a version pack. ## Version-pack uninstall @@ -97,7 +97,7 @@ Run the following command to uninstall the specified version pack: `dockerdesktop-admin.exe -UninstallVersionPack=[version-pack-name]` ->**Note:** You must stop Docker Desktop Enterprise before uninstalling a version pack. +>**Note:** You must stop Docker Desktop before uninstalling a version pack. ## Application uninstall diff --git a/ee/desktop/images/prefs-reset-mac.png b/ee/desktop/images/prefs-reset-mac.png new file mode 100644 index 0000000000..bc8dc27767 Binary files /dev/null and b/ee/desktop/images/prefs-reset-mac.png differ diff --git a/ee/desktop/index.md b/ee/desktop/index.md index e62b7edd38..8731839953 100644 --- a/ee/desktop/index.md +++ b/ee/desktop/index.md @@ -1,20 +1,18 @@ --- -title: Docker Desktop Enterprise +title: Docker Desktop Enterprise overview description: Learn about Docker Desktop Enterprise keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise --- -# Overview +Docker Desktop Enterprise (DDE) provides local development, testing, and building of Docker applications on Mac or Windows. With work performed locally, developers can leverage a rapid feedback loop before pushing code or docker images to shared servers / continuous integration infrastructure. -Docker Desktop Enterprise provides local development, testing, and building of Docker applications on Mac or Windows. With work performed locally, developers can leverage a rapid feedback loop before pushing code or docker images to shared servers / continuous integration infrastructure. +DDE takes Docker Desktop Community, formerly known as Docker for Windows and Docker for Mac, a step further with simplified enterprise application development and maintenance. With Docker Desktop Enterprise, IT organizations can ensure developers are working with the same version of Docker Desktop and can easily distribute Docker Desktop to large teams using a number of third-party endpoint management applications. With the Docker Desktop Enterprise graphical user interface (GUI), developers are no longer required to work with lower-level Docker commands and can auto-generate Docker artifacts. -Docker Desktop Enterprise takes Docker Desktop Community, formerly known as Docker for Windows and Docker for Mac, a step further with simplified enterprise application development and maintenance. With Docker Desktop Enterprise, IT organizations can ensure developers are working with the same version of Docker Desktop Enterprise and can easily distribute Docker Desktop Enterprise to large teams using a number of third-party endpoint management applications. With the Docker Desktop Enterprise graphical user interface (GUI), developers are no longer required to work with lower-level Docker commands and can auto-generate Docker artifacts. - -Installed with a single click or command line command, Docker Desktop Enterprise is integrated with the host OS framework, networking, and filesystem. Docker Desktop Enterprise is also designed to integrate with existing development environments (IDEs) such as Visual Studio and IntelliJ. With support for defined application templates, Docker Desktop Enterprise allows organizations to specify the look and feel of their applications. +Installed with a single click or command line command, Docker Desktop Enterprise is integrated with the host OS framework, networking, and filesystem. DDE is also designed to integrate with existing development environments (IDEs) such as Visual Studio and IntelliJ. With support for defined application templates, Docker Desktop Enterprise allows organizations to specify the look and feel of their applications. Feature comparison of Docker Desktop Community versus Docker Desktop Enterprise: - | Feature | Community version | Docker Desktop Enterprise | + | Feature | Docker Desktop (Community version) | Docker Desktop Enterprise | | :-----------------------|:-----------------:|:-------------------------:| | Docker Engine | X | X | | Docker Compose | X | X | @@ -25,30 +23,30 @@ Feature comparison of Docker Desktop Community versus Docker Desktop Enterprise: | Device management | | X | | Administrative control | | X | -## Docker Desktop Enterprise features +# Docker Desktop Enterprise features The following section lists features that are exclusive to Docker Desktop Enterprise: -### Version Selection +## Version Selection Configurable version packs ensure the local instance of Docker Desktop Enterprise is a precise copy of the production environment where applications are deployed. System administrators can install version packs using a built-in command line tool. Once installed, developers can switch between versions of Docker and Kubernetes with a single click and ensure Docker and Kubernetes versions match UCP cluster versions. -### Application Designer +## Application Designer Application Designer provides a library of application and service templates to help Docker developers quickly create new Docker applications. -### Application Templates +## Application templates Application templates allow you to choose a technology stack and focus on business logic and code, and require only minimal Docker syntax knowledge. Template support includes .NET, Spring, and more. -### Device management +## Device management -The Docker Desktop Enterprise installer is available as standard MSI (Win) and PKG (Mac) downloads, which allows administrators to script an installation across many developer workstations. +The Docker Desktop Enterprise installer is available as standard MSI (Windows) and PKG (Mac) downloads, which allows administrators to script an installation across many developer workstations. -### Administrative control +## Administrative control -IT organizations can specify and lock configuration parameters for creation of standardized development environment, including disabling drive sharing and limiting version pack installations. +IT organizations can specify and lock configuration parameters for creation of standardized development environment, including disabling drive sharing. Developers can then run commands using the command line without worrying about configuration settings. \ No newline at end of file diff --git a/ee/desktop/troubleshoot/mac-issues.md b/ee/desktop/troubleshoot/mac-issues.md index a72af4ed37..b0a5680a5f 100644 --- a/ee/desktop/troubleshoot/mac-issues.md +++ b/ee/desktop/troubleshoot/mac-issues.md @@ -1,10 +1,10 @@ --- title: Troubleshoot Docker Desktop Enterprise issues on Mac description: Troubleshoot Mac issues -keywords: Troubleshoot, diagnose, mac, issues, Docker Enterprise, Windows, Mac, Docker Desktop, Enterprise +keywords: Troubleshoot, diagnose, mac, issues, Docker Enterprise, Docker Desktop, Enterprise --- -This topic contains information on how to diagnose Docker Desktop issues on Mac, send feedback, and submit the issues to Docker Support. +This page contains information on how to diagnose Docker Desktop Enterprise (DDE) issues on Mac, send feedback, and submit the issues to Docker Support. # Creating a diagnostics file in Docker Desktop Enterprise diff --git a/ee/desktop/troubleshoot/windows-issues.md b/ee/desktop/troubleshoot/windows-issues.md index 88eab1cd77..2a6839b614 100644 --- a/ee/desktop/troubleshoot/windows-issues.md +++ b/ee/desktop/troubleshoot/windows-issues.md @@ -1,9 +1,11 @@ --- title: Troubleshoot Docker Desktop Enterprise issues on Windows description: Learn about Docker Desktop Enterprise -keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise, troubleshoot +keywords: Docker EE, Windows, Docker Desktop, Enterprise, troubleshoot --- +This page contains information on how to diagnose Docker Desktop Enterprise (DDE) issues on Windows, send feedback, and submit the issues to Docker Support. + # Creating a diagnostics file in Docker Desktop Enterprise Right-click the Docker icon in the system tray and select **Diagnose and Feedback** from the menu. When the **Diagnose & Feedback** window opens, it starts collecting diagnostics. diff --git a/ee/desktop/user/mac-user.md b/ee/desktop/user/mac-user.md index dce768dd0e..e4ff938334 100644 --- a/ee/desktop/user/mac-user.md +++ b/ee/desktop/user/mac-user.md @@ -1,9 +1,11 @@ --- -title: Using Docker Desktop Enterprise on Mac +title: Use Docker Desktop Enterprise on Mac description: Exploring the Mac user interface keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise --- +This page contains information about testing the installation and configuring Docker Desktop Enterprise (DDE) runtime options on Mac. + # Test your installation 1. Open a command-line terminal and test that your installation works by @@ -61,9 +63,9 @@ $ docker image ls $ docker image rm nginx ``` -# Docker Desktop Enterprise Preferences +# Docker Desktop Enterprise preferences -Choose ![whale menu](../images/whale-x.png) → **Preferences** from the menu bar and configure the runtime options described below. +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) @@ -80,7 +82,7 @@ General settings include: - **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 + **Securely store Docker logins in macOS keychain** stores your Docker login credentials. (Enabled by default.) - **Send usage statistics**: Send diagnostics, crash reports, and usage @@ -276,23 +278,9 @@ For more about using the Kubernetes integration with Docker Desktop Enterprise, ## 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. +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. -![Uninstall or reset Docker](../images/prefs-reset.png) - -> Uninstall Docker Desktop Enterprise from the commandline -> ->To uninstall Docker Desktop Enterprise from a terminal, run: ` ->--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. +![Uninstall or reset Docker](../images/prefs-reset-mac.png) ## Add TLS certificates diff --git a/ee/desktop/user/windows-user.md b/ee/desktop/user/windows-user.md index 07d67db6fc..20665f041f 100644 --- a/ee/desktop/user/windows-user.md +++ b/ee/desktop/user/windows-user.md @@ -1,9 +1,11 @@ --- -title: Using Docker Desktop Enterprise on Windows +title: Use Docker Desktop Enterprise on Windows description: Exploring the Windows user interface keywords: Desktop Enterprise, Docker for Windows, Docker Desktop, Enterprise, User guide, user --- +This page contains information about testing the installation and configuring Docker Desktop Enterprise (DDE) runtime options on Windows. + # Test your installation 1. Open a terminal window (Command Prompt or PowerShell, _but not_ PowerShell ISE). @@ -161,17 +163,16 @@ running something more complex, such as an OS and a webserver. > docker container rm webserver laughing_kowalevski relaxed_sammet ``` -# Docker Desktop Enterprise Settings +# Docker Desktop Enterprise settings The Docker Desktop Enterprise **Settings** menu provides options for configuring -Docker settings -- installation, version packs, Docker Hub login, -and more. +Docker settings such as installation, version packs, Docker Hub login, and more. -This section explains the configuration options accessible from the **Settings** dialog. +The following section explains the configuration options accessible from the **Settings** dialog. > **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon. -1. Open Docker Desktop Enterprise by right-clicking the Docker icon in the Notifications area (or System tray): +1. Open Docker Desktop by right-clicking the Docker icon in the Notifications area (or System tray): ![Showing hidden apps in the taskbar](../images/whale-icon-systray-hidden.png) @@ -181,36 +182,29 @@ This section explains the configuration options accessible from the **Settings** ## General -On the **General** tab of the Settings dialog, you can configure when to start Docker Desktop Enterprise. +On the **General** tab of the Settings dialog, you can configure when to start Docker Desktop. ![Settings](../images/settings-general.png) > **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon. -- **Start Docker when you log in** - Automatically start the Docker Desktop Enterprise -application upon Windows system login. +- **Start Docker when you log in** - Automatically start the Docker Desktop application upon Windows system login. -- **Send usage statistics** - By default, Docker Desktop Enterprise sends diagnostics, -crash reports, and usage data. This information helps Docker improve and -troubleshoot the application. Clear the check box to opt out. Docker might -prompt you for more information. +- **Send usage statistics** - By default, Docker Desktop sends diagnostics, +crash reports, and usage data. This information helps Docker improve and troubleshoot the application. Clear the check box to opt out. Docker might prompt you for more information. ## Shared drives -Share your local drives (volumes) with Docker Desktop Enterprise, so that they are +Share your local drives (volumes) with Docker Desktop, so that they are available to your [Linux containers](#switch-between-windows-and-linux-containers). ![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. +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. +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. Tips on shared drives, permissions, and volume mounts: @@ -220,7 +214,7 @@ Tips on shared drives, permissions, and volume mounts: the Linux VM, or use a [data volume](https://docs.docker.com/storage/volumes/) (named volume) or [data container](https://docs.docker.com/storage/volumes/). There are a number of issues with using host-mounted volumes and network paths 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 Enterprise sets permissions to read/write/execute for users, groups and others [0777 or a+rwx](http://permissions-calculator.org/decode/0777/). +- 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). - 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).