Supportability

Explore this Page

Overview

The Supportability Tool is a diagnostic utility designed to collect comprehensive information from a Kubernetes cluster using DataCore Puls8. This tool simplifies the process of generating support bundles that include logs, system configurations, topologies, and metadata from multiple components. These bundles are instrumental for troubleshooting and root cause analysis during support engagements.

This document provides instructions on how to use the Supportability Tool, describes the content, and outlines what sensitive information may be included.

Using the Supportability Tool

The Supportability Tool operates via a command-line interface through the kubectl puls8 plugin. The dump command aggregates system logs, configurations, and topological data into a single archive file for analysis.

Generate a Complete Support Bundle

Copy
Generate a Support Bundle with all System Information
kubectl puls8 dump system -n puls8 -d <output_directory_path>

View Help for the Dump Command

Copy
Display all Available Options and Sub-Commands Supported by the Dump Command
kubectl puls8 dump --help

Command Reference

Copy
Detailed Options and Subcommands for the Kubectl Puls8 Dump Command
Supportability related operations

Commands:
  system  Collects entire system information
  help    Print this message or the help of the given subcommand(s)

Arguments:
  [LICENSE_AGENT_URI]  Override the URI to the license agent endpoint

Options:
  -t, --timeout <TIMEOUT>
          Specifies the timeout value to interact with other modules of system [default: 10s]
  -s, --since <SINCE>
          Period states to collect all logs from last specified duration [default: 24h]
  -l, --loki-endpoint <LOKI_ENDPOINT>
          Endpoint of LOKI service, if left empty then it will try to parse endpoint from Loki service(K8s service resource), if the tool is unable to parse from service then logs will be collected using Kube-apiserver
  -e, --etcd-endpoint <ETCD_ENDPOINT>
          Endpoint of ETCD service, if left empty then will be parsed from the internal service name
  -d, --output-directory-path <OUTPUT_DIRECTORY_PATH>
          Output directory path to store archive file [default: ./]
      --tenant-id <TENANT_ID>
          The tenant id to be used to query loki logs [default: puls8]
      --logging-label-selectors <LOGGING_LABEL_SELECTORS>
          Logging label selectors [default: openebs.io/logging=true,datacore.com/logging=true]
  -n, --namespace <NAMESPACE>
          Namespace where Puls8 is installed. If unset, defaults to the default namespace in the current context
  -k, --kube-config-path <KUBE_CONFIG_PATH>
          Path to kubeconfig file
      --agent-uri <AGENT_URI>
          Override the URI to the license agent endpoint
  -h, --help
          Print help

Supportability - collects state & log information of services and dumps it to a tar file.

Does the Supportability Tool Expose Sensitive Information?

The Supportability Tool is designed with diagnostics and debugging in mind. While its purpose is to streamline troubleshooting, you should be aware of potentially sensitive data included in the generated archives. This data is only collected upon explicit user invocation.

Possible Sensitive Data Includes:

  • Logs from pods labeled with openebs.io/logging=true (hostnames, IPs, endpoints, container and PV names, etc.)
  • Kubernetes Resource Definitions such as Deployments, DaemonSets, StatefulSets, VolumeSnapshots.
  • Kubernetes Events from the Puls8 namespace.
  • OpenEBS specific custom resources.
  • ETCD Dump entries that include internal key-value states such as:
    • Hostnames, IPs, container and volume names
    • Application references within the namespace
    • Disk and device metadata (excluding content)

The list of potentially sensitive items is regularly reviewed, though the definition of "sensitive" may vary by organization.

Benefits of Supportability

  • Enables rapid diagnosis of issues.
  • Consolidates logs and configurations for faster root cause analysis.
  • Minimizes troubleshooting time by providing a structured support bundle.

Learn More