Skip to content

Commit

Permalink
Merge remote-tracking branch 'docker.github.io/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
allysmith424 committed Jan 21, 2020
2 parents 6affa70 + 8354599 commit 1f587d4
Show file tree
Hide file tree
Showing 37 changed files with 522 additions and 204 deletions.
4 changes: 4 additions & 0 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1173,6 +1173,8 @@ manuals:
title: Getting started
- path: /docker-for-mac/install/
title: Install Docker Desktop for Mac
- path: /docker-for-mac/dashboard/
title: Dashboard
- path: /docker-for-mac/kubernetes/
title: Deploy on Kubernetes
- path: /docker-for-mac/docker-toolbox/
Expand Down Expand Up @@ -1203,6 +1205,8 @@ manuals:
title: Getting started
- path: /docker-for-windows/install/
title: Install Docker Desktop for Windows
- path: /docker-for-windows/dashboard/
title: Dashboard
- path: /docker-for-windows/kubernetes/
title: Deploy on Kubernetes
- path: /docker-for-windows/networking/
Expand Down
131 changes: 131 additions & 0 deletions docker-for-mac/dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
---
description: Docker Desktop Dashboard
keywords: Docker Desktop Dashboard, container view
title: Docker Desktop Dashboard
---

The Docker Desktop Dashboard provides a simple interface that enables you to interact with containers and applications, and manage the lifecycle of your applications directly from your machine. The Dashboard UI shows all running, stopped, and started containers with their status. It provides an intuitive interface to perform common actions to inspect, interact with, and manage your Docker objects including containers and Docker Compose-based applications.

The Docker Desktop Dashboard offers the following benefits:

- A GUI to abstract core information from the CLI
- Access to container logs directly in the UI to search and explore container behavior
- Access to combined Compose logs from the UI to understand Compose applications
- Quick visibility into ports being used by containers
- Monitor container resource utilization

In addition, the Dashboard UI allows you to:

