Add docs for Images view

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
This commit is contained in:
Usha Mandya 2020-09-29 07:54:47 +01:00
parent 5652b50356
commit ec69a333e7
5 changed files with 122 additions and 42 deletions

View File

@ -1,37 +1,33 @@
---
description: Docker Desktop Dashboard
keywords: Docker Desktop Dashboard, container view
title: Docker Desktop Dashboard
description: Docker Dashboard
keywords: Docker Dashboard, manage, containers, images
title: Docker Dashboard
redirect_from:
- /docker-for-mac/dashboard/
- /docker-for-windows/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 Dashboard provides a simple interface that enables you to manage your containers, applications, and images directly from your machine without having to use the CLI to perform core actions.
The Docker Desktop Dashboard offers the following benefits:
The **Containers/Apps** view provides a runtime view of all your containers and applications. It allows you to interact with containers and applications, and manage the lifecycle of your applications directly from your machine. This view also provides an intuitive interface to perform common actions to inspect, interact with, and manage your Docker objects including containers and Docker Compose-based applications.
- 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
The **Images** view displays a list of your Docker images, and allows you to run an image as a container, pull the latest version of an image from Docker Hub, and inspect images. It also contains clean up options to remove unwanted images from the disk to reclaim space. If you are logged in, you can also see the images you and your organization have shared on Docker Hub.
In addition, the Dashboard UI allows you to:
In addition, the Docker Dashboard allows you to:
- Navigate to the **Preferences** (**Settings** in Windows) menu to configure Docker Desktop preferences
- Easily navigate to the **Preferences** (**Settings** in Windows) menu to configure Docker Desktop preferences
- Access the **Troubleshoot** menu to debug and perform restart operations
- Sign into [Docker Hub](https://hub.docker.com/) 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)
To access the Docker Dashboard, from the Docker menu, select **Dashboard**. On Windows, click the Docker icon to open the Dashboard.
## 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.
From the Docker menu, select **Dashboard**. This lists all your running containers and applications. You must have running or stopped containers and applications to see them listed on the Docker 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.
![Docker Desktop Dashboard](images/mac-dashboard.png)
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 Dashboard.
### Start a Redis container
@ -41,15 +37,9 @@ To start a Redis container, open your preferred CLI and run the following comman
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](images/example-app-architecture.png){:width="600px"}
The example voting app contains:
Let's start a sample application. 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. The app contains:
- A front-end web app in [Python](https://github.com/dockersamples/example-voting-app/blob/master/vote) or [ASP.NET Core](https://github.com/dockersamples/example-voting-app/blob/master/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
@ -59,7 +49,7 @@ The example voting app contains:
To start the application, navigate to the directory containing the example voting application in the CLI and run `docker-compose up --build`.
```
```shell
$ 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
@ -71,13 +61,6 @@ 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
@ -91,7 +74,7 @@ Attaching to db, redis, example-voting-app-master_result_1, example-voting-app-m
...
```
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.
When the application starts successfully, 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"}
@ -105,17 +88,17 @@ Use the **Search** option to search for a specific object. You can also sort you
## Interact with containers and applications
From the Docker Desktop Dashboard, select the example voting application we started earlier.
From the Docker 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.
The **Containers/Apps** 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. Use the **Search** option at the bottom of the logs view to search application logs for specific events, or select the **Copy** icon to copy the logs to your clipboard.
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.
Click **Open in Visual Studio Code** to open the application to open the application in VS Code. Hover over the list of containers to see some of the core actions you can perform.
![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.
## Container view
![Explore the app](images/mac-container-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.
- Select **Logs** to see logs from the container. You can also search the logs for specific events and copy the logs to your clipboard.
@ -125,10 +108,107 @@ Click on a specific container for detailed information about the container. The
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.
## Explore your images
![Spring app browser view](images/mac-browser-view.png){:width="700px"}
The **Images** view is a simple interface that lets you manage Docker images without having to use the CLI. By default, it displays a list of all Docker images on your local disk. To view images in remote repositories, click **Sign in** and connect to Docker Hub. This allows you to collaborate with your team and manage your images directly through Docker Desktop.
## Feedback
The Images view allows you to perform core operations such as running an image as a container, pulling the latest version of an image from Docker Hub, pushing the image to Docker Hub, and inspecting images.
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) or [docker/for-win](https://github.com/docker/for-win/issues) GitHub repository.
In addition, the Images view displays metadata about the image such as the tag, image ID, date when the image was created, and the size of the image. It also displays **In Use** tags next to images used by running and stopped containers. This allows you to review the list of images and use the **Clean up images** option to remove any unwanted images from the disk to reclaim space.
The Images view also allows you to search images on your local disk and sort them using various options.
Let's explore the various options in the **Images** view.
If you dont have any images on your disk, run the command `docker pull redis` in a terminal to pull the latest Redis image. This command pulls the latest Redis image from Docker Hub.
Select **Dashboard** > **Images** to see the Redis image.
![Redis image](images/redis-image.png){:width="700px"}
### Run an image as a container
Now that you have a Redis image on your disk, lets run this image as a container:
1. From the Docker menu, select **Dashboard** > **Images**. This displays a list of images on your local disk.
2. Select the Redis image from the list and click **Run**.
3. When prompted, click the **Optional settings** drop-down to specify a name, port, volumes, and click **Run**.
To use the defaults, click **Run** without specifying any optional settings. This creates a new container from the Redis image and opens it on the **Container/Apps** view.
### Pull the latest image from Docker Hub
To pull the latest image from Docker Hub:
1. From the Docker menu, select **Dashboard** > **Images**. This displays a list of images on your local disk.
2. Select the image from the list and click the more options button.
3. Click **Pull**. This pulls the latest version of the image from Docker Hub.
> **Note**
>
> The repository must exist on Docker Hub in order to pull the latest version of an image. You must be logged in to pull private images.
### Push an image to Docker Hub
To push an image to Docker Hub:
1. From the Docker menu, select **Dashboard** > **Images**. This displays a list of images on your local disk.
2. Select the image from the list and click the more options button.
3. Click **Push to Hub.**
> **Note**
>
> You can only push an image to Docker Hub if the image belongs to your Docker ID or your organization. That is, the image must contain the correct username/organization in its tag to be able to push it to Docker Hub.
### Inspect an image
Inspecting an image displays detailed information about the image such as the image history, image ID, the date the image was created, size of the image, etc. To inspect an image:
1. From the Docker menu, select **Dashboard** > **Images**. This displays a list of images on your local disk.
2. Select the image from the list and click the more options button.
3. Click **Inspect**.
4. The image inspect view also provides options to pull the latest image, push image to Hub, remove the image, or run the image as a container.
### Remove an image
The **Images** view allows you to remove unwanted images from the disk. The Images on disk status bar displays the number of images and the total disk space used by the images.
You can remove individual images or use the **Clean up** option to delete unused and dangling images.
To remove individual images:
1. From the Docker menu, select **Dashboard** > **Images**. This displays a list of images on your local disk.
2. Select the image from the list and click the more options button.
3. Click **Remove**. This removes the image from your disk.
> **Note**
>
> To remove an image used by a running or a stopped container, you must first remove the associated container.
**To remove unused and dangling images:**
An **unused** image is an image which is not used by any running or stopped containers. An image becomes **dangling** when you build a new version of the image with the same tag.
**To remove an unused or a dangling image:**
1. From the Docker menu, select **Dashboard** > **Images**. This displays a list of images on your disk.
2. Select the **Clean up** option from the **Images on disk** status bar.
3. Use the **Unused** and **Dangling** check boxes to select the type of images you would like to remove.
The **Clean up** images status bar displays the total space you can reclaim by removing the selected images.
4. Click **Remove** to confirm.
### Interact with remote repositories
The Images view also allows you to manage and interact with images in remote repositories and lets you switch between organizations.
The **Pull** option allows you to pull the latest version of the image from Docker Hub. The **View in Hub** option opens the Docker Hub page and displays detailed information about the image, such as the OS architecture, size of the image, the date when the image was pushed, and a list of the image layers.
![View image in Hub](images/image-details.png){:width="700px"}
To interact with remote repositories:
1. Click the **Remote repositories** tab.
2. Select an organization from the drop-down list. This displays a list of repositories in your organization.
3. Click on an image from the list and then select **Pull** to pull the latest image from the remote repository.
4. To view a detailed information about the image in Docker Hub, select the image and then click **View in Hub**.

Binary file not shown.

After

Width:  |  Height:  |  Size: 176 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 226 KiB

After

Width:  |  Height:  |  Size: 274 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 150 KiB