From fd14806b2f583fd7c4e687db9c33885e57aaeca2 Mon Sep 17 00:00:00 2001 From: usha-mandya Date: Mon, 29 Apr 2019 17:56:56 +0100 Subject: [PATCH] bumped headings by one level + minor updates --- ee/desktop/admin/configure/mac-admin.md | 6 +-- ee/desktop/admin/configure/windows-admin.md | 6 +-- ee/desktop/admin/install/mac.md | 20 ++++---- ee/desktop/admin/install/windows.md | 24 ++++----- ee/desktop/app-designer.md | 2 +- ee/desktop/index.md | 16 +++--- ee/desktop/release-notes.md | 10 ++-- ee/desktop/troubleshoot/mac-issues.md | 12 ++--- ee/desktop/troubleshoot/windows-issues.md | 6 +-- ee/desktop/user/mac-user.md | 54 ++++++++++----------- ee/desktop/user/windows-user.md | 46 +++++++++--------- 11 files changed, 101 insertions(+), 101 deletions(-) diff --git a/ee/desktop/admin/configure/mac-admin.md b/ee/desktop/admin/configure/mac-admin.md index cd12312f3e..404723f54f 100644 --- a/ee/desktop/admin/configure/mac-admin.md +++ b/ee/desktop/admin/configure/mac-admin.md @@ -6,7 +6,7 @@ keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise 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) The administrator configuration file allows you to customize and standardize your Docker Desktop environment across the organization. @@ -16,7 +16,7 @@ When you install Docker Desktop Enterprise, a configuration file with default va To edit `admin-settings.json`, you must have sudo access privileges. -## 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. @@ -27,7 +27,7 @@ To edit `admin-settings.json`, you must have sudo access privileges. - `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 The following `admin-settings.json` code and table provide the required syntax and descriptions for parameters and values: diff --git a/ee/desktop/admin/configure/windows-admin.md b/ee/desktop/admin/configure/windows-admin.md index ce276f3b85..6ac232c918 100644 --- a/ee/desktop/admin/configure/windows-admin.md +++ b/ee/desktop/admin/configure/windows-admin.md @@ -6,7 +6,7 @@ keywords: Docker Admin, Windows, Docker Desktop, Enterprise 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) The administrator configuration file allows you to customize and standardize your Docker Desktop environment across the organization. @@ -20,7 +20,7 @@ which defaults to: You must have administrator access privileges to edit `admin-settings.json`. -## 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. @@ -33,7 +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. -## Parameters and settings +### Parameters and settings The following `admin-settings.json` code and table provide the required syntax and descriptions for parameters and values: diff --git a/ee/desktop/admin/install/mac.md b/ee/desktop/admin/install/mac.md index cc4c088be5..139b7e0851 100644 --- a/ee/desktop/admin/install/mac.md +++ b/ee/desktop/admin/install/mac.md @@ -8,11 +8,11 @@ This page contains information about the system requirements and specific instru > **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 - 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. - At least 4GB of RAM @@ -20,7 +20,7 @@ This page contains information about the system requirements and specific instru > **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 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. @@ -30,7 +30,7 @@ Mac administrators can use the command line option `\$ sudo installer -pkg Docke Administrators can configure additional settings by modifying the administrator configuration file. For more information, see [Configure Desktop Enterprise for Mac](/ee/desktop/admin/configure/mac-admin). -# License file +## License file Install the Docker Desktop Enterprise license file at the following location: @@ -38,7 +38,7 @@ 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. -# Firewall exceptions +## Firewall exceptions 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. @@ -54,7 +54,7 @@ Docker Desktop Enterprise requires the following firewall exceptions. If you do - If using Kubernetes, the API server is exposed with TLS on `127.0.0.1:6443` by `com.docker.vpnkit`. -# Version packs +## 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 version packs using a command line tool to use a different version of the Docker Engine and Kubernetes for development work: @@ -73,7 +73,7 @@ Available version packs are listed within the **Version Selection** option in th 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 System administrators can use a command line executable to install and uninstall Docker Desktop Enterprise and version packs. @@ -83,7 +83,7 @@ When you install Docker Desktop Enterprise, the command line tool is installed a >**Note:** Command line installation is supported for administrators only. You must have `sudo` access privilege to run the CLI commands. -## Version-pack install +### Version-pack install Run the following command to install or upgrade a version pack to the version contained in the specified `.ddvp` archive: @@ -91,7 +91,7 @@ Run the following command to install or upgrade a version pack to the version co >**Note:** You must stop Docker Desktop before installing a version pack. -## Version-pack uninstall +### Version-pack uninstall Run the following command to uninstall the specified version pack: @@ -99,7 +99,7 @@ Run the following command to install or upgrade a version pack to the version co >**Note:** You must stop Docker Desktop before uninstalling a version pack. -## Application uninstall +### Application uninstall Run the following command to uninstall the application: diff --git a/ee/desktop/admin/install/windows.md b/ee/desktop/admin/install/windows.md index 12850a0d64..732e4fb09b 100644 --- a/ee/desktop/admin/install/windows.md +++ b/ee/desktop/admin/install/windows.md @@ -1,14 +1,14 @@ --- title: Install Docker Desktop Enterprise on Windows description: Learn about Docker Desktop Enterprise -keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise +keywords: Docker EE, Windows, Docker Desktop, Enterprise --- This page contains information about the system requirements and specific instructions that help you install Docker Desktop Enterprise (DDE) on Windows. > **Warning:** If you are using the Community version of Docker Desktop, you must uninstall Docker Desktop Community in order to install Docker Desktop Enterprise. -# System requirements +## System requirements - Windows 10 Pro or Enterprise version 15063 or later. @@ -28,7 +28,7 @@ Hyper-V on Windows 10: > **Note:** Docker supports Docker Desktop Enterprise on Windows based on Microsoft’s support lifecycle for Windows 10 operating system. For more information, see the [Windows lifecycle fact sheet](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). -# Installation +## Installation Download Docker Desktop Enterprise for [**Windows**](https://download.docker.com/win/enterprise/DockerDesktop.msi). @@ -38,7 +38,7 @@ Double-click the `.msi` file to begin the installation and follow the on-screen For information about installing DDE using the command line, see [Command line installation](#command-line-installation). -# License file +## License file Install the Docker Desktop Enterprise license file at the following location: @@ -46,7 +46,7 @@ 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. -# Firewall exceptions +## Firewall exceptions 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. @@ -61,7 +61,7 @@ Docker Desktop Enterprise requires the following firewall exceptions. If you do - If using Kubernetes, the API server is exposed with TLS on `127.0.0.1:6445` by `com.docker.vpnkit`. -# Version packs +## 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 version packs using a CLI tool to use a different version of the Docker Engine and Kubernetes for development work: @@ -76,7 +76,7 @@ For information on using the CLI tool for version pack installation, see [Comman 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 +## Command line installation >**Note:** Command line installation is supported for administrators only. You must have `administrator` access to run the CLI commands. @@ -98,23 +98,23 @@ Docker Desktop Enterprise includes a command line executable to install and unin [ApplicationPath]\dockerdesktop-admin.exe -## Version-pack install +### 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.exe -InstallVersionPack=[path-to-archive] + dockerdesktop-admin.exe -InstallVersionPack=['path-to-archive'] >**Note:** You must stop Docker Desktop before installing a version pack. -## Version-pack uninstall +### Version-pack uninstall Run the following command to uninstall the specified version pack: - dockerdesktop-admin.exe -UninstallVersionPack=[version-pack-name|path-to-archive] + dockerdesktop-admin.exe -UninstallVersionPack=[version-pack-name|'path-to-archive'] >**Note:** You must stop Docker Desktop before uninstalling a version pack. -## Application uninstall +### Application uninstall To uninstall the application: diff --git a/ee/desktop/app-designer.md b/ee/desktop/app-designer.md index 129effa873..a8a1e580a9 100644 --- a/ee/desktop/app-designer.md +++ b/ee/desktop/app-designer.md @@ -4,7 +4,7 @@ description: Docker Desktop Enterprise Application Designer keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise, templates, designer --- -# Overview +## Overview The Application Designer helps Docker developers quickly create new Docker apps using a library of templates. To start the Application diff --git a/ee/desktop/index.md b/ee/desktop/index.md index e3bdde84d5..4aa0d44ee6 100644 --- a/ee/desktop/index.md +++ b/ee/desktop/index.md @@ -6,7 +6,7 @@ keywords: Docker EE, Windows, Mac, Docker Desktop, Enterprise Docker Desktop Enterprise (DDE) provides local development, testing, and building of Docker applications on Mac and 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 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 DDE, IT organizations can ensure developers are working with the same version of Docker Desktop and can easily distribute Docker Desktop to large teams using third-party endpoint management applications. With the Docker Desktop Enterprise graphical user interface (GUI), developers do not have 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 DDE, IT organizations can ensure developers are working with the same version of Docker Desktop and can easily distribute Docker Desktop to large teams using third-party endpoint management applications. With the Docker Desktop graphical user interface (GUI), developers do not have 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. 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. @@ -19,36 +19,36 @@ Feature comparison of Docker Desktop Community versus Docker Desktop Enterprise: | Docker Compose | X | X | | CLI | X | X | | Windows and Mac support | X | X | - | Version selection | | X | + | Version Selection | | X | | Application Designer | | X | | Custom application templates| | X | | Docker Assemble | | X | | 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 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 (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 the creation of standardized development environments, including disabling drive sharing. diff --git a/ee/desktop/release-notes.md b/ee/desktop/release-notes.md index d3acc3aef9..2eddc30724 100644 --- a/ee/desktop/release-notes.md +++ b/ee/desktop/release-notes.md @@ -14,15 +14,15 @@ For information on system requirements, installation, and download, see: For Docker Enterprise Engine release notes, see [Docker Engine release notes](/engine/release-notes). -# Docker Desktop Enterprise Releases of 2019 +## Docker Desktop Enterprise Releases of 2019 -## Docker Desktop Enterprise 2.0.0.1 +### Docker Desktop Enterprise 2.0.0.1 2019-03-01 **WARNING:** You must upgrade the previously installed Version Packs to the latest revision. -### Windows +#### Windows Upgrades: @@ -36,7 +36,7 @@ Bug fixes and minor changes: - Fixed Hub login through the desktop UI not sync with login through `docker login` command line. - Fixed crash in system tray menu when the Hub login fails or Air gap mode. -### Mac +#### Mac New features: @@ -54,7 +54,7 @@ Bug fixes and minor changes: - Fixed port 8080 that was used on localhost when starting Kubernetes. - Improved error messaging to suggest running diagnostics / resetting to factory default only when it is appropriate. -## Docker Desktop Enterprise 2.0.0.0 +### Docker Desktop Enterprise 2.0.0.0 2019-01-31 diff --git a/ee/desktop/troubleshoot/mac-issues.md b/ee/desktop/troubleshoot/mac-issues.md index 5f5afc2444..377eefb70a 100644 --- a/ee/desktop/troubleshoot/mac-issues.md +++ b/ee/desktop/troubleshoot/mac-issues.md @@ -1,12 +1,12 @@ --- title: Troubleshoot Docker Desktop Enterprise issues on Mac description: Troubleshoot Mac issues -keywords: Troubleshoot, diagnose, mac, issues, Docker Enterprise, Docker Desktop, Enterprise +keywords: Troubleshoot, diagnose, Mac, issues, Docker Enterprise, Docker Desktop, Enterprise --- This page contains information on how to diagnose Docker Desktop Enterprise (DDE) issues on Mac. -# Creating a diagnostics file in Docker Desktop Enterprise +## Creating a diagnostics file in Docker Desktop Enterprise Select **Diagnose and Feedback** from the Docker menu in the menu bar. @@ -16,7 +16,7 @@ Once diagnostics are available, select the **Open** button to display the list o Diagnostics are provided in .zip files identified by date and time. The uncompressed contents are also visible in the Finder window. Send your diagnostics file to your administrator for assistance. -## Creating a diagnostics file from a terminal +### Creating a diagnostics file from a terminal In some cases, it is useful to run diagnostics yourself, for instance if Docker Desktop Enterprise cannot start. @@ -41,7 +41,7 @@ You can view the content of your diagnostics file using the **open** command and $ open /tmp/2A989798-1658-4BF0-934D-AC4F148D0782/20190115142942.zip ``` -## Viewing logs in a terminal +### Viewing logs in a terminal In addition to using the **Diagnose and Feedback** option to generate a diagnostics file, you can browse Docker Desktop Enterprise logs in a terminal or with the Console app. @@ -61,7 +61,7 @@ Alternatively, to collect the last day of logs (`1d`) in a file, run: $ /usr/bin/log show --debug --info --style syslog --last 1d --predicate "$pred" >/tmp/logs.txt ``` -## Viewing logs with the Console app +### Viewing logs with the Console app The Console log viewer is located in `/Applications/Utilities`; you can search for it with Spotlight Search. @@ -73,6 +73,6 @@ In the Console window search bar, type You can use the Console app to search logs, filter the results in various ways, and create reports. -## Additional Docker Desktop Enterprise troubleshooting topics +### Additional Docker Desktop Enterprise troubleshooting topics You can also find additional information about various troubleshooting topics in the [Docker Desktop for Mac community](https://docs.docker.com/docker-for-mac/troubleshoot/) documentation. diff --git a/ee/desktop/troubleshoot/windows-issues.md b/ee/desktop/troubleshoot/windows-issues.md index b705faa74a..c6d73d6996 100644 --- a/ee/desktop/troubleshoot/windows-issues.md +++ b/ee/desktop/troubleshoot/windows-issues.md @@ -6,7 +6,7 @@ keywords: Docker EE, Windows, Docker Desktop, Enterprise, troubleshoot This page contains information on how to diagnose Docker Desktop Enterprise (DDE) issues on Windows. -# Creating a diagnostics file in Docker Desktop Enterprise +## 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. @@ -16,7 +16,7 @@ When the log capture is complete, select **You can find diagnostics here**. The Send your diagnostics file to your administrator for assistance. -## Creating a diagnostics file from a terminal +### Creating a diagnostics file from a terminal In some cases, it is useful to run diagnostics yourself, for instance if Docker Desktop Enterprise cannot start. @@ -36,6 +36,6 @@ Diagnostics ID: 6CE654F6-7B17-4FC7-AAE0-CC53B73B76A2/20190115163621 The name of the diagnostics file is displayed next to “Diagnostics Bundle” (`\Temp\6CE654F6-7B17-4FC7-AAE0-CC53B73B76A2\20190115163621.zip` in this example). This is the file that you attach to the support ticket. -## Additional Docker Desktop Enterprise troubleshooting topics +### Additional Docker Desktop Enterprise troubleshooting topics You can also find additional information about various troubleshooting topics in the [Docker Desktop for Windows community](https://docs.docker.com/docker-for-windows/troubleshoot/) documentation. diff --git a/ee/desktop/user/mac-user.md b/ee/desktop/user/mac-user.md index 44c10d2a94..c07ec92b3b 100644 --- a/ee/desktop/user/mac-user.md +++ b/ee/desktop/user/mac-user.md @@ -6,7 +6,7 @@ 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 +## Test your installation 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/). @@ -59,17 +59,17 @@ $ docker image ls $ docker image rm nginx ``` -# 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. -## Version Selection +### Version Selection The **Version Selection** option lists the version packs installed on your Docker Desktop environment and allows you to switch between Docker Engine and Kubernetes versions using a single click. When you select a different version pack, Docker Desktop restarts and the selected versions of Docker Engine and Kubernetes will be used. To switch to a different version pack, simply click on the version pack you would like to use. -## Preferences +### Preferences Click on the Docker icon from the menu bar and then **Preferences** to configure the runtime options described below. @@ -77,7 +77,7 @@ Click on the Docker icon from the menu bar and then **Preferences** to configure ![Docker context menu](../images/prefs.png) -### General +#### General ![Preferences](../images/./prefs-general.png) @@ -94,7 +94,7 @@ General settings include: data to Docker. This information helps Docker improve the application and get more context for troubleshooting problems. (Enabled by default) -### File Sharing +#### 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` @@ -122,7 +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). -### Disk +#### Disk Specify the **Disk image location** of the Linux volume, where containers and images are stored. @@ -133,7 +133,7 @@ the existing image or replace it. ![Disk settings](../images/prefs-disk.png) -### Advanced +#### Advanced On the Advanced tab, you can limit resources available to Docker. @@ -151,7 +151,7 @@ to a higher number; to decrease it, lower the number. - **Swap**: Configure swap file size as needed. The default is 1 GB. -### Proxies +#### Proxies 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 @@ -182,7 +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 using [restart policies](https://docs.docker.com/engine/reference/run/#restart-policies---restart). -### Daemon +#### Daemon You can configure options on the Docker daemon that determine how your containers run. @@ -192,7 +192,7 @@ Select **Basic** to configure the daemon with interactive settings, or select ![Daemon](../images/prefs-daemon-basic.png) -#### Experimental features +##### Experimental features 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. @@ -208,7 +208,7 @@ here. (If `false`, Experimental mode is off.) true ``` -#### Insecure registries +##### Insecure registries 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 @@ -220,7 +220,7 @@ For more information, see: - [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 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). @@ -231,7 +231,7 @@ changes when asked. ![Docker Daemon](../images/prefs-daemon-adv.png) -### Kubernetes +#### Kubernetes Docker Desktop Enterprise includes a standalone Kubernetes server that runs on your Mac, so that you can test deploying your Docker workloads on Kubernetes. @@ -253,7 +253,7 @@ To enable Kubernetes support and install a standalone instance of Kubernetes run ![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. When Kubernetes is enabled and running, an additional status bar item displays at the bottom right of the Docker Desktop Enterprise **Preferences** dialog. @@ -272,21 +272,21 @@ Kubernetes containers are stopped and removed, and the For more information about using the Kubernetes integration with Docker Desktop Enterprise, see [Deploy on Kubernetes](https://docs.docker.com/docker-for-mac/kubernetes). -### Reset +#### Reset Click on the Docker icon from the menu bar and then **Preferences**. Click **Reset** to reset to factory defaults, restart the Docker daemon, reset Kubernetes cluster, or to reset the disk image. ![Uninstall or reset Docker](../images/prefs-reset-mac.png) -## Diagnose and Feedback +### Diagnose and Feedback -The **Diagnose and Feedback** option allows you troubleshoot any issues you may be experiencing with Docker Desktop Enterprise. For more information, see [Troubleshoot DDE issues on mac](/ee/desktop/troubleshoot/mac-issues). +The **Diagnose and Feedback** option allows you troubleshoot any issues you may be experiencing with Docker Desktop Enterprise. For more information, see [Troubleshoot DDE issues on Mac](/ee/desktop/troubleshoot/mac-issues). -## Design new application +### Design new application Select this option to open the Application Designer user interface. Application Designer provides a library of application and service templates to help Docker developers quickly create new Docker applications. For more information, see [Application Designer](/ee/desktop/app-designer). -## Docker Hub +### Docker Hub Select **Sign in /Create Docker ID** from the Docker Desktop Enterprise menu to access your [Docker Hub](https://hub.docker.com/) account. Once logged in, select **Repositories** on the Docker Desktop Enterprise menu to access your Docker Hub repositories directly. @@ -296,13 +296,13 @@ 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/) -## Add TLS certificates +### Add TLS certificates You can add trusted Certificate Authorities (CAs) (used to verify registry server certificates) and client certificates (used to authenticate to registries) to your Docker daemon. -### Add custom CA certificates (server side) +#### Add custom CA certificates (server side) 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 @@ -334,7 +334,7 @@ take effect. 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/). -### Add client certificates +#### Add client certificates You can put your client certificates in `~/.docker/certs.d/:/client.cert` and @@ -353,7 +353,7 @@ Desktop Enterprise `xhyve` virtual machine). > like `docker run` that attempt to pull from the registry produce error > messages on the command line, as well as on the registry. -### Directory structures for certificates +#### Directory structures for certificates If you have this directory structure, you do not need to manually add the CA certificate to your macOS system login: @@ -392,13 +392,13 @@ To learn more about how to install a CA root certificate for the registry and how to set the client TLS certificate for verification, see [Verify repository client with certificates](https://docs.docker.com/engine/security/certificates) in the Docker Engine topics. -## Install shell completion +### Install shell completion Docker Desktop Enterprise comes with scripts to enable completion for `docker` and `docker-compose` commands. The completion scripts may be found inside `Docker.app`, in the `Contents/Resources/etc/` directory and can be installed both in Bash and Zsh. -### Bash +#### Bash 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 @@ -410,7 +410,7 @@ ln -s $etc/docker.bash-completion $(brew --prefix)/etc/bash_completion.d/docker ln -s $etc/docker-compose.bash-completion $(brew --prefix)/etc/bash_completion.d/docker-compose ``` -### Zsh +#### Zsh In Zsh, the [completion system](http://zsh.sourceforge.net/Doc/Release/Completion-System.html) takes care of things. To activate completion for Docker commands, diff --git a/ee/desktop/user/windows-user.md b/ee/desktop/user/windows-user.md index 45d0e0249c..caa2fde5a1 100644 --- a/ee/desktop/user/windows-user.md +++ b/ee/desktop/user/windows-user.md @@ -6,7 +6,7 @@ keywords: Desktop Enterprise, Docker for Windows, Docker Desktop, Enterprise, Us This page contains information about testing the installation and configuring Docker Desktop Enterprise (DDE) runtime options on Windows. -# Test your installation +## Test your installation 1. Open a terminal window (Command Prompt or PowerShell, _but not_ PowerShell ISE). @@ -57,7 +57,7 @@ This page contains information about testing the installation and configuring Do > docker run --help ``` -# Explore the application +## Explore the application In this section, we demonstrate the ease and power of Dockerized applications by running something more complex, such as an OS and a webserver. @@ -157,7 +157,7 @@ running something more complex, such as an OS and a webserver. > docker container rm webserver laughing_kowalevski relaxed_sammet ``` -# Docker Desktop user interface +## Docker Desktop user interface The Docker Desktop Enterprise user interface provides options to configure Docker Desktop settings such as installation, version packs, Docker Hub login, and more. Right-click the Docker icon in the Notifications area (or System tray) to open the Docker Desktop user interface: @@ -165,7 +165,7 @@ The Docker Desktop Enterprise user interface provides options to configure Docke > **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon. -## Settings +### Settings The **Settings** dialog allows you to configure your Docker Desktop Enterprise settings. The following section explains various configuration options available from the **Settings** dialog. @@ -175,7 +175,7 @@ The **Settings** dialog allows you to configure your Docker Desktop Enterprise s ![Docker Desktop Enterprise popup menu](../images/docker-menu-settings.png) -### General +#### General On the **General** tab of the Settings dialog, you can configure when to start Docker Desktop. @@ -188,7 +188,7 @@ crash reports, and usage data. This information helps Docker improve and trouble - **Expose daemon on tcp://localhost:2375 without TLS** - Click this option to enable legacy clients to connect to the Docker daemon. You must use this option with caution as exposing the daemon without TLS can result in remote code execution attacks. -### Shared drives +#### Shared drives Share your local drives (volumes) with Docker Desktop, so that they are available to your [Linux containers](#switch-between-windows-and-linux-containers). @@ -212,7 +212,7 @@ This is not configurable. See [Permissions errors on data directories for shared - 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). -#### Firewall rules for shared drives +##### Firewall rules for shared drives Shared drives require port 445 to be open between the host machine and the virtual machine that runs Linux containers. Docker detects if port 445 is closed @@ -228,7 +228,7 @@ By default, allow connections to `10.0.75.1` on port 445 (the Windows host) from `10.0.75.2` (the virtual machine). If your firewall rules seem correct, you may need to toggle or [reinstall the File and Print sharing service on the Hyper-V virtual network card](http://stackoverflow.com/questions/42203488/settings-to-windows-firewall-to-allow-docker-for-windows-to-share-drive/43904051#43904051). -#### Shared drives on demand +##### Shared drives on demand You can share a drive "on demand" the first time a particular mount is requested. @@ -241,7 +241,7 @@ containers. Alternatively, you can opt not to share it by selecting **Cancel**. ![Shared drive on demand](../images/shared-drive-on-demand.png) -### Advanced +#### Advanced The Linux VM restarts after changing the settings on the **Advanced** tab. This takes a few seconds. @@ -251,7 +251,7 @@ The Linux VM restarts after changing the settings on the **Advanced** tab. This - **Memory** - Change the amount of memory the Docker Desktop Enterprise Linux VM uses. -### Network +#### Network You can configure Docker Desktop Enterprise networking to work on a virtual private network (VPN). @@ -271,7 +271,7 @@ You can configure Docker Desktop Enterprise networking to work on a virtual priv Updating these settings requires a reconfiguration and reboot of the Linux VM. -### Proxies +#### Proxies Docker Desktop Enterprise lets you configure HTTP/HTTPS Proxy Settings and automatically propagates these to Docker and to your containers. For example, @@ -300,7 +300,7 @@ automatically to pick up the new settings. If you have 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). -### Daemon +#### Daemon Docker Desktop Enterprise enables you to configure the Docker daemon based on your preferences. The **Basic** mode lets you configure the more common daemon options with interactive settings and the **Advanced** mode lets you edit the JSON file directly. @@ -309,7 +309,7 @@ The **Basic** mode lets you configure the more common daemon options with intera > **Note:** Administrators have the ability to lock some configuration options. Locked options cannot be selected, and are displayed with a lock icon. -#### Experimental mode +##### Experimental mode Docker Desktop Enterprise has the experimental version of Docker Engine enabled, described in the [Docker Experimental Features](https://github.com/docker/cli/blob/master/experimental/README.md) readme. If you don't select **Experimental Features**, Docker Desktop Enterprise uses the current generally available release of Docker Engine. @@ -345,7 +345,7 @@ Server: Experimental: true ``` -#### Insecure registries +##### Insecure registries You can set up your own [registries](https://docs.docker.com/registry/introduction) on the **Basic** Daemon settings. @@ -360,7 +360,7 @@ For more information, see: - [How do I add client certificates?](https://docs.docker.com/docker-for-windows/faqs/#how-do-i-add-client-certificates) -### Daemon configuration file +#### Daemon configuration file The **Advanced** daemon settings provide the original option to directly edit the JSON configuration file for the [daemon](https://docs.docker.com/engine/reference/commandline/dockerd). @@ -377,7 +377,7 @@ For a full list of options on the Docker daemon, see [daemon](https://docs.docke - [Windows configuration file](https://docs.docker.com/engine/reference/commandline/dockerd/#windows-configuration-file) -### Kubernetes +#### Kubernetes Kubernetes is available on Docker Desktop Enterprise. A standalone Kubernetes server is included that runs on your Windows host, so that you can test deploying your Docker workloads on Kubernetes. @@ -419,7 +419,7 @@ experience conflicts, remove it. For more about using the Kubernetes integration with Docker Desktop Enterprise, see [Deploy on Kubernetes](https://docs.docker.com/docker-for-windows/kubernetes). -### Reset +#### Reset On the Reset tab, you can restart Docker or reset its configuration. @@ -430,7 +430,7 @@ On the Reset tab, you can restart Docker or reset its configuration. - **Reset to factory defaults** - Resets Docker to factory defaults. This is useful in cases where Docker stops working or becomes unresponsive. -## Version Selection +### Version Selection The **Version Selection** option lists the version packs installed on your Docker Desktop environment and allows you to switch between Docker Engine and Kubernetes versions using a single click. When you select a different version pack, Docker Desktop restarts and the selected versions of Docker Engine and Kubernetes will be used. @@ -438,11 +438,11 @@ To switch to a different version pack, simply click on the version pack you woul ![Version Selection](../images/win-ver-select.PNG) -## Diagnose and Feedback +### Diagnose and Feedback The **Diagnose and Feedback** option allows you troubleshoot any issues you may be experiencing with Docker Desktop Enterprise. For more information, see [Troubleshoot DDE issues on Windows](/ee/desktop/troubleshoot/windows-issues). -## Switch between Windows and Linux containers +### Switch between Windows and Linux containers From the Docker Desktop Enterprise menu, you can toggle which daemon (Linux or Windows) the Docker CLI talks to. Select **Switch to Windows containers** to use Windows containers, or select **Switch to Linux containers** to use Linux containers. @@ -474,7 +474,7 @@ The **Settings** dialog changes with Windows containers. When you switch to Wind If you set proxies or daemon configuration in Windows containers mode, these apply only on Windows containers. If you switch back to Linux containers, proxies and daemon configurations return to what you had set for Linux containers. Your Windows container settings are retained and become available again when you switch back. -## Docker Hub +### Docker Hub Select **Sign in /Create Docker ID** from the Docker Desktop Enterprise menu to access your [Docker Hub](https://hub.docker.com/) account. Once logged in, select **Repositories** on the Docker Desktop Enterprise menu to access your Docker Hub repositories directly. @@ -484,11 +484,11 @@ 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/) -## Design new application +### Design new application Select this option to open the Application Designer user interface. Application Designer provides a library of application and service templates to help Docker developers quickly create new Docker applications. For more information, see [Application Designer](/ee/desktop/app-designer). -# Adding TLS certificates +## Adding TLS certificates You can add trusted **Certificate Authorities (CAs)** to your Docker daemon to verify registry server certificates, and **client certificates**, to authenticate to registries.