Documentation
Rate This Document
Findability
Accuracy
Completeness
Readability
SubmitClose

Installing HAF

For details about how to use SmartKit, see SmartKit Operations.

Implementation of HAF Installation

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

External Installation Interfaces in the Script

  • Compute node:
    cd /home/omm/omnidata-software
./haf_installer -m <mode> -p <package> -t <target_dir> -s <communication_port>
    The -p option specifies the software package to be installed on the compute 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.

    Replace the /home/omm/omnidata-software directory with the actual one.

  • Offload node:
    cd /home/omm/omnidata-software
./haf_installer -m <mode> -p <package> -t <target_dir> -w <ip_white_list> -j <java_home> -i <service_ip_duration> -s <communication_port>
An offload node involves three more options than a compute node. Table 1 describes the options.
Table 1 Options in the haf_installer command

Option

Description

Compute Node

Offload Node

-m <mode>

Indicates whether the installation is performed on a compute node or an offload node. Possible values are host and /lib.

√

√

-p <package>

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

√

√

-t <target_dir>

Root directory for installing the software package.

√

√

-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 compute nodes. Connections that are not in the trustlist will be rejected. If IP address trustlist verification is enabled but the trustlist is not configured, the offload nodes reject connection requests from all compute nodes.

×

√

-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 custom path.
  • You can ignore this option to use the default path.

×

√

-i <service_ip_duration>

Listening IP address segment of the offload node. 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 your requirements.

×

√

-s <communication_port>

Communication port of the HAF service. The default port is 17531. The compute and offload nodes must have the same communication port.

√

√

External Installation Interfaces Provided by haf-tool

  • Compute node:
    /home/omm/omnidata-install/haf-host/tools/haf-tool install
  • Offload node:
    /home/omm/omnidata-install/haf-target/tools/haf-tool install

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

Transferring the HAF Installation Package

  1. Distribute the HAF program package to the offload and compute nodes. Select all nodes and configure a service flow.
  2. Use the file transfer function to copy the HAF software package prepared in Obtaining Software to all offload and compute nodes.
    Table 2 Task 1 parameters

    Parameter

    Description

    Task Name

    Transferring the HAF package

    Task Description

    Copying the HAF installation package to all nodes

    Transfer Direction

    From Local to Remote

    Local Path

    Directory where the local installation package is stored

    Remote Path

    /home/omm/omnidata-software
    • You can modify the remote path in Table 2 based on your requirements.
    • If the /home/omm/omnidata-software directory does not exist in the cluster, create one in advance. You can select all nodes in SmartKit and run the mkdir -p /home/omm/omnidata-software command in the run directory to execute the service flow.
  3. Use the command execution function to decompress the copied HAF software package and the script tool package in the software package.
    Table 3 Task 2 parameters

    Parameter

    Description

    Task Name

    Decompressing the HAF package

    Task Description

    Decompressing the HAF and haf-tool packages

    Run Directory

    /home/omm/omnidata-software

    Run Command

    unzip BoostKit-haf_1.3.0.zip; tar -zxvf haf-1.3.0.tar.gz; tar -zxvf haf-tool-1.3.0.tar.gz

    Whether to Check Return Code

    Yes

    Expected Return Code

    0
  4. Export the service flow and save it to your local PC. You can import service flows to quickly install other components.
  5. Execute the service flow. The procedure is complete when the execution is successful.

Installing HAF on Offload Nodes

  1. Install the HAF software package on the offload nodes (ceph1, ceph2, and ceph3). Select ceph1, ceph2, and ceph3 and configure the offload nodes.
  2. Use the command execution function to modify the installation configuration file.

    The certificate verification period is used as an example. The default period is 7 days. To change the period to 6 days, run the following commands:

    cd /home/omm/omnidata-software
