foreman/man/foreman-debug.8.asciidoc @ develop
| 72142f5d | Lukas Zapletal | foreman\-debug(8)
|
|
=================
|
|||
:man source: foreman-debug
|
|||
:man manual: Foreman Manual
|
|||
NAME
|
|||
----
|
|||
foreman-debug - Foreman configuration and log collector
|
|||
SYNOPSIS
|
|||
--------
|
|||
foreman-debug [OPTIONS]
|
|||
| 45f8b472 | Dominic Cleal | foreman-debug -d /output/dir -a -v
|
|
| 72142f5d | Lukas Zapletal | ||
foreman-debug -h
|
|||
DESCRIPTION
|
|||
-----------
|
|||
Collects configuration and log data for Foreman, Smart Proxies, backend
|
|||
services and system information while removing security information like
|
|||
passwords, tokens and keys.
|
|||
This program can be used on Foreman instances, Smart Proxy instances or
|
|||
backend services separately.
|
|||
SENDING INFORMATION
|
|||
-------------------
|
|||
Use the *foreman-debug* tool to generate a tarball with your configuration and
|
|||
recent logs and send it to developers for further investigation. Note that
|
|||
passwords and tokens are filtered out, but the tarball still can contain
|
|||
*sensitive information*. For this reason it is recommended to send directly to
|
|||
the developers, and not publicly on the mailing list for production instances.
|
|||
OPTIONS
|
|||
-------
|
|||
The following options are available:
|
|||
-d DIR Directory to place the tarball in (default /tmp/foreman-XYZ)
|
|||
-g Skip generic info (CPU, memory, firewall etc.)
|
|||
-a Do not generate a tarball from the resulting directory
|
|||
| 45f8b472 | Dominic Cleal | -s SIZE Maximum log set size in MB (current and rotated files, default 10 MB)
|
|
| 72142f5d | Lukas Zapletal | -j PRG Filter with provided program when creating a tarball
|
|
-p Additionally print all passwords which are being filtered
|
|||
-q Quiet mode
|
|||
-v Verbose mode
|
|||
| 3d92620b | Lukas Zapletal | -u Upload tarball
|
|
| 72142f5d | Lukas Zapletal | -h Shows this message
|
|
| 3d92620b | Lukas Zapletal | CONFIGURATION
|
|
-------------
|
|||
Additional configuration can be provided via configuration file that must be
|
|||
stored as /etc/foreman/foreman-debug.conf. The file has shell syntax and the
|
|||
| 4500ddd4 | Dominic Cleal | following environment variables can be defined:
|
|
| 3d92620b | Lukas Zapletal | ||
- DIR: Directory to place the tarball in (string)
|
|||
- NOGENERIC: Skip generic info (0 or 1)
|
|||
- NOTAR: Do not create tarballs (0 or 1)
|
|||
| 45f8b472 | Dominic Cleal | - MAXSIZE: Maximum log set size in bytes (integer)
|
|
| 3d92620b | Lukas Zapletal | - COMPRESS: Compress program to pipe the tarball through (string)
|
|
| 4500ddd4 | Dominic Cleal | - PRINTPASS: Print passwords which are filtered out to stdout (0 or 1)
|
|
| 3d92620b | Lukas Zapletal | - QUIET: Quiet mode (0 or 1)
|
|
- VERBOSE: Verbose mode (0 or 1)
|
|||
- DEBUG: Debug mode (0 or 1)
|
|||
| 4500ddd4 | Dominic Cleal | - UPLOAD: Upload tarball after each run (0 or 1)
|
|
| 3d92620b | Lukas Zapletal | - UPLOAD_DISABLED: Permanently disable upload feature (0 or 1)
|
|
| 4500ddd4 | Dominic Cleal | - FILTER_WORDS: Tokens that are filtered out (shell array)
|
|
| 3d92620b | Lukas Zapletal | ||
| 4500ddd4 | Dominic Cleal | Most of the configured options are default values and can be overridden by
|
|
| 3d92620b | Lukas Zapletal | command line options, others are unique and can only be set via the
|
|
| 4500ddd4 | Dominic Cleal | configuration file.
|
|
| 72142f5d | Lukas Zapletal | ||
SEE ALSO
|
|||
--------
|
|||
*foreman-rake*(8)
|
|||
GETTING HELP
|
|||
------------
|
|||
For support, please see http://theforeman.org/support.html, the
|
|||
| 3256e139 | Amit Upadhye | foreman-users@googlegroups.com mailing list or #theforeman on Libera.Chat.
|