From 7111e03021e8048cc6ead7c855e11fac95000f19 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 22 Mar 2018 17:49:08 +0000 Subject: [PATCH] docs: Mention collect script in dev guide Add details of the collect script in under the "Troubleshoot" section. Fixes #34. Signed-off-by: James O. D. Hunt --- Developer-Guide.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/Developer-Guide.md b/Developer-Guide.md index 6d7b2d409..5c24a0615 100644 --- a/Developer-Guide.md +++ b/Developer-Guide.md @@ -15,7 +15,7 @@ * [Install guest kernel images](#install-guest-kernel-images) * [Update Docker configuration](#update-docker-configuration) * [Create a Kata Container](#create-a-kata-container) -* [Troubleshoot](#troubleshoot) +* [Troubleshoot Kata Containers](#troubleshoot-kata-containers) * [Appendices](#appendices) * [Checking Docker default runtime](#checking-docker-default-runtime) @@ -184,7 +184,19 @@ $ sudo systemctl restart docker $ sudo docker run -ti --runtime kata-runtime busybox sh ``` -# Troubleshoot +# Troubleshoot Kata Containers + +If you are unable to create a Kata Container first ensure you have +[enabled full debug](#enable-full-debug) +before attempting to create a container. Then run the +[`kata-collect-data.sh`](https://github.com/kata-containers/runtime/blob/master/data/kata-collect-data.sh.in) +script and paste its output directly into a +[github issue](https://github.com/kata-containers/kata-containers/issues/new). + +> **Note:** +> +> The `kata-collect-data.sh` script is built from the +> [runtime](https://github.com/kata-containers/runtime) repository. To perform analysis on Kata logs, use the [`kata-log-parser`](https://github.com/kata-containers/tests/tree/master/cmd/log-parser)