Rate This Document
Findability
Accuracy
Completeness
Readability

Directory Description

You can specify the directory for storing the HAF installation package. This document uses the omm user and the cgroup subdirectory omm_haf as an example. During the installation, select /home/omm/haf-software as the directory for storing the software installation package and /home/omm/haf-install as the software installation directory. After HAF is installed on the host node, the haf-host directory is generated in /home/omm/haf-install. After the HAF service is installed on the offload node, the haf-target directory is generated in /home/omm/haf-install. After the HAF library is installed on the offload node, the haf-offload directory is generated in /home/omm/haf-install.

The HAF installation package contains three software packages: haf-host, haf-target, and haf-tool. After HAF is installed on the host node, all related files are stored in /home/omm/haf-install/haf-host. After the HAF service is installed on the offload node, all related files are stored in /home/omm/haf-install/haf-target. After the HAF library is installed on the offload node, all related files are stored in /home/omm/haf-install/haf-offload. The haf-tool software package is used to run maintenance commands.

Table 1 describes the installation packages and their installation directories.

The /home/omm/haf-software directory created by the user is used only for running the installation package and related installation scripts. The /home/omm/haf-install/haf-host, /home/omm/haf-install/haf-target, and /home/omm/haf-install/haf-offload directories are used for service running.

Table 1 Directories after the installation

Installation Node

Directory Category

Directory Name

Description

All nodes (host node + offload node)

Directory for storing software packages

/home/omm/haf-software

Stores BoostKit-haf_1.3.0.zip. The haf-1.3.0.tar.gz package extracted from BoostKit-haf_1.3.0.zip contains the software package, tool script package, and installation configuration file required for HAF installation, for example, haf-host-1.3.0.tar.gz, haf-target-1.3.0.tar.gz, and haf-tool-1.3.0.tar.gz.

NOTE:

Scripts for deployment and installation are contained in haf-tool-1.3.0.tar.gz. Decompress haf-tool-1.3.0.tar.gz before installation. The decompressed files and lists are as follows:

  • bin: binary files for inner signature verification.
  • tools: haf-tool and related scripts.
  • install-config: path for storing the configuration file during installation.
  • haf_installer: installation program.
  • haf_uninstaller: uninstallation program.
  • haf_upgrade: upgrade program.

Host node

Installation directory of HAF on the host node

/home/omm/haf-install/haf-host/bin

Stores the binary file of the software on the host node, for example, kmc_tool_bin.

/home/omm/haf-install/haf-host/lib

Stores dynamic libraries and JAR packages of the host node, for example, libcrypto.so, libhaf_common.so, libhaf_link_host.so, libhaf_offload_host.so, libkmc.so, libkmc_tool.so, liblog.so, libsdp.so, libsecurec.so, libssl.so, and jar/haf-1.3.0.jar.

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

Stores the management tool and scripts of the host node, for example, haf-tool, scripts, and haf_uninstaller.

To view the haf-tool version, run the following command:

haf-tool --version

/home/omm/haf-install/haf-host/logs

Default directory for storing host node logs.

/home/omm/haf-install/haf-host/env.sh

Stores the script for setting environment variables of the host node.

/home/omm/haf-install/haf-host/etc

Configuration files of the host node.

The configuration file of the default offload user: haf_user.conf.

The log configuration files are LogAuditCfg.json and LogServiceCfg.json.

/home/omm/haf-install/haf-host/conf-bak

Default backup path of the host node configuration file.

/home/omm/haf-install/haf-host/cert

Path for storing the certificate and key of the host node.

Offload node

Installation directory of the HAF service on the offload node

/home/omm/haf-install/haf-target/bin

Stores the binary file of the software on the offload node: for example, haf_daemon, haf_executor, kmc_tool_bin, and verification.

NOTE:

To view the version information about HAF components, run the following commands:

LD_LIBRARY_PATH=../lib:$JAVA_HOME/jre/lib/aarch64/server/:$LD_LIBRARY_PATH ./haf_daemon --version

LD_LIBRARY_PATH=../lib:$JAVA_HOME/jre/lib/aarch64/server/:$LD_LIBRARY_PATH ./haf_executor --version

$JAVA_HOME indicates the Java installation directory.

/home/omm/haf-install/haf-target/lib

Stores dynamic libraries and JAR packages of the offload node, for example, libcrypto.so, libffi.so, libhaf_common.so, libhaf_link_target.so, libhaf_offload_device.so, libhostJNI_device.so, libkmc.so, libkmc_tool.so, liblog.so, libsdp.so, libsecurec.so, libssl.so, and jar/haf-1.3.0.jar.

/home/omm/haf-install/haf-target/etc

Stores the crontab task configuration file, runtime configuration file, and application information file of the offload node, for example, crontab.job, haf_offload.conf, and haf_executor_list.info.

/home/omm/haf-install/haf-target/run

Stores the working directory required for starting HAF.

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

Stores the management tool and script of the offload node, for example, haf-tool, scripts, haf_uninstaller, and haf_upgrade.

/home/omm/haf-install/haf-target/logs

Default directory for storing daemon and executor logs of the offload node.

/home/omm/haf-install/haf-target/cert

Path for storing the certificate and key of the offload node.

/home/omm/haf-install/haf-target/conf-bak

Default backup path of the offload node configuration file.

Offload node

Installation directory of the HAF library on the offload node

/home/omm/haf-install/haf-offload/bin

Stores the software binary file of the offload node, for example, kmc_tool_bin.

/home/omm/haf-install/haf-offload/lib

Stores dynamic libraries and JAR packages of the offload node, for example, libcrypto.so, libffi.so, libhaf_common.so, libhaf_link_target.so, libhaf_offload_device.so, libhostJNI_device.so, libkmc.so, libkmc_tool.so, liblog.so, libsdp.so, libsecurec.so, libssl.so, and jar/haf-1.3.0.jar.

/home/omm/haf-install/haf-offload/etc

Stores the configuration file and log configuration file of the library service on the offload node.

The configuration file is haf_offload.conf.

The log configuration files are LogAuditCfg.json and LogServiceCfg.json.

/home/omm/haf-install/haf-offload/tools

Stores the management tool and script of the offload node, for example, haf-tool, scripts, and haf_uninstaller.

/home/omm/haf-install/haf-offload/logs

Default log directory for using the library on the offload node.

/home/omm/haf-install/haf-offload/cert

Path of storing the certificate and key for using the library on the offload node.

/home/omm/haf-install/haf-offload/conf-bak

Default backup path of the configuration file for using the library on the offload node.

/home/omm/haf-install/haf-offload/env.sh

Stores the script for setting environment variables of the offload node.

Planning Installation Nodes

  • During the deployment, you need to plan a root CA server for issuing authentication certificates to HAF host and offload nodes. If there is only one node, perform all operations on the node.
  • When issuing certificates by using the root CA server, ensure that the time on each node is synchronized. Otherwise, the certificate verification fails due to the system time difference. You can configure NTP for synchronization.
Table 2 Installation node planning

Node

Installing HAF

Whether to Generate a Certificate

Function

host1

Yes

Yes

Host node for HAF offload.

target1

Yes

Yes

Offload node for running the remote service. The root certificate server (planned by yourself) is used to issue certificates.