Skip to main content

Kernel Configs

Kernel Configs Collector​

To collect information about the available Kernel Configs, you can use the kernelConfigs collector.

Only config options with values =y (built into kernel), =m (loadable module) or =n (feature is disabled) will be collected.

Parameters​

None.

Example Collector Definition​

apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
metadata:
  name: kernel-configs
spec:
  hostCollectors:
    - kernelConfigs: {}

Included Resources​

The results of the kernelConfigs collector are stored in the host-collectors/system directory of the support bundle.

kernel-configs.json​

Example of the resulting JSON file:

{
  "CONFIG_9P_FS": "y",
  "CONFIG_ARCH_CORRECT_STACKTRACE_ON_KRETPROBE": "y",
  "CONFIG_ARCH_HAS_STRICT_MODULE_RWX": "y",
  "CONFIG_ARCH_HAVE_TRACE_MMIO_ACCESS": "y",
  "CONFIG_ARCH_SUPPORTS_UPROBES": "y",
  "CONFIG_ARCH_WANT_DEFAULT_BPF_JIT": "y",
  "CONFIG_AUTOFS_FS": "y",
  "CONFIG_BLK_CGROUP": "y",
  "CONFIG_BLK_CGROUP_PUNT_BIO": "y"
}

Kernel Configs Analyzer​

The kernelConfigs analyzer supports only pass or fail outcomes. In the case of a fail outcome, the placeholder {{ .ConfigsNotFound }} can be used to render a list of missing kernel configurations in the message.

Parameters​

selectedConfigs (Required)​

List of kernel config parameters that must be available.

Example Analyzer Definition​

apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
metadata:
  name: kernel-configs
spec:
  hostCollectors:
    - kernelConfigs: {}
  hostAnalyzers:
    - kernelConfigs:
        collectorName: "Kernel Configs Test"
        strict: true
        selectedConfigs:
          - CONFIG_CGROUP_FREEZER=y
          - CONFIG_NETFILTER_XTABLES=m
        outcomes:
          - pass:
              message: "required kernel configs are available"
          - fail:
              message: "missing kernel config(s): {{ .ConfigsNotFound }}"