From cebc2812542c2194f9a3dc56b312d57c19047863 Mon Sep 17 00:00:00 2001
From: Akim Demaille <akim.demaille@docker.com>
Date: Fri, 25 May 2018 14:56:43 +0200
Subject: [PATCH] Mac: generating and uploading diagnostics by hand

This will soon be obsoleted by com.docker.diagnose, but meanwhile it
is still important information.

Signed-off-by: Akim Demaille <akim.demaille@docker.com>
---
 docker-for-mac/troubleshoot.md | 56 ++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/docker-for-mac/troubleshoot.md b/docker-for-mac/troubleshoot.md
index 7c9cdb93bc..b1e21d7b05 100644
--- a/docker-for-mac/troubleshoot.md
+++ b/docker-for-mac/troubleshoot.md
@@ -18,6 +18,7 @@ technical support for various subscription levels.
 
 ## Diagnose problems, send feedback, and create GitHub issues
 
+### In-app diagnostics
 If you encounter problems for which you do not find solutions in this
 documentation, on [Docker for Mac issues on
 GitHub](https://github.com/docker/for-mac/issues), or the [Docker for Mac
@@ -42,6 +43,61 @@ GitHub](https://github.com/docker/for-mac/issues/) in your web browser in a
 
 ![issue template](images/issues-template.png){:width="600px"}
 
+### Diagnosing from the terminal
+
+On occasions it is useful to run the diagnostics yourself, for instance if
+Docker for Mac cannot start.
+
+First locate the `docker-diagnose` tool.  If you installed Docker for Mac in the
+Applications directory, then it is
+`/Applications/Docker.app/Contents/Resources/bin/docker-diagnose`.  Pass
+`--help` to see the supported options:
+
+```sh
+$ /Applications/Docker.app/Contents/Resources/bin/docker-diagnose --help
+```
+
+Then to create *and upload* diagnostics, run:
+
+```sh
+$ /Applications/Docker.app/Contents/Resources/bin/docker-diagnose \
+  --upload --last 1d
+macOS: version 10.13.4 (build: 17E202)
+Docker.app: version: 18.06.0-ce-rc1-mac67 (1fa4e2acfc1a52f79623add2390604515d32297e)
+Local time: Fri May 25 14:50:51 CEST 2018
+UTC:        Fri May 25 12:50:51 UTC 2018
+Timestamp:  20180525-145051
+Running diagnostic tests:
+[OK]      Files
+[OK]      console-ring does not exist
+[OK]      Kubernetes (disabled)
+[OK]      Docker CLI
+[OK]      environment
+[OK]      vmnetd
+[OK]      osxfs
+[OK]      VPNKit
+[OK]      driver.amd64-linux
+[OK]      Docker
+[OK]      VT-x
+[OK]      kern.hv_support
+[OK]      Hypervisor
+[OK]      Disk
+Docker logs are being collected into /tmp/D1F48686-F045-4708-85E3-0635B729A596/20180525-145051.tar.gz
+Your unique id is: D1F48686-F045-4708-85E3-0635B729A596
+Please quote this in all correspondence.
+```
+
+The diagnostics ID (here D1F48686-F045-4708-85E3-0635B729A596/20180525-145051)
+is composed of your user ID (D1F48686-F045-4708-85E3-0635B729A596) and a
+timestamp (20180525-145051).  Be sure to provide us with the full diagnostics
+ID, not just the user ID.
+
+Don't hesitate browsing the content of these diagnostics:
+
+```sh
+$ open /tmp/D1F48686-F045-4708-85E3-0635B729A596/20180525-145051.tar.gz
+```
+
 
 <a name="logs"></a>
 ## Check the logs