Supportability

The supportability tool collects OpenEBS specific information from the cluster using the kubectl plugin command-line tool. It uses the dump command, which interacts with the OpenEBS services to build an archive (ZIP) file that acts as a placeholder for the bundled information.

Using the Supportability Tool#

To bundle Replicated PV Mayastor's complete system information, execute:

Command

kubectl openebs dump system -n openebs -d <output_directory_path>

To view all the available options and sub-commands that can be used with the dump command, execute:

Command

kubectl openebs dump --help

Sample Output

Supportability related operations

Usage: kubectl-puls8 dump [OPTIONS] [LICENSE_AGENT_URI] <COMMAND>

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
  -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.

note

The information collected by the supportability tool is solely used for debugging purposes. The content of these files is human-readable and can be reviewed, deleted, or redacted as necessary to adhere to the organization's data protection/privacy commitments and security policies before transmitting the bundles.

Does the supportability tool expose sensitive data?#

The supportability tool generates support bundles, which are used for debugging purposes. These bundles are created in response to the user's invocation of the tool and can be transmitted only by the user. Below is the information collected by the supportability tool that might be identified as 'sensitive' based on the organization's data protection/privacy commitments and security policies.

Logs: The default installation includes the deployment of a log aggregation subsystem based on Grafana Loki. All the pods deployed in the same namespace as OpenEBS and labelled with openebs.io/logging=true will have their logs incorporated within this centralized collector. These logs may include the following information:

Kubernetes (K8s) node hostnames
IP addresses
- container addresses
API endpoints
- Mayastor
- K8s
Container names
K8s Persistent Volume names
DiskPool names
Block device details (except the content)
K8s Definition Files: The support bundle includes definition files for all the OpenEBS components. Some of these are listed below:
Deployments
DaemonSets
StatefulSets
VolumeSnapshotClass
VolumeSnapshotContent

K8s Events: The archive files generated by the supportability tool contain information on all the events of the Kubernetes cluster present in the same namespace as OpenEBS.

etcd Dump: The default installation deploys an etcd instance for its exclusive use. This key-value pair is used to persist state information. It is required for diagnostic and troubleshooting purposes. The etcd dump archive file consists of the following information:

Kubernetes node hostnames
IP addresses
PVC/PV names
Container names
- Openebs
- User applications within the namespace where OpenEBS is installed
Block device details (except data content)

info

The list provided above is frequently reviewed and updated by the OpenEBS maintainers. However, it might not be fully exhaustive, given that "sensitive information" is a subjective term.