Gateway Hub

Validate environment

Overview

You can validate your environment before installing Gateway Hub using the hubcheck script. This script is located in the hub/hubcheck directory of the Gateway Hub download.

The hubcheck script can be downloaded separately from the ITRS group website.

Gateway Hub Installation checker

The hubcheck script will read your installation JSON file and use Ansible to verify that your environment fulfils the perquisites necessary to perform the installation using the configuration you have specified.

The hubcheck script must be run from the installation machine, although this may also be a node. For more information about using nodes as installation machines, see Install.

The script has the following command-line options:

Option Description
--local Perform the checks on only the local environment.
--only <check> Perform a specific check only.
--verbose Provide verbose output.
--output <path> Define the path to the output file.

Perform an installation check

To validate your installation environment:

  1. Download the hubcheck script from ITRS Downloads .
  2. Move the hubcheck files into the same directory as your installation JSON.
  3. Run the following:
    ./hubcheck installation.json

    The hubcheck script will record the results to a new JSON file named /output/hubcheck-<version>-<timestamp>/results/<hostname>.json and to standard out.

Caution: You must resolve any failed checks with HIGH severity. Otherwise the installation will fail.

Perform individual checks

You can perform a specific check by running the hubcheck script with the --only command-line option:

./hubcheck --only <check> installation.json

Running in local mode

If you are performing a local installation of Gateway Hub, run the hubcheck script using the --local command-line option. If this option is enabled, the hubcheck script will not attempt to connect to other nodes using SSH and will check only the local machine's environment. For more information about performing local installations, see Install Gateway Hub locally in Install.