Using a MustGather script to collect deployment information and logs from a FileNet Content Manager or an IBM Content Foundation container installation

Steps

About the MustGather Script

The MustGather script (mustgather.py) runs in interactive mode or silent mode. When the script is run, it gathers various diagnostics. The script detects the type of deployment and the components based on your FNCM Custom Resource (CR). Once the diagnostics are gathered, the data is compressed and sent to the client machine to a subfolder of where the command was run from.

To be able to collect all information the script, requires confirmation that sensitive deployment information, such as secrets and configuration files, can be gathered. The sensitive deployment information contains credentials and networking information pertaining to the deployment. If you choose not to allow the sensitive information to be gathered, the MustGather script only collects information generated by the operator, such as deployment yamls and component logs.

By default, the MustGather script collects all deployment artifacts and FNCM Operator information. Specific component information can be collected. The deployed components are detected based on information in the FNCM Custom Resource (CR). You can also choose to limit which components are analyzed.

Installation Steps:

1. Clone the script from GitHub:

   git clone https://github.com/ibm-ecm/ibm-fncm-containers.git

2. Open a terminal or command prompt and navigate to the directory where the Github Repository was extracted. This location differs based on the version of FNCM Standalone:
   
   5.6.0 and later:

   cd ibm-fncm-containers/scripts

   
   5.5.8, 5.5.11, and 5.5.12:

   cd ibm-fncm-containers/scripts/prerequisites

3. Run the following command to install the required Python packages from the requirements.txt file:

   python3 -m pip install -r requirements.txt

Procedure for running the MustGather script

python3 mustgather.py --help

Usage: mustgather.py [OPTIONS]

 FileNet Content Manager MustGather CLI

Options:
  --version                      Show version and exit. 
  --help                         Show this message and exit.

Customization and Utils:
  --silent     --no-silent       Enable Silent Install (no prompts). [default: no-silent]
  --verbose    --no-verbose      Enable verbose logging. [default: no-verbose]
  --dryrun     --no-dryrun       Perform a dry run [default: no-dryrun]

The MustGather script requires the following information: 

• Namespace
• Consent to collect sensitive data
• FNCM components on which the script must be run
   

Interactive Mode: 

Use the following statement to invoke the script in interactive mode:
 

python3 mustgather.py

Silent Mode: 

To use silent mode,

1. Complete the configuration file provided in the cloned Github Repository:  ./silent_config/silent_install_mustgather.toml.
2. Invoke the script.

python3 mustgather.py --silent