Versions Compared

Old Version 13

changes.mady.by.user Aaron Enfield

Saved on

compared with

New Version Current

changes.mady.by.user Bala Harish A(AC)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse
Note

Unnecessary with SCS

Caution

When using SCS, the Storage Setting Checker tool is unnecessary if running on SCSnot required. It is not useful ineffective with any Swarm version above v14.

Table of Contents
maxLevel2

Swarm Storage version 10 and higher are supported by a configuration checker, which is bundled with the support tools downloaded from the Support site. The report establishes the current configuration across the cluster and surfaces any setting issues (such as deprecations and new requirements) that need to be addressed. (v10.0)

To evaluate all active settings for the Swarm cluster, the checker requires both types of configuration settings:

  • Dynamic — : The persisted settings stream (PSS object) for the cluster, which is updated in real-time by the Swarm UI or SNMP.

  • Static — : The configuration file(s) used at node startup.

Infotip

Best practicePractice

Before troubleshooting Storage or starting an upgrade (versus a point update, such as from 11.0.1 to 11.0.3), download and run the latest settings checker and verify the results with Support. 

...

For non‑CSN sites, run the settings checker as a standalone Python 3 script.

...

Note

Follow this process if Python 3 is not available:

  1. On a RHEL/CentOS 6/7 server, download and unpack the support tools: How to collect a support bundle

  2. Run the following from the support tools directory and collect the outputs:
    swarmctl -P -d [Swarm node IP] -p "admin:[admin password]" -x
    hwinfo-dmesg-grab.sh -m [Swarm node IP]

  3. Collect all node configuration files. Several may exist if a custom PXE server is used.

  4. Zip together all configurations and script outputs above and upload to the Support Uploader as described below.

  1. Download the latest support bundle: swarm-support-tools.tgz on the Support site

  2. Check whether Python 3 is installed: 

    Code Block
    python --version

    Install it now if it is not.

  3. Unpack the support tools.

  4. Run the following Python script with the needed options: 

    Code Block
    languagepy
    python3 settings_checker.py [options]

    See Script Options below.

  5. The script outputs a text file that does not need to be compressed. Use scp to secure copy the file to a location with internet access.

  6. Create a new ticket for the configuration review on the Support site and note the ticket number (such as 210621-000063).

  7. Upload the file with the Support Uploader. 

  8. Enter the ticket number when prompted; the file is attached to the ticket.

  9. Support is notified of the upload and works on any configuration issues

...

  • CSN environments - None of these options are required if the /var/opt/caringo/netboot/content/cluster.cfg file has the correct admin and SNMP r/w passwords.

  • Non‑CSN environments - Options (user, settings) are required to enable locating and loading of the dynamic settings (PSS).

Info

Typical

usage

Usage,

non

Non-CSN

  • Locate the settings config file —  - Add ‑f FILE (for one or more file paths).

  • Locate the PSS (persisted settings stream) — - Add -a [storage node ip] and -w [admin password].

  • Add ‑c to see the output on the console.

Options

Rules

Scope

Notes

-h, --help



Show program help and exit.

Code Block
-v, --version



Show program's version number and exit.

Code Block
-o OUTPUT



The pathname of the output file, which opens in append mode. Defaults to timestamped output in the current working directory: 
./swarm_settings_$HOSTNAME_v$TOOLVERSION_$TIMESTAMP.out

Code Block
-c, --console



Disabled by default. Print to the console, as well as the output file.

-m



Display more output.

Code Block
-w PASSWORD

Do not use with ‑u

CSN

The password of the cluster admin, used to retrieve the cluster's PSS (persisted settings stream).

The password is read from the cluster.cfg file if not specified.

Code Block
-u USERNAME_PASSWORD

Do not use with ‑w

Non‑CSN

The username:password of the cluster admin, which is needed to read the PSS.

The username is read from the node.cfg file if not specified.

Code Block
-p PATH, --path=PATH

Do not use with ‑f

Non‑CSN

The script defaults to legacy CSN configuration locations if not specified. 

-g SUFFIX

Only use with ‑p

Non‑CSN

Optionally, specifies the file type, if other than '.cfg'.

-f FILE [FILE ...],
--file FILE [FILE ...]

Do not use with ‑p

Non‑CSN

The location of the configuration file (or files separated by a space), or the path to all configuration files. Defaults to file type '.cfg'

Code Block
-s SETTINGS

use ‑a if not known

Non‑CSN

The host/UUID of the PSS for the cluster if known, in URI form: http://HOST/UUID. 

Code Block
-a ADDRESS

Only provide if requested

Non‑CSN

The IP of a node in the cluster, to help obtain the PSS. 

-r PSSFILE


Non‑CSN

The location of a PSS file.

...