Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 3.69 KB

OneFS isi_gather_info Overview.md

File metadata and controls

74 lines (53 loc) · 3.69 KB

OneFS isi_gather_info Overview

The OneFS isi_gather_info utility is a key tool for collecting and collating context and configuration to aid in the identification and resolution of bugs and issues in cluster environments. If you are createing a service request for dell they will probally ask for this.

Its primary functions include:

  • Executing various commands, scripts, and utilities on the cluster.
  • Gathering results into a single ‘gzipped’ package.
  • Transmitting the package back to Dell using several optional transport methods.

Default Behavior and Transport Mechanisms

By default, the utility saves a log gather tarfile to /ifs/data/Isilon_Support/pkg/. The following transport mechanisms are available for uploading to Dell:

  • ESRS: Dell EMC Secure Remote Support (ESRS) for upload (TCP Port: 443/8443).
  • FTP: Standard FTP upload (TCP Port: 21).
  • HTTP: HTTP upload (TCP Port: 80/443).

CLI Command Syntax and Options

The isi_gather_info CLI command includes several options:

  • --upload <boolean>: Enable gather upload.
  • --esrs <boolean>: Use ESRS for gather upload.
  • --gather-mode (incremental | full): Type of gather.
  • --http-insecure-upload <boolean>: Enable insecure HTTP upload.
  • --http-upload-host <string>: HTTP Host for HTTP upload.
  • --http-upload-path <string>: Path on HTTP server for upload.
  • --http-upload-proxy <string>: Proxy server for HTTP upload.
  • --http-upload-proxy-port <integer>: Proxy server port for HTTP upload.
  • --clear-http-upload-proxy-port: Clear proxy server port for HTTP upload.
  • --ftp-upload <boolean>: Enable FTP upload.
  • --ftp-upload-host <string>: FTP host for upload.
  • --ftp-upload-path <string>: Path on FTP server for upload.
  • --ftp-upload-proxy <string>: Proxy server for FTP upload.
  • --ftp-upload-proxy-port <integer>: Proxy server port for FTP upload.
  • --clear-ftp-upload-proxy-port: Clear proxy server port for FTP upload.
  • --ftp-upload-user <string>: FTP user for upload.
  • --ftp-upload-ssl-cert <string>: SSL certificate for FTPS connection.
  • --ftp-upload-insecure <boolean>: Attempt plain text FTP upload.
  • --ftp-upload-pass <string>: FTP upload password.
  • --set-ftp-upload-pass: Specify FTP upload password interactively.

System Components

The primary components of the utility are:

  • Overlord: Manages isi_gather_info tasks on a single node.
  • Minion: Worker process running specified commands on a node.

Gather Process Workflow

The gather process includes an eight-phase workflow:

  1. Setup: Reads arguments and config files, sets up the config dictionary.
  2. Run Local: Executes cluster commands on the starting node.
  3. Run Nodes: Executes node commands across the cluster’s nodes.
  4. Collect: Collects all results on the overlord node.
  5. Generate Extra Files: Generates nodes_info and package_info.xml.
  6. Packing: Packs results into a tarfile.
  7. Upload: Transports the tarfile package to its destination.
  8. Cleanup: Cleans up intermediary files created on the cluster.

Running the Gather Process

During the gather process, the minion returns nothing to the overlord, as output is written to disk. The details of the completed gather, such as tarfile location, are displayed in the CLI session. Errors, if any, are also shown in the CLI.

Output of Gather

The gather results in a tar’d and zipped logset, typically containing CLI command outputs, logs, sysctl output, and other relevant data. The structure of the tarfile includes directories for each node and various log and information files.

Note: The isi_gather_info tool runs as root (or compadmin in compliance mode) due to its requirements to operate under degraded conditions.