From e9666a9d22154151de5fe220368b04bccb2bad92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabiano=20Fid=C3=AAncio?= Date: Wed, 17 Jun 2020 09:38:33 +0200 Subject: [PATCH] shimv2: Add "cri-o" debugging instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's add information on how to debug shimv2 when using cri-o, similarly to what already is present with containerd. Fixes: #672 Signed-off-by: Fabiano Fidêncio --- Developer-Guide.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/Developer-Guide.md b/Developer-Guide.md index 2407028ff3..1202d4032d 100644 --- a/Developer-Guide.md +++ b/Developer-Guide.md @@ -9,6 +9,7 @@ * [debug logs and shimv2](#debug-logs-and-shimv2) * [Enabling full `containerd` debug](#enabling-full-containerd-debug) * [Enabling just `containerd shim` debug](#enabling-just-containerd-shim-debug) + * [Enabling `CRI-O` and `shimv2` debug](#enabling-cri-o-and-shimv2-debug) * [journald rate limiting](#journald-rate-limiting) * [`systemd-journald` suppressing messages](#systemd-journald-suppressing-messages) * [Disabling `systemd-journald` rate limiting](#disabling-systemd-journald-rate-limiting) @@ -176,6 +177,25 @@ option in the `plugins.linux` section of the `containerd` configuration file, su shim_debug = true ``` +#### Enabling `CRI-O` and `shimv2` debug + +Depending on the CRI-O version being used one of the following configuration files can +be found: `/etc/crio/crio.conf` or `/etc/crio/crio.conf.d/00-default`. + +If the latter is found, the change must be done there as it'll take precedence, overriding +`/etc/crio/crio.conf`. + +```toml +# Changes the verbosity of the logs based on the level it is set to. Options +# are fatal, panic, error, warn, info, debug and trace. This option supports +# live configuration reload. +log_level = "info" +``` + +Switching the default `log_level` from `info` to `debug` enables shimv2 debug logs. +CRI-O logs can be found by using the `crio` identifier, and Kata specific logs can +be found by using the `kata` identifier. + ### journald rate limiting Enabling [full debug](#enable-full-debug) results in the Kata components generating