Documentation
Rate This Document
Findability
Accuracy
Completeness
Readability
SubmitClose

Installation Commands

Implementation of HAF Installation

The haf_installer script is provided to install HAF. The haf_installer script invokes the haf-tool CLI to complete the installation.

External Installation Interfaces in the Script

  • Host node:

    cd /home/omm/haf-software

    ./haf_installer -m <mode> -p <package> -t <target_dir> -s <communication_port>
    • Replace the /home/omm/haf-software directory based on your requirements.
    • The -p option specifies the software package to be installed on the host node. A certificate is generated based on the haf_host_install.conf file. The haf_host_install.conf file is in the install-config folder in the same directory as the haf_installer script.
  • HAF service on the offload node:

    cd /home/omm/haf-software

    ./haf_installer -m <mode> -p <package> -t <target_dir> -w <ip_white_list> -j <java_home> -i <service_ip_duration> -c <cgroup_dir> -s <communication_port>

  • HAF library on the offload node:

    cd /home/omm/haf-software

    ./haf_installer -m <mode> -p <package> -t <target_dir> -w <ip_white_list> -j <java_home> -i <service_ip_duration> -s <communication_port>

Table 1 describes each option of the command:
Table 1 Options in the haf_installer command

Option

Description

Mandatory for Host Node

Mandatory for Service on Offload Node

Mandatory for Library on Offload Node

-m <mode>
  • host: installation on the host node.
  • offload: service installation on the offload node.
  • lib: library installation on the offload node.

Yes

Yes

Yes

-p <package>

Installation package, for example, haf-target-1.3.0.tar.gz.

Yes

Yes

Yes

-t <target_dir>

Root directory for installing the software package.

Yes

Yes

Yes

-w <ip_white_list>

IP address trustlist. The value can be an IP address or IP address segment. Use commas (,) to separate multiple IP addresses. Example: 127.0.0.1,10.10.0.2,10.10.10.0/24. This parameter is left empty by default.

NOTE:

The trustlist is used to verify the IP addresses of host nodes. Connections that are not in the trustlist will be rejected. If IP address trustlist verification is enabled but the trustlist is not configured, an offload node rejects connection requests from all host nodes.

No

Yes

Yes

-j <java_home>

Java installation path on the node.

  • If this option is left blank, it is automatically parsed based on system environment variables during installation.
  • Set this option if you want to use a customized path.
  • If the system default path is used, you can ignore this option.

No

Yes

Yes

-i <service_ip_duration>

Listening IP address segment of the offload node. Use commas (,) to separate multiple IP address segments. The format is 10.10.0.0/24. The default value is the value configured in the haf_target_install.conf file.

NOTE:

The default listening IP address segment differs greatly from the onsite running network segment. You are advised to configure the listening IP address segment based on site requirements.

No

Yes

Yes

-c <cgroup_dir>

cgroup subdirectory created in Prerequisites for Deployment. In the example, the value is omm_haf. Replace it with the actual cgroup subdirectory name.

No

Yes

No

-s <communication_port>

Communication port of the HAF service. The default port is 17531. The communication ports of the host node and the offload node must be the same.

Yes

Yes

Yes

External Installation Interfaces Provided by haf-tool

  • Host node:

    /home/omm/haf-install/haf-host/tools/haf-tool install

  • HAF service on the offload node:

    /home/omm/haf-install/haf-target/tools/haf-tool install

  • HAF library on the offload node:
    /home/omm/haf-install/haf-offload/tools/haf-tool install

    This interface is provided for the haf_installer script. You are advised not to call this interface separately.

Parent topic: Installing HAF