Skip to main content

Create a Konvoy Diagnostic Bundle

Dustin Nemes
  • Updated

Overview

In order to effectively troubleshoot a Konvoy cluster, it may be necessary to gather a set of logs from all Konvoy nodes and components. The following instructions will provide guidance for that task.


How-to

Before creating a diagnostic bundle, we suggest first running the built-in Konvoy checks to assist in identifying possible issues. Konvoy checks are diagnostics focused on Kubernetes’ core system, the underlying infrastructure, and the operational tools Konvoy provides within Kubernetes (e.g., addons).

konvoy check

For more information on troubleshooting Konvoy clusters, please see: https://docs.d2iq.com/dkp/konvoy/1.8/troubleshooting/tools-and-techniques/

Should you require further assistance after evaluating the Konvoy checks, you can create a Konvoy diagnostic bundle by performing the following steps:

  1. Change to the directory that contains the state files for your Konvoy cluster state.
  2. Generate a compressed archive containing diagnostic information by executing the following command:
konvoy diagnose
Note that the diagnose subcommand has many flags that can be used to gather additional cluster information. To view all available flags, you can use the --help flag: 
konvoy diagnose --help
Creates a diagnostics bundle of the cluster in the form of a gzipped tar archive. Such a bundle contains a lot of information about the current state of the cluster, e.g. log files, networking parameters and pod status in order to be able to diagnose issues

Usage:
  konvoy diagnose [flags]

Flags:
  -h, --help                      help for diagnose
      --logs-all-namespaces       include logs from pods in all namespaces
      --logs-namespaces strings   include logs from pods in the given namespaces (default [kubeaddons,kube-system,cert-manager,pumpkin,kube-public,kube-node-lease,velero,kommander,kommander-system,kudo-system,velero-minio-operator])
  -o, --output string             file name to use for storing the diagnostics bundle in (default "/tmp/konvoy/konvoy_v1.3.0/20200127T202053.tar.gz")
  -s, --since d                   Log files will be queried up to  in the past. Supports d and `h` for days and hours respectively (default "2d")
  -y, --yes                       run command without prompting