Add docs for Vuln scanning and troubleshoot updates (#11677)

* Add docs for Vuln scanning and troubleshoot updates

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Add new section on Desktop support

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Fix review comments and add support section for Windows

* Replace existing screenshots with optimized versions
This commit is contained in:
Usha Mandya 2020-11-02 16:29:14 +00:00 committed by GitHub
parent 766b29e09e
commit 3499c1a261
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 197 additions and 39 deletions

View File

@ -11,7 +11,7 @@ The Docker Dashboard provides a simple interface that enables you to manage your
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.
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.
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 displays a summary of the vulnerability scanning report using Snyk. In addition, the Images view 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 Docker Dashboard allows you to:
@ -200,11 +200,15 @@ An **unused** image is an image which is not used by any running or stopped cont
### 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 Images view also allows you to manage and interact with images in remote repositories and lets you switch between organizations. Select an organization from the drop-down to view a list of repositories in your organization.
> **Note**
>
> If you have subscribed to a Pro or a Team plan and enabled [Vulnerability Scanning](../docker-hub/vulnerability-scanning.md) in Docker Hub, the scan results will appear on the Remote repositories tab.
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"}
![Images in remote repositories](images/image-details.png){:width="700px"}
To interact with remote repositories:
@ -212,3 +216,7 @@ To interact with remote repositories:
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**.
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.
If you have subscribed to a Pro or a Team plan and have enabled [Vulnerability Scanning](../docker-hub/vulnerability-scanning.md) the Docker Hub page also displays a summary of the vulnerability scan report and provides detailed information about the vulnerabilities identified.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 176 KiB

After

Width:  |  Height:  |  Size: 326 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 76 KiB

View File

@ -4,26 +4,27 @@ keywords: mac, troubleshooting, logs, issues
redirect_from:
- /mackit/troubleshoot/
title: Logs and troubleshooting
toc_max: 2
---
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.
This page contains information on how to diagnose and troubleshoot Docker Desktop issues, request Docker Desktop support (Pro and Team plan users only), 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.
## 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){:width="750px"}
![Troubleshoot Docker Desktop](images/menu/troubleshoot.png){:width="600px"}
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).
* **Support**: Developers on Pro and Team plans can use this option to send a support request. Other users can use this option to diagnose any issues in Docker Desktop. For more information, see [Diagnose and feedback](#diagnose-and-feedback) and [Support](#support).
* **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
* **Clean / Purge data**: This option resets all Docker data _without_ a
reset to factory defaults. Selecting this option results in the loss of existing settings.
* **Reset to factory defaults**: Choose this option to reset all options on
@ -46,27 +47,38 @@ system.
>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.
## Diagnose problems, send feedback, and create GitHub issues
## Diagnose and feedback
### In-app diagnostics
If you encounter problems for which you do not find solutions in this
documentation, on [Docker Desktop issues on
GitHub](https://github.com/docker/for-mac/issues), or the [Docker Desktop forum](https://forums.docker.com/c/docker-for-mac), we can help you troubleshoot
the log data.
the log data. Before reporting an issue, we recommend that you read the information provided on this page to fix some common known issues.
Choose ![whale menu](images/whale-x.png){: .inline} > **Troubleshoot** > **Run Diagnostics**.
>**Note**
>
> Docker Desktop offers support for users subscribed to a Pro or a Team plan. If you are experiencing any issues with Docker Desktop, follow the instructions in this section to send a support request to Docker Support.
![Diagnose & Feedback](images/diagnose-feedback.png){:width="600px"}
Before you get started, we recommend that you sign into your Docker Desktop application and your [Docker Hub](https://hub.docker.com/){:target="_blank" rel="noopener" class="_"} account.
Once the diagnostics are available, you can upload them and obtain a
**Diagnostic ID**, which must be provided when communicating with the Docker
team. For more information on our policy regarding personal data, see
[how is personal data handled in Docker Desktop](faqs.md#how-is-personal-data-handled-in-docker-desktop).
1. Choose ![whale menu](images/whale-x.png){: .inline} > **Troubleshoot**.
2. Sign into Docker Desktop. In addition, ensure you are signed into your [Docker account](https://hub.docker.com/){:target="_blank" rel="noopener" class="_"}.
3. Click **Get Support**. This opens the in-app **Diagnose & Support** (**Diagnose & Feedback** for free users) page and starts collecting the diagnostics.
![Diagnostics & Feedback with ID](images/diagnose-feedback-id.png){:width="600px"}
![Diagnose & Feedback](images/diagnose-support.png){:width="600px"}
If you click **Report an issue**, this opens Docker Desktop [for Mac](https://github.com/docker/for-mac/issues/) issues on GitHub in your web browser in a "New issue" template. Add the details before submitting the issue. Do not forget to copy/paste your diagnostic ID.
4. When the diagnostics collection process is complete, click **Upload** to upload your diagnostics to Docker Desktop.
5. When the diagnostics have been uploaded, Docker Desktop prints a Diagnostic ID. Copy this ID.
6. If you have subscribed to a Pro or a Team plan, click **Get support**. This opens the [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"} form. Fill in the information required and add the ID you copied earlier to the Diagnostics ID field. Click **Submit** to request Docker Desktop support.
> **Note**
>
> You must be signed in to Docker Desktop using your Pro or Team plan credentials to access the support form. For information on what's covered as part of Docker Desktop support, see [Support](#support).
7. If you are not subscribed to a Pro or a team plan, you can click **Upgrade your account** to upgrade your existing account.
Alternatively, click **Report an issue** to open a new Docker Desktop issue on GitHub. This opens Docker Desktop [for Mac](https://github.com/docker/for-mac/issues/) on GitHub in your web browser in a 'New issue' template. Complete the information required and ensure you add the diagnostic ID you copied earlier. Click **submit new issue** to create a new issue.
### Diagnosing from the terminal
@ -103,12 +115,11 @@ $ open /tmp/BE9AFAAF-F68B-41D0-9D12-84760E6B8740/20190905152051.zip
```
<a name="logs"></a>
## Check the logs
In addition to using the diagnose and feedback option to submit logs, you can
browse the logs yourself. The following documentation is about macOS 10.12
onwards; for older versions, see
[older documentation](https://github.com/docker/docker.github.io/blob/v17.12/docker-for-mac/troubleshoot.md#check-the-logs).
browse the logs yourself.
#### In a terminal
@ -342,3 +353,71 @@ in the Apple documentation, and Docker Desktop [Mac system requirements](install
sudo launchctl unload /System/Library/LaunchDaemons/org.ntp.ntpd.plist
sudo launchctl load /System/Library/LaunchDaemons/org.ntp.ntpd.plist
```
## Support
This section contains information on how to get support on Docker Desktop.
>**Note**
>
> Docker Desktop offers support for Pro and Team users only. For more information about the pricing plans, see [Docker Pricing](https://www.docker.com/pricing){: target="_blank" rel="noopener" class="_"}.
### How do I get Docker Desktop support?
If you have subscribed to a Pro and Team account, please raise a ticket through [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"}.
Docker Community users can get support through our Github repos for-win and for-mac, where we respond on a best-effort basis.
### What support can I get?
If you are a Pro or a Team user, you can request for support on the following types of issues:
* Desktop upgrade issues
* Desktop installation issues
* Installation crashes
* Failure to launch Docker Desktop on first run
* Usage issues
* Crash closing software
* Docker Desktop not behaving as expected
* Configuration issues
* Basic product how to questions
### What is not supported?
Docker Desktop excludes support for the following types of issues:
* Use on or in conjunction with hardware or software other than that specified in the applicable documentation
* Running on unsupported operating systems, including beta/preview versions of operating systems
* Support for the Docker engine, Docker CLI, or other bundled Linux components
* Support for Kubernetes
* Features labeled as experimental
* System/Server administration activities
* Supporting Desktop as a production runtime
* Scale deployment/multi-machine installation of Desktop
* Routine product maintenance (data backup, cleaning disk space and configuring log rotation)
* Third-party applications not provided by Docker
* Altered or modified Docker software
* Defects in the Docker software due to hardware malfunction, abuse, or improper use
* Any version of the Docker software other than the latest version
* Reimbursing and expenses spent for third-party services not provided by Docker
* Docker Support excludes training, customization, and integration
### What versions are supported?
We currently only offer support for the latest version of Docker Desktop. If you are running an older version, you may be asked to upgrade before we investigate your support request.
### How many machines can I get support for Docker Desktop on?
As a Pro user you can get support for Docker Desktop on a single machine.
As a Team, you can get support for Docker Desktop for the number of machines equal to the number of seats as part of your plan.
### What OSs are supported?
Docker Desktop is available for Mac and Windows. The supported version information can be found on the following pages:
* [Mac system requirements](../docker-for-mac/install.md#system-requirements)
* [Windows system requirements](../docker-for-windows/install.md#system-requirements)
### Can I run Docker Desktop on Virtualized hardware?
No, currently this is unsupported and against the terms of use.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

@ -5,31 +5,32 @@ redirect_from:
- /windows/troubleshoot/
- /docker-for-win/troubleshoot/
title: Logs and troubleshooting
toc_max: 2
---
This page contains information on how to diagnose and troubleshoot problems, send logs and communicate with the Docker Desktop team, use our forums and Knowledge Hub, browse and log issues on GitHub, and find workarounds for known problems.
This page contains information on how to diagnose and troubleshoot Docker Desktop issues, request Docker Desktop support (Pro and Team plan users only), 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.
## Troubleshoot
Choose ![whale menu](images/whale-x.png){: .inline} > **Troubleshoot**
from the menu bar to see the troubleshoot options.
![Uninstall or reset Docker](images/troubleshoot.png){:width="750px"}
![Troubleshoot Docker Desktop](images/troubleshoot.png){:width="600px"}
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).
* **Clean / Purge data**: Select this option to delete container and image data. Choose whether you'd like to delete data from Hyper-V, WSL 2, or Windows Containers and then click **Delete** to confirm.
* **Support**: Developers on Pro and Team plans can use this option to send a support request. Other users can use this option to diagnose any issues in Docker Desktop. For more information, see [Diagnose and feedback](#diagnose-and-feedback) and [Support](#support).
* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](index.md#kubernetes).
* **Clean / Purge data**: Select this option to delete container and image data. Choose whether you'd like to delete data from Hyper-V, WSL 2, or Windows Containers and then click **Delete** to confirm.
* **Reset to factory defaults**: Choose this option to reset all options on
Docker Desktop to their initial state, the same as when Docker Desktop was first installed.
## Diagnose problems, send feedback, and create GitHub issues
## Diagnose and feedback
### In-app diagnostics
@ -37,26 +38,26 @@ If you experience issues for which you do not find solutions in this
documentation, on [Docker Desktop for Windows issues on
GitHub](https://github.com/docker/for-win/issues), or the [Docker Desktop for Windows
forum](https://forums.docker.com/c/docker-for-windows), we can help you
troubleshoot the log data.
troubleshoot the log data. Before reporting an issue, we recommend that you read the information provided on this page to fix some common known issues.
Choose ![whale menu](images/whale-x.png){: .inline} > **Troubleshoot**
1. Choose ![whale menu](images/whale-x.png){: .inline} > **Troubleshoot**
from the menu.
2. Sign into Docker Desktop. In addition, ensure you are signed into your [Docker account](https://hub.docker.com/){:target="_blank" rel="noopener" class="_"}.
3. Click **Get Support**. This opens the in-app **Diagnose & Support** (**Diagnose & Feedback** for free users) page and starts collecting the diagnostics.
![Diagnose & Feedback](images/diagnose-feedback.png){:width="600px"}
![Diagnose & Support](images/diagnose-support.png){:width="600px"}
When the **Diagnose & Feedback** window initiated, it starts collecting diagnostics. When the diagnostics are available, you can upload them and obtain a **Diagnostic ID**, which must be provided when communicating with the Docker
team. For more information on our policy regarding personal data, see
[how is personal data handled in Docker
Desktop](https://docs.docker.com/docker-for-mac/faqs/#how-is-personal-data-handled-in-docker-desktop).
4. When the diagnostics collection process is complete, click **Upload** to upload your diagnostics to Docker Desktop.
5. When the diagnostics have been uploaded, Docker Desktop prints a Diagnostic ID. Copy this ID.
6. If you have subscribed to a Pro or a Team plan, click **Get support**. This opens the [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"} form. Fill in the information required and add the ID you copied earlier to the Diagnostics ID field. Click **Submit** to request Docker Desktop support.
![Diagnose & Feedback with ID](images/diagnostic-id.png){:width="600px"}
> **Note**
>
> You must be signed in to Docker Desktop using your Pro or Team plan credentials to access the support form. For information on what's covered as part of Docker Desktop support, see [Support](#support).
If you click on **Report an issue**, it opens [Docker Desktop for Windows issues on
GitHub](https://github.com/docker/for-win/issues/) in your web browser in a
"New issue" template, to be completed before submission. Do not forget to
include your diagnostic ID.
7. If you are not subscribed to a Pro or a team plan, you can click **Upgrade your account** to upgrade your existing account.
![issue-template](images/issue-template.png){:width="600px"}
Alternatively, click **Report an issue** to open a new Docker Desktop issue on GitHub. This opens Docker Desktop [for Windows](https://github.com/docker/for-win/issues/) on GitHub in your web browser in a 'New issue' template. Complete the information required and ensure you add the diagnostic ID you copied earlier. Click **submit new issue** to create a new issue.
### Diagnosing from the terminal
@ -459,3 +460,73 @@ manifests as an error response from the Docker daemon and a Docker Desktop start
For a temporary workaround, uninstall the anti-virus software, or
explore other workarounds suggested on Docker Desktop forums.
## Support
This section contains information on how to get support on Docker Desktop.
>**Note**
>
> Docker Desktop offers support for Pro and Team users only. For more information about the pricing plans, see [Docker Pricing](https://www.docker.com/pricing){: target="_blank" rel="noopener" class="_"}.
### How do I get Docker Desktop support?
If you have subscribed to a Pro and Team account, please raise a ticket through [Docker Desktop support](https://hub.docker.com/support/desktop/){:target="_blank" rel="noopener" class="_"}.
Docker Community users can get support through our Github repos for-win and for-mac, where we respond on a best-effort basis.
### What support can I get?
If you are a Pro or a Team user, you can request for support on the following types of issues:
* Desktop upgrade issues
* Desktop installation issues
* Enabling virtualization in BIOS
* Enabling Windows features
* Installation crashes
* Failure to launch Docker Desktop on first run
* Usage issues
* Crash closing software
* Docker Desktop not behaving as expected
* Configuration issues
* Basic product how to questions such as how to work efficiently on WSL 2
### What is not supported?
Docker Desktop excludes support for the following types of issues:
* Use on or in conjunction with hardware or software other than that specified in the applicable documentation
* Running on unsupported operating systems, including beta/preview versions of operating systems
* Support for the Docker engine, Docker CLI, or other bundled Linux components
* Support for Kubernetes
* Features labeled as experimental
* System/Server administration activities
* Supporting Desktop as a production runtime
* Scale deployment/multi-machine installation of Desktop
* Routine product maintenance (data backup, cleaning disk space and configuring log rotation)
* Third-party applications not provided by Docker
* Altered or modified Docker software
* Defects in the Docker software due to hardware malfunction, abuse, or improper use
* Any version of the Docker software other than the latest version
* Reimbursing and expenses spent for third-party services not provided by Docker
* Docker Support excludes training, customization, and integration
### What versions are supported?
We currently only offer support for the latest version of Docker Desktop. If you are running an older version, you may be asked to upgrade before we investigate your support request.
### How many machines can I get support for Docker Desktop on?
As a Pro user you can get support for Docker Desktop on a single machine.
As a Team, you can get support for Docker Desktop for the number of machines equal to the number of seats as part of your plan.
### What OSs are supported?
Docker Desktop is available for Mac and Windows. The supported version information can be found on the following pages:
* [Windows system requirements](../docker-for-windows/install.md#system-requirements)
* [Mac system requirements](../docker-for-mac/install.md#system-requirements)
### Can I run Docker Desktop on Virtualized hardware?
No, currently this is unsupported and against the terms of use.