sed -i 's/\"cert_check_period_time\": 7/\"cert_check_period_time\": 6/g' install-config/haf_target_install.conf
    • Skip this step if the default configuration file haf_target_install.conf in Configuration Items for HAF Deployment meets your service requirements.
    • When installing HAF on an offload node, you can modify the haf_target_install.conf file to modify the installation configuration in a batch. For details about configuration items that can be modified, see Configuration Items for HAF Deployment.
    • You are advised to use the configuration file to modify the items that cannot be modified by haf-tool.
    • To modify other items, you can run related commands as required. The preceding example is for reference only.
    • To modify multiple items, you can configure multiple commands in Run Command and separate them with semicolons (;).
    • Run the following command to change the certificate verification period:
      sed -i 's/\"cert_check_period_time\": 7/\"cert_check_period_time\": 6/g' install-config/haf_target_install.conf
    Table 4 Parameter description

    Parameter

    Description

    Task Name

    Changing the certificate verification period

    Task Description

    Changing the certificate verification period

    Run Directory

    /home/omm/omnidata-software

    Run Command

    sed -i 's/\"cert_check_period_time\": 7/\"cert_check_period_time\": 6/g' install-config/haf_target_install.conf

    Whether to Check Return Code

    Yes

    Expected Return Code

    0
  3. Use the command execution function to install HAF on offload nodes.
    Table 5 Parameter description

    Parameter

    Description

    Task Name

    Installing the HAF package on offload nodes

    Task Description

    Installing the HAF package on offload nodes and generating the key for initialization

    Run Directory

    /home/omm/omnidata-software

    Run Command

    ./haf_installer -m lib -p /home/omm/omnidata-software/haf-offload-1.3.0.tar.gz -i listen_ip_duration -w ip_white_list -j java_home -t /home/omm/omnidata-install -s communication_port

    NOTE:
    • The script parameters are described as follows:
      • -m lib: installing HAF on the offload node. This parameter is mandatory.
      • -p /home/omm/omnidata-software/haf-target-1.3.0.tar.gz: path of the HAF installation package for the offload node. This parameter is mandatory.
      • -i listen_ip_duration: listening IP address segment of the offload node (format: 10.10.0.1/24). During the installation, HAF matches and binds the IP address of the offload node. This parameter is optional.
      • -w ip_white_list: IP address trustlist. The value can be an IP address or IP address segment. Use commas (,) to separate multiple values, for example, 127.0.0.1,10.10.0.2,10.10.10.0/24. This parameter is optional.
      • -j java_home: Java installation path on the node. You can ignore this parameter to use the default path.
      • -t install_dir: root directory for installing the software package on the offload node. This parameter is mandatory.
      • -s communication_port: service listening port. The default value is 17531. This parameter is optional and can be configured using haf-tool. The value must be the same as that of the compute node.
      • If IP address trustlist verification is not required, the trustlist can be left blank, but you need to disable the function. For details, see Disabling the IP Address Trustlist Function.
    • SmartKit commands do not support long character strings. If the IP address trustlist is long, you need to manually run the IP address trustlist update command in the system. For details, see Updating the IP Address Trustlist or Listening IP Address Segment.

    Whether to Check Return Code

    Yes

    Expected Return Code

    0
  4. Execute the service flow.

Installing HAF on Compute Nodes

  1. Configure a service flow for the compute nodes (server1, agent1, agent2, agent3) to install the software package on the compute nodes.
  2. Use the command execution function to modify the installation configuration file.

    The certificate verification period is used as an example. The default period is 7 days. To change the period to 6 days, run the following commands:

    cd /home/omm/omnidata-software
sed -i 's/\"cert_check_period_time\": 7/\"cert_check_period_time\": 6/g' install-config/haf_host_install.conf
    • Skip this step if the default configuration file haf_host_install.conf in Configuration Items for HAF Deployment meets your service requirements.
    • When installing the HAF software on a compute node, you can modify the haf_host_install.conf file to modify the installation configuration of nodes in a batch. For details about configuration items that can be modified, see Configuration Items for HAF Deployment.
    • You are advised to use the configuration file to modify the items that cannot be modified by haf-tool.
    • To modify other items, you can run related commands as required. The preceding example is for reference only.
    Table 6 Task 1 parameters

    Parameter

    Description

    Task Name

    Changing the certificate verification period

    Task Description

    Changing the certificate verification period

    Run Directory

    /home/omm/omnidata-software

    Run Command

    sed -i 's/\"cert_check_period_time\": 7/\"cert_check_period_time\": 6/g' install-config/haf_host_install.conf

    Whether to Check Return Code

    Yes

    Expected Return Code

    0
  3. Use the command execution function to install HAF on compute nodes.
    Table 7 Task 1 parameters

    Parameter

    Description

    Task Name

    Installing the HAF package on compute nodes

    Task Description

    Installing the HAF package on compute nodes and generating the key for initialization

    Run Directory

    /home/omm/omnidata-software

    Run Command

    ./haf_installer -m host -p /home/omm/omnidata-software/haf-host-1.3.0.tar.gz -t /home/omm/omnidata-install -s communication_port

    NOTE:

    The script parameters are described as follows:

    • -m host: installing HAF on the compute node. This parameter is mandatory.
    • -p /home/omm/omnidata-software/haf-host-1.3.0.tar.gz: path of the HAF installation package for the compute node. This parameter is mandatory.
    • -t /home/omm/omnidata-install: HAF installation directory on the compute node. This parameter is mandatory.
    • -s communication_port: service listening port. The default value is 17531. This parameter is optional and can be configured using haf-tool. The value must be the same as that of the offload node.

    Whether to Check Return Code

    Yes

    Expected Return Code

    0
  4. Execute the service flow. Click Finish in the lower right corner and then click Run Service to execute the service flow.