Support Bundle

Installed instances can generate a support bundle with relevant logs and instance information.

A support bundle is an archive that is available for the customer to download via the Support tab of the On-Prem Console or the Replicated CLI.

Contents of the support page can be customized by including markdown in the top-level of the YAML.

replicated_api_version: "2.30.2"
name: ELK
console_support_markdown: |
  # Email Us for help:
  #### [email protected]
  Or don't, your loss.

The support bundle has a default timeout of 120 seconds, after which only files and commands that have completed will be included in the downloaded bundle. A custom timeout in seconds can be specified in the support section of the yaml.

support:
  timeout: 300

Custom Files and Commands

Custom support bundle files and commands can be included by setting a default troubleshoot spec in Replicated Console. The support bundle task definitions can be found here.

Excluding Logs From Support Bundles

If a pod’s logs may contain sensitive information or are simply large and not useful for your debugging processes, you can exclude that pod’s logs from support bundles. To do this, add the label com.replicated.excludelogs=true to the pod in question.

Default Support Files

By default the Support Bundle will include the following files:

File Description
/default/commands/date/stdout Print the system date and time. Result of the command date
/default/commands/df/stdout Report file system disk space usage for the local file systems. Result of the command df -al
/default/commands/df_inodes/stdout Report file system inode usage for the local file systems. Result of the command df -ali
/default/commands/dmesg/stdout Print the kernel ring buffer. Result of the command dmesg
/default/commands/free/stdout Display amount of free and used memory in the system. Result of the command free -m
/default/commands/hostname/stdout Show the system’s host name. Result of the command hostname
/default/commands/ip_addr_show/stdout Show protocol (IP or IPv6) addresses on a device. Result of the command ip -o addr show
/default/commands/ip_link_show/stdout Show network devices. Result of the command ip -o link show
/default/commands/ip_route_show/stdout Show routing table entries. Result of the command ip -o route show
/default/commands/loadavg/stdout Show system load average. Result of the command loadavg
/default/commands/ps/stdout Report a snapshot of the current processes. Result of the command ps fauxwww
/default/commands/uptime/uptime Tell how long the system has been running. Result of the command uptime
/default/docker/container_ls.json List all containers. Result of the command docker ps -a
/default/docker/docker_info.json Display system-wide information
/default/docker/docker_version.json Docker version output
/default/docker/image_ls.json List all images. Result of the command docker images
/default/etc/centos-release Operating system identification data for centos distributions. A copy of the /etc/centos-release file.
/default/etc/default/docker Upstart docker configuration. A copy of the /etc/default/docker file
/default/etc/fstab The system’s filesystems table. A copy of the /etc/fstab file
/default/etc/hostname The system’s host name. A copy of the /etc/hostname file
/default/etc/hosts Static table lookup for hostnames. A copy of the /etc/hosts file
/default/etc/os-release Operating system identification data. A copy of the /etc/os-release file.
/default/etc/sysconfig/docker Systemd docker configuration. A copy of the /etc/sysconfig/docker file
/default/etc/system-release Operating system identification data. A copy of the /etc/system-release file
/default/etc/systemd/system/docker.service.d/http-proxy.conf Systemd docker proxy configuration. A copy of the /etc/systemd/system/docker.service.d/http-proxy.conf file
/default/etc/timezone The system’s timezone. A copy of the /etc/timezone file
/default/journald/docker/logs.raw The Docker Journald logs
/default/os-release/os-release Operating system identification data. A copy of the /etc/os-release file.
/default/proc/cpuinfo Information about the processor, such as its type, make, model, and performance. A copy of the /proc/cpuinfo file
/default/proc/meminfo Information about memory usage, both physical and swap. A copy of the /proc/meminfo file
/default/proc/mounts Mounted filesystems. A copy of the /proc/mounts file
/default/proc/uptime The time the system has been up. A copy of the /proc/uptime file
/default/proc/version The kernel version. A copy of the /proc/version file
/default/proc/vmstat Detailed virtual memory statistics from the kernel. A copy of the /proc/vmstat file
/default/var/log/upstart/docker.log Docker upstart logs when running with the upstart init system
/replicated/internal/audit_events.csv Replicated audit log events dump
/replicated/internal/config-commands.txt Replicated config command results
/replicated/internal/daemon.json Replicated daemon information
/replicated/internal/goroutines.txt Replicated thread dump
/replicated/internal/host-info.json Replicated cluster host info
/replicated/internal/ledis-app.dump Replicated main database dump
/replicated/internal/ledis-registry.dump Replicated registry database dump
/replicated/internal/ledis-snapshots.dump Replicated snapshots database dump
/replicated/internal/license.txt Replicated license information
/replicated/internal/params.json Replicated runtime configuration
/replicated/internal/replicated-versions.txt Replicated version information
/replicated/internal/tasks.txt Replicated current tasks (queued, executing, or sleeping)
/scheduler/kubernetes/api_versions.json Kubernetes API versions
/scheduler/kubernetes/cluster_info.json Kubernetes cluster info
/scheduler/kubernetes/server_version.json Kubernetes server version
/scheduler/kubernetes/heptio-contour/logs/<pod>-<container>/<pod>.log Heptio contour container logs
/scheduler/kubernetes/heptio-contour/resources/*/resource.json Heptio contour resource info
/scheduler/kubernetes/kube-system/logs/<pod>-<container>/<pod>.log Kubernetes system container logs
/scheduler/kubernetes/kube-system/resources/*/resource.json Kubernetes system resource info
/scheduler/kubernetes/logs/<pod>-<container>/<pod>.log App container logs
/scheduler/kubernetes/replicated/<replicated_pod>-replicated/<replicated_pod>.log Replicated container logs
/scheduler/kubernetes/replicated/<replicated_pod>-replicated-ui/<replicated_pod>.log Replicated UI container logs
/scheduler/kubernetes/resources/*/resource.json Kubernetes resource info in the app namespace
/scheduler/kubernetes/rook-ceph/logs/<pod>-<container>/<pod>.log Rook/Ceph container logs
/scheduler/kubernetes/rook-ceph/resources/*/resource.json Rook/Ceph resource info
/scheduler/kubernetes/rook-ceph-system/logs/<pod>-<container>/<pod>.log Rook/Ceph system container logs
/scheduler/kubernetes/rook-ceph-system/resources/*/resource.json Rook/Ceph system resource info
/VERSION.json Support-bundle command version information