- Navigate to the [Settings](/docker-for-mac/index/#preferences) menu to configure Docker Desktop preferences
- Access the [Troubleshoot](troubleshoot.md) menu to debug and perform restart operations
- Sign into [Docker Hub](/docker-for-mac/index/#docker-hub) using your Docker ID

To access the Docker Desktop Dashboard, from the Docker menu, select **Dashboard**. The Dashboard provides a runtime view of all your containers and applications.

![Docker Desktop Dashboard](images/mac-dashboard.png)

## Explore running containers and applications

From the Docker menu, select **Dashboard**. This lists all your running containers and applications. Note that you must have running containers and applications to see them listed on the Docker Desktop Dashboard.

The following sections guide you through the process of creating a sample Redis container and a sample application to demonstrate the core functionalities in Docker Desktop Dashboard.

### Start a Redis container

To start a Redis container, open your preferred CLI and run the following command:

`docker run -dt redis`

This creates a new Redis container. From the Docker menu, select **Dashboard** to see the new Redis container.

![Redis container](images/mac-redis-container.png){:width="700px"}

### Start a sample application

Now, let us start a sample application. You can download the [Example voting app](https://github.com/dockersamples/example-voting-app) from the Docker samples page. The example voting app is a distributed application that runs across multiple Docker containers.

![Example voting app architecture diagram](../docker-for-windows/images/example-app-architecture.png){:width="600px"}

The example voting app contains:

- A front-end web app in [Python](/vote) or [ASP.NET Core](/vote/dotnet) which lets you vote between two options
- A [Redis](https://hub.docker.com/_/redis/) or [NATS](https://hub.docker.com/_/nats/) queue which collects new votes
- A [.NET Core](/worker/src/Worker), [Java](/worker/src/main) or [.NET Core 2.1](/worker/dotnet) worker which consumes votes and stores them
- A [Postgres](https://hub.docker.com/_/postgres/) or [TiDB](https://hub.docker.com/r/dockersamples/tidb/tags/) database backed by a Docker volume
- A [Node.js](/result) or [ASP.NET Core SignalR](/result/dotnet) web app which shows the results of the voting in real time

To start the application, navigate to the directory containing the example voting application in the CLI and run `docker-compose up --build`.

```
$ docker-compose up --build
Creating network "example-voting-app-master_front-tier" with the default driver
Creating network "example-voting-app-master_back-tier" with the default driver
Creating volume "example-voting-app-master_db-data" with default driver
Building vote
Step 1/7 : FROM python:2.7-alpine
2.7-alpine: Pulling from library/python
Digest: sha256:d2cc8451e799d4a75819661329ea6e0d3e13b3dadd56420e25fcb8601ff6ba49
Status: Downloaded newer image for python:2.7-alpine
---> 1bf48bb21060
Step 2/7 : WORKDIR /app
---> Running in 7a6a0c9d8b61
Removing intermediate container 7a6a0c9d8b61
---> b1242f3c6d0c
Step 3/7 : ADD requirements.txt /app/requirements.txt
---> 0f5d69b65243
Step 4/7 : RUN pip install -r requirements.txt
---> Running in 92788dc9d682
...
Successfully built 69da1319c6ce
Successfully tagged example-voting-app-master_worker:latest
Creating example-voting-app-master_vote_1 ... done
Creating example-voting-app-master_result_1 ... done
Creating db ... done
Creating redis ... done
Creating example-voting-app-master_worker_1 ... done
Attaching to db, redis, example-voting-app-master_result_1, example-voting-app-master_vote_1, example-voting-app-master_worker_1
...
```

When the application successfully starts, from the Docker menu, select **Dashboard** to see the Example voting application. Expand the application to see the containers running inside the application.

![Spring Boot application view](images/app-dashboard-view.png){:width="700px"}

Now that you can see the list of running containers and applications on the Dashboard, let us explore some of the actions you can perform:

- Click **Port** to open the port exposed by the container in a browser.
- Click **CLI** to open a terminal and run commands on the container.
- Click **Stop**, **Start**, **Restart**, or **Delete** to perform lifecycle operations on the container.

Use the **Search** option to search for a specific object. You can also sort your containers and applications using various options. Click the **Sort by** drop-down to see a list of available options.

## Interact with containers and applications

From the Docker Desktop Dashboard, select the example voting application we started earlier.

The **application view** lists all the containers running on the application and contains a detailed logs view. It also allows you to start, stop, or delete the application.

Hover over the containers to see some of the core actions you can perform. Use the **Search** option at the bottom to search the application logs for specific events, or select the **Copy** icon to copy the logs to your clipboard.

![Application view](images/mac-application-view.png){:width="700px"}

Click on a specific container for detailed information about the container. The **container view** displays **Logs**, **Inspect**, and **Stats** tabs and provides quick action buttons to perform various actions.

![Explore the app](images/mac-container-view.png){:width="700px"}

- Select **Logs** to see logs from the container. You can also search the logs for specific events and copy the logs to your clipboard.

- Select **Inspect** to view low-level information about the container. You can see the local path, version number of the image, SHA-256, port mapping, and other details.

- Select **Stats** to view information about the container resource utilization. You can see the amount of CPU, disk I/O, memory, and network I/O used by the container.

You can also use the quick action buttons on the top bar to perform common actions such as opening a CLI to run commands in a container, and perform lifecycle operations such as stop, start, restart, or delete your container.

Click **Port** to open the port exposed by the container in a browser.

![Spring app browser view](images/mac-browser-view.png){:width="700px"}

## Feedback

We would like to hear from you about the new Dashboard UI. Let us know your feedback by creating an issue in the [docker/for-mac](https://github.com/docker/for-mac/issues) GitHub repository.
Binary file added docker-for-mac/images/app-dashboard-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docker-for-mac/images/kubernetes/kube-context.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docker-for-mac/images/kubernetes/kube.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docker-for-mac/images/mac-application-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docker-for-mac/images/mac-browser-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docker-for-mac/images/mac-container-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docker-for-mac/images/mac-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docker-for-mac/images/mac-redis-container.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docker-for-mac/images/menu/prefs-advanced.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docker-for-mac/images/menu/prefs-general.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docker-for-mac/images/menu/prefs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docker-for-mac/images/menu/troubleshoot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 10 additions & 16 deletions docker-for-mac/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ redirect_from:
- /docker-for-mac/index/
- /docker-for-mac/osx/
title: Get started with Docker Desktop for Mac
toc_min: 1
toc_max: 2
---

Welcome to Docker Desktop!
Expand Down Expand Up @@ -101,7 +103,7 @@ menu bar and configure the runtime options described below.
### General
![Preferences](images/menu/prefs-general.png)
![Preferences](images/menu/prefs-general.png){:width="750px"}
On the **General** tab, you can configure when to start and update Docker:
Expand All @@ -124,7 +126,7 @@ The **Resources** tab allows you to configure CPU, memory, disk, proxies, networ
On the Advanced tab, you can limit resources available to Docker.
![Advanced Preference
settings-advanced](images/menu/prefs-advanced.png)
settings-advanced](images/menu/prefs-advanced.png){:width="750px"}
Advanced settings are:
Expand All @@ -147,8 +149,6 @@ You can also move the disk image to a different location. If you attempt to move
Choose the local directories you'd like 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/menu/prefs-fileshare.png)
File share settings are:
- **Add a Directory**: Click `+` and navigate to the directory you want to add.
Expand All @@ -175,8 +175,6 @@ propagates these to Docker and to your containers. For example, if you set your
proxy settings to `http://proxy.example.com`, Docker uses this proxy when
pulling containers.
![Proxies settings](images/menu/prefs-proxies.png)
When you start a container, your proxy settings propagate into the containers.
For example:
Expand All @@ -200,14 +198,10 @@ containers that you would like to keep running across restarts, you should consi
You can configure Docker Desktop networking to work on a virtual private network (VPN). Specify a network address translation (NAT) prefix and subnet mask to enable Internet connectivity.
![Network settings](images/menu/prefs-network.png)
### Docker Engine
The Docker Engine page allows you to configure the Docker daemon to determine how your containers run.
![Daemon](images/menu/engine.png)
Type a JSON configuration file in the box to configure the daemon settings. For a full list of options, see the Docker Engine [dockerd commandline
reference](/engine/reference/commandline/dockerd.md){:target="_blank"
class="_"}.
Expand All @@ -218,8 +212,6 @@ Click **Apply & Restart** to save your settings and restart Docker Desktop.
On the Command Line page, you can specify whether or not to enable experimental features.
![Command Line](images/menu/command-line.png)
{% include experimental.md %}
On both Docker Desktop Edge and Stable releases, you can toggle the experimental features on and off. If you toggle the experimental features off, Docker Desktop uses the current generally available release of Docker Engine.
Expand Down Expand Up @@ -285,12 +277,10 @@ experience conflicts, remove `/usr/local/bin/kubectl`.
Click **Apply & Restart** to save the settings. This instantiates images required to run the Kubernetes server as containers, and installs the
`/usr/local/bin/kubectl` command on your Mac.
![Enable Kubernetes](images/kubernetes/kube.png)
![Enable Kubernetes](images/kubernetes/kube.png){:width="750px"}
When Kubernetes is enabled and running, an additional status bar item displays
at the bottom right of the Docker Desktop Preferences dialog.
![Installation complete](images/kubernetes/kube-running.png)
at the bottom right of the Docker Desktop Settings dialog.
The status of Kubernetes shows in the Docker menu and the context points to
`docker-desktop`.
Expand Down Expand Up @@ -318,6 +308,10 @@ experience conflicts, remove `/usr/local/bin/kubectl`.
For information about the reset options, see [Logs and Troubleshooting](troubleshoot.md).
## Dashboard
The Docker Desktop Dashboard enables you to interact with containers and applications and manage the lifecycle of your applications directly from your machine. The Dashboard UI shows all running, stopped, and started containers with their state. It provides an intuitive interface to perform common actions to inspect and manage containers and existing Docker Compose applications. For more information, see [Docker Desktop Dashboard](dashboard.md).
## Add TLS certificates
You can add trusted Certificate Authorities (CAs) (used to verify registry
Expand Down
53 changes: 51 additions & 2 deletions docker-for-mac/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,56 @@ This page contains information about the new features, improvements, known issue
For information about Edge releases, see the [Edge release notes](edge-release-notes). For Docker Desktop system requirements, see
[What to know before you install](install.md#what-to-know-before-you-install).

## Stable Releases of 2019
## Docker Desktop Community 2.2.0.0

> [Download](https://hub.docker.com/?overlay=onboarding)
>
> You must sign in to Docker Hub to download Docker Desktop.
Docker Desktop 2.2.0.0 contains a Kubernetes upgrade. Your local Kubernetes cluster will be reset after installing this version.

### Upgrades

- [Docker Compose 1.25.2](https://github.com/docker/compose/releases/tag/1.25.2)
- [Kubernetes 1.15.5](https://github.com/kubernetes/kubernetes/releases/tag/v1.15.5)
- Linux kernel 4.19.76
- [QEMU 4.0.1](https://github.com/docker/binfmt)

### New

- **Docker Desktop Dashboard:** The new Docker Desktop **Dashboard** provides a user-friendly interface which enables you to interact with containers and applications, and manage the lifecycle of your applications directly from the UI. In addition, it allows you to access the logs, view container details, and monitor resource utilization to explore the container behavior.
For detailed information about the new Dashboard UI, see [Docker Desktop Dashboard](dashboard.md).

- Introduced a new user interface for the Docker Desktop **Preferences** menu.
- The Restart, Reset, and Uninstall options are now available on the **Troubleshoot** menu.
- Added the ability to start and stop existing Compose-based applications and view combined logs in the Docker Desktop **Dashboard** UI.

### Bug fixes and minor changes

- Added missing completions for the `fish` shell for Docker Compose. Fixes [docker/for-mac#3795](https://github.com/docker/for-mac/issues/3795).
- Fixed a bug that did not allow users to copy and paste text in the **Preferences** > **Daemon** window. Fixes [docker/for-mac#3798](https://github.com/docker/for-mac/issues/3798).
- Added support for `Expect: 100-continue` headers in the Docker API proxy. Some HTTP clients such as `curl` send this header when the payload is large, for example, when creating containers. Fixes [moby/moby#39693](https://github.com/moby/moby/issues/39693).
- Added a loading overlay to the **Settings** and **Troubleshoot** windows to prevent editing conflicts.
- Deactivated the **Reset Kubernetes** button when Kubernetes is not activated.
- Improved the navigation in **Settings** and **Troubleshoot** UI.
- Fixed a bug in the UEFI boot menu that sometimes caused Docker Desktop to hang during restart. Fixes [docker/for-mac#2655](https://github.com/docker/for-mac/issues/2655) and [docker/for-mac#3921](https://github.com/docker/for-mac/issues/3921).
- Docker Desktop now allows users to access the host’s SSH agent inside containers. Fixes [docker/for-mac#410](https://github.com/docker/for-mac/issues/410)
- Docker Machine is no longer included in the Docker Desktop installer. You can download it separately from the [Docker Machine releases](https://github.com/docker/machine/releases) page.
- Fixed an issue that caused VMs running on older hardware with macOS Catalina to fail on startup with the error `processor does not support desired secondary processor-based controls`.
- Fixed port forwarding when containers are using `overlay` networks.
- Fixed a container start error when a container has more than one port with an arbitrary or not-yet-configured external port number. For example, `docker run -p 80 -p 443 nginx`. Fixes [docker/for-win#4935](https://github.com/docker/for-win/issues/4935) and [docker/compose#6998](https://github.com/docker/compose/issues/6998).
- Fixed an issue that occurs when sharing overlapping directories.
- Fixed a bug that prevented users from changing the location of the VM disk image.
- Docker Desktop does not inject `inotify` events on directories anymore as these can cause mount points to disappear inside containers. Fixes [docker/for-mac#3976](https://github.com/docker/for-mac/issues/3976).
- Fixed an issue that caused Docker Desktop to fail on startup when there is an incomplete Kubernetes config file.
- Fixed an issue where attempts to log into Docker through Docker Desktop could sometimes fail with the `Incorrect authentication credentials` error. Fixes [docker/for-mac#4010](https://github.com/docker/for-mac/issues/4010).

### Known issues

- When you start a Docker Compose application and then start a Docker App which has the same name as the Compose application, Docker Desktop displays only one application on the Dashboard. However, when you expand the application, containers that belong to both applications are displayed on the Dashboard.

- When you deploy a Docker App with multiple containers on Kubernetes, Docker Desktop displays each Pod as an application on the Dashboard.


## Docker Desktop Community 2.1.0.5
2019-11-18
Expand Down Expand Up @@ -795,4 +844,4 @@ events or unexpected unmounts.

* Docker 1.12.0
* Docker Machine 0.8.0
* Docker Compose 1.8.0
* Docker Compose 1.8.0
2 changes: 1 addition & 1 deletion docker-for-mac/space.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Docker Desktop stores Linux containers and images in a single, large "disk image
To locate the disk image file, select the Docker icon and then
**Preferences** > **Resources** > **Advanced**.

![Disk preferences](images/menu/prefs-advanced.png)
![Disk preferences](images/menu/prefs-advanced.png){:width="750px"}

The **Advanced** tab displays the location of the disk image. It also displays the maximum size of the disk image and the actual space the disk image is consuming. Note that other tools might display space usage of the file in terms of the maximum file size, and not the actual file size.

Expand Down
9 changes: 3 additions & 6 deletions docker-for-mac/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,21 @@ title: Logs and troubleshooting

This page contains information on how to diagnose and troubleshoot Docker Desktop issues, send logs and communicate with the Docker Desktop team, use our forums and Success Center, browse and log issues on GitHub, and find workarounds for known problems.

## Docker Success Center

**Looking for help with Docker Desktop on Mac?** Check out the [Docker Success Center](http://success.docker.com/) for knowledge base articles, FAQs, and
technical support for various subscription levels.

## Troubleshoot

Choose ![whale menu](images/whale-x.png){: .inline} > **Troubleshoot**
from the menu bar to see the troubleshoot options.

![Uninstall or reset Docker](images/menu/troubleshoot.png){: .with-border}
![Uninstall or reset Docker](images/menu/troubleshoot.png){:width="750px"}

The Troubleshoot page contains the following options:

* **Restart Docker Desktop**: Select to restart Docker Desktop.

* **Run Diagnostics**: Select this option to diagnose any issues on Docker Desktop. For detailed information about diagnostics, see [Diagnose problems, send feedback, and create GitHub issues](#diagnose-problems-send-feedback-and-create-github-issues).

* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](/docker-for-mac/index/#kubernetes).

* **Reset disk image**: This option resets all Docker data _without_ a
reset to factory defaults. Selecting this option results in the loss of existing settings.

Expand Down
Loading

0 comments on commit 1f587d4

Please sign in to comment.