Gateway Hub

Validate environment


You can validate your environment before installing Gateway Hub using the hubcheck script.

The hubcheck script can be downloaded separately from the ITRS group website. This tool is updated regularly, so using the latest available version is recommended.


The hubcheck tool requires the following dependencies are installed:

Requirement Versions Supported
Python 3.6 or newer
PyYAML 5.3.1 or newer

A full list of requirements for performing installation can be found in hubcheck/requirements.txt and installed by running pip3 install --user --requirement requirements.txt.

Gateway Hub Installation checker

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

The hubcheck tool 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.
--help Prints a help message to standard out.
--version Prints the version to standard out.

Perform an installation check

To validate your installation environment:

  1. Download the hubcheck script from ITRS Downloads .
  2. Run the following:
    ./hubcheck <config_file>.yaml

    The hubcheck script will record the results to a new YAML 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.yaml

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.