This content is associated with a legacy version of the Replicated product. For the current Replicated product documentation, see docs.replicated.com.
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.56.4"
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
Older Replicated Instances
The content in this document is specific to the current default Support Bundle in Replicated. If you are looking for information pertaining to previous releases of Replicated, it is available at https://help.replicated.com/native/packaging-an-application/support-bundle-v1/
In addition to the default support files included in the support bundle, additional files can be included by configuring a custom troubleshoot spec for the desired app channel. This custom troubleshoot spec will be included with the default replicated specs when a support bundle is generated.
Excluding Logs From Support Bundles
If a container’s logs may contain sensitive information or are simply large and not useful for your debugging processes, you can exclude that container’s logs from support bundles and disk persistance. To do this, add the label com.replicated.excludelogs=true to the container in question.
Default Support Files
By default the Support Bundle will include the following files in the primary folder:
| File | Description |
|---|---|
| /app/container-logs/logs/*.stdout.log.gz | Vendor application archival container stdout logs |
| /app/container-logs/logs/*.stderr.log.gz | Vendor application archival container stderr logs |
| /app/containers/*.json | Vendor application low-level container information. Result of the command docker inspect <container> |
| /app/custom/:component/commands/:filename.stdout | Custom support commands stdout as defined by the vendor application |
| /app/custom/:component/commands/:filename.stderr | Custom support commands stderr as defined by the vendor application |
| /app/custom/:component/:filename | Custom support files as defined by the vendor application |
| /app/logs/*.log | Vendor application container logs. Result of the command docker logs <container> |
| /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/loadavg | The system load average. A copy of the /proc/loadavg 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/containers/*.json | Replicated low-level container information. Result of the command docker inspect <container> |
| /replicated/etc/default/replicated | Replicated configuration file. A copy of the /etc/default/replicated file |
| /replicated/etc/default/replicated-operator | Replicated operator configuration file. A copy of the /etc/default/replicated-operator file |
| /replicated/etc/replicated.conf | Replicated configuration file. A copy of the /etc/replicated.conf file |
| /replicated/etc/sysconfig/replicated | Replicated configuration file. A copy of the /etc/sysconfig/replicated file |
| /replicated/etc/sysconfig/replicated-operator | Replicated operator configuration file. A copy of the /etc/sysconfig/replicated-operator file |
| /replicated/internal/app-config.json | Application configuration and values excluding passwords |
| /replicated/internal/app-releases.txt | Application releases list with installation time |
| /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/nodes.txt | A list of all nodes when running with the Replicated Native scheduler |
| /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) |
| /replicated/logs/*.stderr | Replicated container logs. Result of the command docker logs <container> |
| /replicated/logs/*.journald.log/logs.raw | Replicated journald logs when running with the systemd init system. Result of the command journalctl -u <unit> -r |
| /replicated/var/lib/replicated-operator/replicated-operator.conf | Replicated operator configuration file. A copy of the /var/lib/replicated-operator/replicated-operator.conf file |
| /replicated/var/log/upstart/*.log | Replicated upstart logs when running with the upstart init system |
| /retraced/containers/*.json | Retraced low-level container information. Result of the command docker inspect <container> |
| /retraced/logs/*.log | Audit Log container logs. Result of the command docker logs <container> |
| /VERSION.json | Support-bundle command version information |
The primary folder will also include any custom support bundle commands specified via Replicated Console, if that has been enabled for this license via vendor web.
Support Bundle will also include a folder for each instance of Replicated Operator that is running, with the name being the private IP of the instance. It will contain the following files:
| File | Description |
|---|---|
| /app/container-logs/logs/*.stdout.log.gz | Vendor application archival container stdout logs |
| /app/container-logs/logs/*.stderr.log.gz | Vendor application archival container stderr logs |
| /app/containers/*.json | Vendor application low-level container information. Result of the command docker inspect <container> |
| /app/logs/*.log | Vendor application container logs. Result of the command docker logs <container> |
| /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/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/docker_info.json | Display system-wide information |
| /default/docker/docker_version.json | Docker version output |
| /default/docker/container_ls.json | List all containers. Result of the command docker ps -a |
| /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/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/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/loadavg | The system load average. A copy of the /proc/loadavg 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/containers/*.json | Replicated low-level container information. Result of the command docker inspect <container> |
| /replicated/etc/default/replicated | Replicated configuration file. A copy of the /etc/default/replicated file |
| /replicated/etc/default/replicated-operator | Replicated operator configuration file. A copy of the /etc/default/replicated-operator file |
| /replicated/etc/replicated.conf | Replicated configuration file. A copy of the /etc/replicated.conf file |
| /replicated/etc/sysconfig/replicated | Replicated configuration file. A copy of the /etc/sysconfig/replicated file |
| /replicated/etc/sysconfig/replicated-operator | Replicated operator configuration file. A copy of the /etc/sysconfig/replicated-operator file |
| /replicated/logs/*.stderr | Replicated container logs. Result of the command docker logs <container> |
| /replicated/logs/*.journald.log/logs.raw | Replicated journald logs when running with the systemd init system. Result of the command journalctl -u <unit> -r |
| /replicated/var/lib/replicated-operator/replicated-operator.conf | Replicated operator configuration file. A copy of the /var/lib/replicated-operator/replicated-operator.conf file |
| /replicated/var/log/upstart/*.log | Replicated upstart logs when running with the upstart init system |
| /replicated-operator/internal/goroutines.txt | Replicated Operator thread dump |
| /replicated-operator/internal/params.json | Replicated Operator runtime configuration |
| /retraced/containers/*.json | Audit Log low-level container information. Result of the command docker inspect <container> |
| /retraced/logs/*.log | Audit Log container logs. Result of the command docker logs <container> |
| /VERSION.json | Support-bundle command version information |